TTMSFNCGanttChartPDFIO
The TTMSFNCGanttChartPDFIO is a component used to facilitate the export of TMS FNC Gantt Chart data into a PDF format.
This component offers a range of customizable options, allowing users to selectively export either the task list or the timeline, or both.
Additionally, it supports various customization features to tailor the appearance of the PDF, such as setting custom colors, fonts, and layout configurations.
This flexibility ensures that the exported PDF can meet specific user requirements and present the Gantt chart data in a clear and professional manner.
Properties
| Property name |
Description |
| GanttChart |
References the Gantt chart component that is to be exported. |
GanttChartPDFExportOptions |
Allows the user to specify various options for the PDF export specific to the Gantt Chart. These options can include settings for the layout, appearance, and content of the PDF file |
| Options |
The default options from the PDF library. (Based in TMS FNC Core.) |
Methods
| Method name |
Description |
| Save |
Save to a PDF-file. |
Events
| Event name |
Description |
| OnAfterDrawContent |
This event is triggered after the main content of the Gantt chart has been drawn onto the PDF. |
| OnAfterDrawFooter |
This event is called after the footer section of the PDF has been drawn. It can be used to add or modify any additional elements in the footer area post-rendering.. |
| OnAfterDrawHeader |
This event is invoked after the header section of the PDF has been drawn. It allows for post-processing or adding extra elements to the header area once it has been rendered.. |
| OnBeforeDrawContent |
This event occurs before the main content of the Gantt chart is drawn onto the PDF. It provides an opportunity to prepare or customize the content layout and elements before they are rendered.. |
| OnBeforeDrawFooter |
This event is triggered before the footer section of the PDF is drawn. It allows for any preparatory steps or customizations to be made to the footer area prior to rendering.. |
| OnBeforeDrawHeader |
This event is called before the header section of the PDF is drawn. It can be used to set up or modify the header elements and layout before the actual drawing process begins.. |
| OnGetFooter |
This event is used to customize the content of the footer. |
| OnGetHeader |
This event is used to customize the content of the header. (Similar to OnGetFooter.) |
TTMSFNCGanttChartExportOptions
Different options specifically for the Gantt Chart to configure the PDF export.
These options can include settings for the layout, appearance, and content of the PDF file, such as whether to include the task list, the timeline, or both, and customizations for colors, fonts, and other stylistic elements to ensure the exported PDF meets specific requirements.
Properties
| Property name |
Description |
| UseCustomTaskListAppearance |
This Boolean property determines whether a custom appearance is applied to the task list in the exported PDF. When set to True, the appearance specified in CustomTaskListAppearance is used. |
| UseCustomTimeLineAppearance |
This Boolean property indicates whether a custom appearance is applied to the timeline in the exported PDF. When set to True, the appearance specified in CustomTimeLineAppearance is utilized. |
| TaskListColumns |
This property of type TTMSFNCGanttTaskListColumns specifies which columns of the task list should be included in the exported PDF. It allows for selecting and organizing the columns to be exported. (If no columns are defined, the default columns of the Gantt Chart will be used.) |
| CustomTaskListAppearance |
This property of type TTMSFNCGanttChartExportTaskListAppearance defines the custom appearance settings for the task list. It includes details such as colors, fonts, and styles to be used when UseCustomTaskListAppearance is enabled. (By default a type of grayscale appearance is configured.) |
| CustomTimeLineAppearance |
This property of type TTMSFNCGanttChartExportTimeLineAppearance specifies the custom appearance settings for the timeline. It includes various styling options for the timeline when UseCustomTimeLineAppearance is set to True. (By default a type of grayscale appearance is configured.) |
| FitToPage |
This Boolean property determines whether the content should be scaled to fit within the page dimensions of the PDF. When set to True, the content is adjusted to ensure it is neatly divided on the page(s). Based on readability and minimum column widths. |
| RepeatHeaders |
This Boolean property controls whether the headers are repeated on each page of the PDF. When set to False, headers will only appear on the first page; when True, headers will appear on every page. |
| Mode |
This property of type TTMSFNCGanttChartExportMode specifies what portions of the Gantt chart to export. The default value emBoth indicates that both the task list and timeline are exported. |
| HeaderHeight |
This Integer property sets the height of the Gantt Chart header in the exported PDF. A value of -1 indicates that the default height in the Gantt Chart is used. |
| ItemHeight |
This Integer property specifies the height of each item (task) in the exported PDF. A value of -1 means the default item height configured in the Gantt Chart is used. |
| TimelineGroupHeight |
This Integer property sets the height of the groups within the timeline in the exported PDF. A default value of -1 indicates that the standard group height configured in the Gantt Chart is used. |
| TimelineUnitWidth |
This Integer property defines the width of each unit in the timeline. A value of -1 uses the default unit width configured in the Gantt Chart. |
| TaskListBorderDraw |
This property of type TTMSFNCGanttChartExportTaskListBorders determines how borders are drawn in the task list of the exported PDF. The default value ebCell specifies that borders are drawn around each cell. |