Reports

Design, layout, and generate a report in PDF format containing data from the FactoryTalk Optix Application

BrowseName
Report
SuperType
Vertical layout(ColumnLayout)

Properties

Name BrowseName DataType Description
Page size PageSize Page size Document page size
Page orientation PageOrientation Page orientation Vertical or horizontal orientation of the layout
Page width PageWidth Size Width of the document page
Page height PageHeight Size Height of the document page
Width Size
Height Size
LeftMargin Size
RightMargin Size
TopMargin Size
BottomMargin Size
Visible Boolean
Enabled Boolean
Opacity Float
Rotation Size
Style sheet StyleSheet NodeId Color and style options to be used when parsing the PDF model
ContentAlignment Content vertical alignment
HorizontalAlignment Horizontal alignment
VerticalAlignment Vertical alignment
Page count PageCount String Print reference of the total number of pages in the report
Page number PageNumber String Print reference of the current page number
Print time PrintDateTime DateTime Print reference of the print date and time
MoveTarget NodeId
Header Header Report header, repeated on each page
Sections Sections Sections of the report, that is, Panel Section, Data Grid Section and Page Break objects
Footer Footer Report footer, repeated on each page
Wrap Wrap Boolean (Inherited from Vertical layout)
Horizontal gap HorizontalGap Size (Inherited from Vertical layout)
Vertical gap VerticalGap Size (Inherited from Vertical layout)

Methods

Generate PDF

BrowseName
GeneratePdf

Generates the report in PDF format and saves it in the file system

Table 1. InputArguments
Name DataType Description
OutputPath ResourceUri Location in the file system where the report PDF and relative filename is to be saved (for example, %APPLICATIONDIR%/MyReport.pdf)
LocaleId LocaleId Locale of the report used to localize translations, unit of measurement, formatting, etc. (for example, 'en-US')
Table 2. OutputArguments
Name DataType Description
OperationId Guid Result code of the PDF generation process

Events

PDF generated

BrowseName
PDF generated

The Generate PDF method of a Report object was run