ReportTemplateTagCollection

The collection of window names and report tags that will be included in the report.

Example

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

    -- Only generate the report if Microsoft Word is installed
    
if ( app.MSWordInstalled ) then

    -- Add a Word 2007 report template to the POSTFEKO session
    
    reportTemplate = app.Reports:Add(
    FEKO_HOME..[[/shared/Resources/Automation/StartupModel.dotx]], 
    pf.Enums.ReportDocumentTypeEnum.MSWord)    

    -- Extract the tags from the template document and get a list of the open windows in the 
    -- current session
    
    reportTemplate.TagSettings[1].Window = "startup1"
    reportTemplate.TagSettings[2].Window = "Cartesian graph1"

    -- Generate the report
    
    reportTemplate:Generate([[temp_StartupModelReport.docx]])
end

Usage locations

The ReportTemplateTagCollection object can be accessed from the following locations:

Property List

Count
The number of ReportTemplateTagSettings items in the collection. (Read only number)

Method List

Item (index number)
Returns the ReportTemplateTagSettings at the given index. (Returns a ReportTemplateTagSettings object.)
Modify (tagwindownames Map of string:string)
Specifies the window that should be included in the report at the specified tag. The list of window titles can be retrieved with Windows.

Index List

[number]
Returns the ReportTemplateTagSettings at the given index in the collection. (Read ReportTemplateTagSettings)

Property Details

Count
The number of ReportTemplateTagSettings items in the collection.
Type
number
Access
Read only

Method Details

Item (index number)
Returns the ReportTemplateTagSettings at the given index.
Input Parameters
index(number)
The index of the ReportTemplateTagSettings.
Return
ReportTemplateTagSettings
The ReportTemplateTagSettings at the given index.
Modify (tagwindownames Map of string:string)
Specifies the window that should be included in the report at the specified tag. The list of window titles can be retrieved with Windows.
Input Parameters
tagwindownames(Map of string:string)
A map where the keys are tag names extracted from the template file and the values being the title of the window which will be exported to the specified tag.