# QuickReport

A quick report document to generate.

## Example

app = pf.GetApplication()
app:NewProject()
app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.pfs]])

-- Create a PDF quick report (called exampleReport.pdf) and give it a heading

report = app:CreateQuickReport([[temp_exampleReport2]], pf.Enums.ReportDocumentTypeEnum.PDF)

-- Exclude the cartesian graph window

report:SetPageIncluded("Cartesian graph1", false)

-- Generate the document

report:GenerateAndOpen()


## Inheritance

The QuickReport object is derived from the ResultReport object.

## Property List

ImageFormat
The image format to use when exporting images for the template report. (Read/Write string)
ImageSize
Report image export size options. (Read only ReportImageSizeSetting)
PageOrientation
The page orientation of the report document, e.g. Portrait or Landscape. (Read/Write ReportOrientationEnum)
ReportPageOptions
Gives the list of windows that will be exported to the report. The order of the list is the page order in which they will be placed in the report. (Read only List of string)
Type
The object type string. (Read only string)

## Method List

Generate ()
Generates the quick report.
GenerateAndOpen ()
Generates and opens the quick report.
SetPageCaption (windowtitle string, caption string)
Specifies what the given window's page image caption should be in the report. The list of window titles can be retrieved with ReportPageOptions.
SetPageIncluded (windowtitle string, included boolean)
Specifies whether the given window should be included in the report. The list of window titles can be retrieved with ReportPageOptions.
SetPageTitle (windowtitle string, pagetitle string)
Specifies what the given window's page title should be in the report. The list of window titles can be retrieved with ReportPageOptions.

## Property Details

Type
string
Access
ImageFormat
The image format to use when exporting images for the template report.
Type
string
Access
ImageSize
Report image export size options.
Type
ReportImageSizeSetting
Access
PageOrientation
The page orientation of the report document, e.g. Portrait or Landscape.
Type
ReportOrientationEnum
Access
ReportPageOptions
Gives the list of windows that will be exported to the report. The order of the list is the page order in which they will be placed in the report.
Access
Type
The object type string.
Type
string
Access

## Method Details

Generate ()
Generates the quick report.
GenerateAndOpen ()
Generates and opens the quick report.
SetPageCaption (windowtitle string, caption string)
Specifies what the given window's page image caption should be in the report. The list of window titles can be retrieved with ReportPageOptions.
Input Parameters
windowtitle(string)
The title of the window which attributes needs to be modified.
caption(string)
The exported image caption.
SetPageIncluded (windowtitle string, included boolean)
Specifies whether the given window should be included in the report. The list of window titles can be retrieved with ReportPageOptions.
Input Parameters
windowtitle(string)
The title of the window which attributes needs to be modified.
included(boolean)
Specifies if the window should be included in the report.
SetPageTitle (windowtitle string, pagetitle string)
Specifies what the given window's page title should be in the report. The list of window titles can be retrieved with ReportPageOptions.
Input Parameters
windowtitle(string)
The title of the window which attributes needs to be modified.
pagetitle(string)
The title of the page.