2022 April Release

Customization Point FSCPDFGEN@1.1001:TOCElementConfiguration Permanent link for this heading

This customization point defines the compound elements and their depending objects that should be displayed in the table of contents of the PDF overview. The customization point is evaluated in the use case "View as PDF" when the document definition TOCDocumentDefinition is configured for the target object of the use case.

Example:
customize TOCElementConfiguration<Folder> {
  tocecincludeexpr = expression {
    // Use only objects that are in the same room as the current root
    return tocecroot.GetObjectTeamRoom() == cooobj.GetObjectTeamRoom();
  }
  tocecchildattrdefs = {
    objchildren
  }
}
customize PDFOverviewConfiguration<Folder> {
  pdfovconcernedexpr = expression {
    return [this, GetObjectList(, GetChildrenAttrDef(), , true)];
  }
  pdfovdocdef = TOCDocumentDefinition;
}

void FSCPDFGEN@1.1001:TOCElementConfiguration(
  key ObjectClass tocecclass,
  Object tocecroot,
  out boolean tocecincludeexpr,
  out direct object[] tocecchildattrdefs)

Name

Description

tocecclass

applies to objects of the defined object class

tocecroot

container object for which the table of contents should is generated; this parameter is normally used to display the root element in separate ways when it occurs in the table of contents multiple times
Note: Reference the software component FSCCONV@1.1001 in your Fabasoft app.ducx project for this customization point together with FSCPDFGEN@1.1001.

tocecincludeexpr

defines an expression to check if the current object should be included in the PDF overview
Note: This parameter is only evaluated for the root entry when it is found for the first time in the table of contents. To include the root element itself and not only its children, the expression must return true.

tocecchildattrdefs

defines the properties where the depending objects are located

Additional Information