Template Object Properties
Please refer to the following table for detailed description of Objects and their properties for use with Template Tags.
I. Objects
Note:
You can view the object properties by opening your Project File with a text editor. Project file is an XML file, each object is represented by an XML node in the project file. The object properties are saved as attributes of the node. The property name is same as the attribute name.
II. Properties
You can use the standard dot notation to access properties of the objects.
Example
<!--##=PROJ.ProjName##-->
This line will write the project name in the output file.
CTRL Object
| Property |
Description |
Data Type |
| CtrlId |
ID (e.g. list,
summary, crosstab, etc.) |
String |
PROJ Object
| Property |
Description |
Data Type |
| ProjName |
Project Name |
String |
| AppCompat |
Application in compatibility mode |
Boolean |
| AppHeader |
Compatibility mode masterpage file name |
String |
| AppLogin |
Compatibility mode login file name |
String |
| AppLogout |
Compatibility mode logout file name |
String |
| AppDefault |
Compatibility mode default file name |
String |
| AppCssFolder |
Css folder name (relative path) |
String |
| AppChartCssFile |
Chart Css file name |
String |
| CodePage |
Code Page |
Long |
| LCID |
Locale ID |
Long |
| Cache |
Allow Cache |
Boolean |
| CharSet |
Character Set |
String |
| OutputNameType |
Output File Name Type:
"" - None
"Prefix" - Prefix
"Suffix" - Suffix |
String |
| OutputNameExt |
Output File Name Prefix or Suffix |
String |
| OutputNameLCase |
Output File Name in lowercase |
Boolean |
| BodyTitle |
Body Title Description |
String |
| BodyFont |
Body Font |
String |
| BodySize |
Body Size |
String |
| BodyBgColor |
Body Background Color |
String |
| BodyTextColor |
Body Text Color |
String |
| BodyLnkColor |
Body Link Color |
String |
| BodyVLnkColor |
Body Vlink Color |
String |
| BodyALnkColor |
Body Alink Color |
String |
| BodyLeftMargin |
Body Left Margin |
Integer |
| BodyTopMargin |
Body Top Margin |
Integer |
| TblWidth |
Table Width |
String |
| TblPadding |
Table Padding |
Integer |
| TblBorder |
Table Border |
Integer |
| TblSpacing |
Table Spacing |
Integer |
| TblBgColor |
Table Background Color |
String |
| TblHdrFontColor |
Table Header Font Color |
String |
| TblHdrColor |
Table Header Background Color |
String |
| TblAltColor |
Table Use Alternate Row Color |
Boolean |
| TblAltColor1 |
Table Alternate Color 1 |
String |
| TblAltColor2 |
Table Alternate Color 2 |
String |
| Template |
Template File location |
String |
| Destination |
Output Destination Folder location |
String |
| SecType |
Security Type:
"None" - No Security
"Hard Code" - Use Hard Code ID/Pwd
"Use Table"
- Use Security Table
"Both" - Use Security Table &
Hard Code Administrator |
String |
| SecLoginID |
Administrator Login ID |
String |
| SecPasswd |
Administrator Password |
String |
| SecTbl |
User Table Name |
String |
| SecLoginIDFld |
User Table Login ID Field |
String |
| SecPasswdFld |
User Table Password Field |
String |
| MemoCRLFReplace |
Replace CRLF with BR for Memo Field |
Boolean |
| SessTimeOut |
Session Timeout time |
Integer |
| DefaultDateFormat |
Default Date Format:
0 - General Date (System)
1 - Long Date (System)
2 - Short Date (System)
3 - Long Time (System)
4 - Short Time (System)
5 - "yyyy/mm/dd"
6 - "mm/dd/yyyy"
7 - "dd/mm/yyyy" |
Integer |
| DateSeparator |
Date Separator: /, -, . |
String |
| RptColColor |
Report column color |
String |
| RptGrpColor1 |
Report group 1 color |
String |
| RptGrpColor2 |
Report group 2 color |
String |
| RptGrpColor3 |
Report group 3 color |
String |
| RptGrpColor4 |
Report group 4 color |
String |
| RptPageTotalColor |
Report page total color |
String |
| RptGrandTotalColor |
Report grand total color |
String |
| AutoSync |
Auto Synchronize when open project |
Boolean |
| CreateVDir |
Create Virtual Directory |
Boolean |
| AutoBrowse |
Browse after Generation |
Boolean |
| BodyStyle |
Body Style |
String |
| OtherGen |
Generate Other Scripts |
Boolean |
| OtherOverwrite |
Overwrite Other Scripts |
Boolean |
| PromptOnOverwrite |
Prompt on Overwrite |
Boolean |
| DynamicLoadDB |
Load Database Dynamically |
Boolean |
| OptionExplicit |
Option Explicit |
Boolean |
| RptIndent |
Report Indentation in Pixels (Report Page) |
Integer |
| RecPerPage |
Record Per Page (List Page) |
Integer |
| RecPerPageList |
Comma delimited values for Dynamic Page List (List
Page) |
String |
| ExportHtml |
Export to Html |
Boolean |
| ExportWord |
Export to Word |
Boolean |
| ExportExcel |
Export to Excel |
Boolean |
| PagerStyle |
Pager Style:
1 - Numeric Pages
2 - NextPrev |
Integer |
| TopPageLink |
Pager on Top |
Boolean |
| LinkOnLeft |
Links on Left |
Boolean |
| AppRootFolder |
Application root folder |
String |
| SessTimeOut |
Session Timeout time |
Integer |
| SessionMode |
Session Mode (Inproc/StateServer/SQLServer) |
String |
| StateConnectionString |
Session StateServer Connection String |
String |
| StateNetworkTimeout |
StateServer Session Timeout Time |
Integer |
| SQLConnectionString |
Session SQLServer Connection String |
String |
| SessionCookieless |
Session is Cookieless |
Boolean |
| RequestEncoding |
Request Encoding |
String |
| ResponseEncoding |
Response Encoding |
String |
| FileEncoding |
File Encoding |
String |
| TraceEnabled |
Trace Enabled |
Boolean |
| TraceRequestLimit |
Trace Request Limit |
Integer |
| TracePageOutput |
Trace Ouput at bottom of page |
Boolean |
| TraceMode |
Trace Mode (SortByTime / SortByCategory) |
String |
| TraceLocalOnly |
Trace shown on local clients only |
Boolean |
| DebugEnabled |
Debug Enabled |
Boolean |
| CustomErrors |
Custom Error Mode |
String |
| AuthenticateMode |
Authentication Mode |
String |
| IdentityImpersonate |
Impersonate |
Boolean |
| TestWebServer |
1 = Cassini, 2 = IIS |
Integer |
DB Object
| Property |
Description |
Data Type |
| DBName |
Database Name |
String |
| DBType |
Database Type |
String |
| DBPath |
Database Type |
String |
| DBUseServerMapPath |
Use Server MapPath
(For ASP or ASP.NET only, not available in PHPMaker, JSPMaker
and CFMMaker) |
Boolean |
| DBPhyPath |
Database Physical Path |
String |
| DBUID |
User ID |
String |
| DBPwd |
Password |
String |
| DBQuoteS |
Database Start Quote Character |
String |
| DBQuoteE |
Database End Quote Character |
String |
| DBConnstr |
DB Connection String |
String |
| DBADOVer |
ADO Version |
String |
| DBDBMSName |
DBMS Name |
String |
| DBDBMSVer |
DBMS Version |
String |
| DBOLEDBVer |
OleDb Version |
String |
| DBProviderName |
Provider Name |
String |
| DBProviderVer |
Provider Version |
String |
| DBSchema |
Schema Name |
String |
| MaxUploadSize |
Upload Field maximum upload size |
Integer |
| SecUserLevelFld |
User Level Field for Advanced Security |
String |
| SecDefault |
Default Security String |
String |
| SecuUserIDFld |
User ID Field for Advanced Security |
String |
| SecuParentUserIDFld |
Parent User ID Field for Advanced Security |
String |
TABLE Object
| Property |
Description |
Data Type |
| TblSeq |
Table ordering sequence |
Integer |
| TblName |
Table Name |
String |
| TblType |
Table Type (TABLE/VIEW/CUSTOMVIEW/REPORT) |
String |
| TblKey |
Table Key |
String |
| TblGen |
Table Generate |
Boolean |
| TblList |
Show Table in Menu |
Boolean |
| TblCaption |
Table Caption |
String |
| TblVar |
Table Variable Name |
String |
| TblDefault |
Table link from default page |
Boolean |
| TblFilter |
Table Filter |
String |
| TblUserIDFld |
Table User ID Field for Advanced Security |
String |
| TblSecurity |
Table Security Settings for Advanced Security |
String |
| TblOverwrite |
Overwrite Table Scripts |
Boolean |
| TblLoaded |
Table is Loaded |
Boolean |
| TblRptShowDetails |
Show report details |
Boolean |
| TblRptShowGrandTotal |
Show Report Grand Total (Report Only) |
Boolean |
| TblReportType |
Report Type
"list" - simple list
report
"summary" - summary report
"crosstab" - crosstab report
|
String |
| TblShowReport |
Show report |
Boolean |
| TblRptShowPageTotal |
Show report page total |
Boolean |
| TblRowSum |
Show report row sum (crosstab only) |
Boolean |
| TblCustomSQL |
Table Custom SQL (Custom View) |
String |
| TblCustomError |
Error loading Custom View / Report |
String |
| TblRptSrc |
Report Source Table |
Boolean |
| TblUseGlobal |
Use Global Settings |
Boolean |
| TblRecPerPage |
Groups/Records Per Page |
Integer |
| TblRecPerPageList |
Comma Delimited Values for Dynamic Paging |
String |
| TblExportHtml |
Export to Html |
Boolean |
| TblExportWord |
Export to Word |
Boolean |
| TblExportExcel |
Export to Excel |
Boolean |
| TblPagerStyle |
Pager Style:
1 - Numeric Pages
2 - NextPrev |
Integer |
| TblTopPageLink |
Pager on Top |
Boolean |
| TblLinkOnLeft |
Links on Left |
Boolean |
CHART Object
| Property |
Description |
Data Type |
| ChartSeq |
Chart ordering sequence |
Integer |
| ChartName |
Chart Name |
String |
| ChartVar |
Chart Variable Name |
String |
| ShowChart |
Show chart in report |
Boolean |
| ChartXFldName |
Chart X Axis field name |
String |
| ChartYFldName |
Chart Y Axis field name |
String |
| ChartType |
Chart Type:
1 - column chart
2 - bar chart
3 - line chart
4 - pie chart |
Integer |
| ChartWidth |
Chart Width (in pixel) |
Integer |
| ChartHeight |
Chart Height (in pixel) |
Integer |
| ChartBgColor |
Background Color |
String |
| ChartCaption |
Chart Caption |
String |
| ChartBorderLeftColor |
Chart Border Left Color |
String |
| ChartBorderTopColor |
Chart Border Top Color |
String |
| ChartBorderBottomColor |
Chart Border Bottom Color |
String |
| ChartBorderRightColor |
Chart Border Right Color |
String |
| ChartChartBgColor |
Chart Background Color |
String |
| ChartChartBorderColor |
Chart Border Color |
String |
| ChartNumGridLines |
Chart Number of Gridlines |
Integer |
| ChartGridColor |
Chart Gridline Color |
String |
| ChartXAxisName |
Chart X Axis Name |
String |
| ChartXAxisNameRotated |
Chart X Axis Name is Rotated |
Boolean |
| ChartXAxisValueMaxChar |
Chart X Axis Value Maximum Characters |
Integer |
| ChartXAxisValueRotation |
Chart X Axis Value Rotation (degree) |
Integer |
| ChartYAxisName |
Chart Y Axis Name |
String |
| ChartYAxisNameRotated |
Chart Y Axis Name is Rotated |
Boolean |
| ChartYAxisMinValue |
Chart Y Axis Minimum Value |
Long |
| ChartYAxisMaxValue |
Chart Y Axis Maximum Value |
Long |
| ChartShowNames |
Chart Show Names (X Axis Values) |
Boolean |
| ChartShowValues |
Chart Show Values (Y Axis Values) |
Boolean |
| ChartShowHover |
Chart Show Hover (X,Y Values on Chart) |
Boolean |
| ChartAlpha |
Chart Alpha (Transparency 0-100) |
Integer |
| ChartColorPalette |
Chart Color Palette (comma separted color codes) |
String |
| ChartUseGlobalCss |
Chart Use Global Css |
Boolean |
| ChartSortType |
Chart Sort Type:
0 - No Sort
1 - X ASC
2 - X DESC
3 - Y ASC
4 - Y DESC |
Integer |
| ChartPosition |
Chart Position:
1 - Top
2 - Left
3 - Right
4 - Bottom |
Integer |
FIELD Object
| Property |
Description |
Data Type |
| FldSeq |
Field ordering sequence |
Integer |
| FldName |
Field Name |
String |
| FldType |
Field Data Type |
Integer |
| FldSupport |
Field Supported by ASP.NET Report Maker |
Boolean |
| FldSize |
Field Size |
Integer |
| FldUniqueIdx |
Field has unique index |
Boolean |
| FldZeroLen |
Field support zero-length string
(For Access database only, not available in PHPMaker and JSPMaker) |
Boolean |
| FldReq |
Field Required |
Boolean |
| FldAutoIncrement |
Field is Auto Increment |
Boolean |
| FldAttribute |
Field ADO Attributes |
Long |
| FldGenerate |
Field Allow Generate |
Boolean |
| FldList |
Field Allow List |
Boolean |
| FldSearch |
Field Allow Search (Popup Filter) |
Boolean |
| FldCaption |
Field Caption |
String |
| FldVar |
Field Variable |
String |
| FldViewTag |
Field View Tag |
String |
| FldHtmlTag |
Field Html Tag |
String |
| FldTagAType |
Href Type |
String |
| FldTagATarget |
Href Target Type (A) |
String |
| FldTagAPrefix |
Href Prefix (A) |
String |
| FldTagASuffix |
Href Suffix (A) |
String |
| FldBold |
Field Bold |
Boolean |
| FldItalic |
Field Italic |
Boolean |
| FldAlign |
Field Alignment |
String |
| FldFmtType |
Field Format Type:
"Currency"
- format as currency
"Date/Time" - format as Date/Time
"Number" - format as number
"Percent" -
format as percent
"String" - format as string |
String |
| FldDtFormat |
Field Date Format:
See Project/DefaultDateFormat for details |
Integer |
| FldNumDigits |
Field number of digits after decimal |
Integer |
| FldIncLeadDigit |
Field include leading digit |
Integer |
| FldUseParen |
Field use parenthesis for negative |
Integer |
| FldGpDigits |
Field group digits |
Integer |
| FldHrefFld |
Field Hyperlink to field |
String |
| FldStrFunc |
Field String Function |
String |
| FldQuoteS |
Field Start Quote Character |
String |
| FldQuoteE |
Field End Quote Character |
String |
| FldColumnWidth |
Field Column Width |
String |
| FldColumnWrap |
Field Column Wrap |
Boolean |
| FldGroupByType |
Field Group By Type:
"n" - Normal
"y" - Year (Date Fields)
"q" - Quarter (Date Fields)
"m" - Month (Date Fields)
"w" - Week (Date Fields)
"d" - Day (Date Fields)
"h" - Hour (Date Fields)
"min" - Minute (Date Fields)
"i" - Interval (Numeric Fields)
"f" - First Few Characters (String Fields) |
String |
| FldGroupByInterval |
Field Group By Interval (valid for Group By Type
"i" & "f" only) |
Long |
| FldRowID |
Field Row Index (Crosstab Report Only) |
Integer |
| FldColumnID |
Field Column Index (Crosstab Report Only) |
Integer |
| FldColumnDateType |
Field Column Date Type: (Column Field is Date
Only)
"y" - Year
"q" - Quarter
"m" - Month
"d" - Date |
String |
| FldColumnDateSelect |
Field Column Date with Selectable Year |
Boolean |
| FldSummaryID |
Field Summary Index (Crosstab Report Only) |
Integer |
| FldSummaryType |
Field Summary Type:
"AVG" - Average
"COUNT" - Count
"MAX" - Maximum
"MIN" - Minimum
"SUM" - Sum |
String |
| FldFilterName |
Field Filter Name (Relative Filter Names, comma
separated) |
String |
| FldUseRange |
Field Use Range (Use Range Selection in Popup
Filter) |
Boolean |
| FldGroupBy |
Field Grouping Sequence |
Integer |
| FldGroupByShowSummary |
Field Grouping Show Summary (Report Only) |
Boolean |
| FldOrderBy |
Field Ordering Sequence |
Integer |
| FldOrder |
Field Order Type (ASC/DESC) |
String |
| FldRptAggSum |
Aggregate Sum of Field |
Boolean |
| FldRptAggAvg |
Aggregate Average of Field |
Boolean |
| FldRptAggMin |
Aggregate Minimum of Field |
Boolean |
| FldRptAggMax |
Aggregate Maximum of Field |
Boolean |
| FldMemoMaxLength |
Memo field max. length in list page |
Integer |
LANG Object
| Method |
Description |
Data Type |
| Phrase |
Method to retrieve a phrase in the language file |
String |
Note that this object is different from above objects. There is only one method, no properties. To get a language phrase, use the following syntax:
LANG.Phrase(phraseid)
Example
<!--##=LANG.Phrase("BackToFile")##-->
This is equivalent to:
<!--##@BackToList##-->
This line outputs the phrase "BackToList" as defined in the lang.xml. If the lang.xml file contain the node:
<phrase id="BackToList" value="Back to List"/>
The line write "Back to List" to the output file.
|
