Template Object Properties

Template Object Properties

Please refer to the following table for detailed description of Objects and their properties for use with Template Tags.

I. Objects

Project	Description
CTRL	Control Object
PROJ	Project Object
DB	Database Object
TABLE	Table Object
FIELD	Field Object
LANG	Language Object

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

This line will write the project name in the output file.

CTRL Object

Property	Description	Data Type
CtrlId	ID (e.g. list, view, edit, etc.)	String

PROJ Object

Property	Description	Data Type
ProjName	Project 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
SecEmailFld	User Table Email Field	String
SecForgetPwdPage	Generate Forget Password Page	Boolean
SecChangePwdPage	Generate Change Password Page	Boolean
SecChangeEmail	Send Email for Change Password	Boolean
SecRegisterPage	Generate Registration Page	Boolean
SecRegisterEmail	Send Email for Registration	Boolean
SecSenderEmail	Sender Email Address	String
SmtpServer	Smtp Server Name	String
SmtpServerPort	Smtp Server Port	Integer
MemoCRLFReplace	Replace CRLF with BR for Memo Field	Boolean
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
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
XMLEncoding	XML Encoding	String
HighlightColor	Highlight Color	String
SelectColor	Select Color	String
ProgramStyle	Program Style	String
ProgramLanguage	Program Language	String
DotNetFrameworkVersion	DotNet Framework Version	String
PasswordFormat	Password Format	String
EditBackColor	Edit Row Background Color	String
PagerBackColor	Pager Background Color	String
SelectBackColor	Selected Row Background Color	String
FooterBackColor	Footer (Aggregated Values) Background Color	String
UploadPath	File Upload Path	String
UploadAllowedFileExt	Upload allowed file extensions	String
WebConfigGen	Generate web.config	Boolean
WebConfigOverwrite	Overwrite web.config	Boolean
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
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
ExportXml	Export to Xml	Boolean
ExportCsv	Export to Csv	Boolean
MultiDelete	Multiple Delete Record	Boolean
Sort Type	Sort Type 0 - No Sort 1 - Single Column Sort 2 - Multi-Column Sort	Integer
PagerStyle	Pager Style: 1 - Numeric Pages 2 - NextPrev	Integer
TopPageLink	Pager on Top	Boolean
LinkOnLeft	Links on Left	Boolean
InlineDelete	Inline Delete	Boolean
DetailViewPaging	DetailsView Paging	Boolean
AppRootFolder	Application Root Folder	String
RepeatColumns	Repeat Columns	Integer
RecipientEmail	Recipient Email	String
DeleteUploadedFile	Delete Uploaded File	Boolean
SMTPServerUsername	SMTP Server Username	String
SMTPServerPassword	SMTP Server Password	String
AuditTrailPath	Audit Trail Path	String

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
UseDynamicUserLevel	Use Dynamic User Level	Boolean
UserLevelTbl	User Level Table Name	String
UserLevelIdFld	User Level ID Field Name	String
UserLevelNameFld	User Level Name Field Name	String
UserLevelPrivTbl	User Privilege Table Name	String
UserLevelPrivTblNameFld	User Privilege Table Name Field Name	String
UserLevelPrivUserLevelFld	User Privilege User Level Field Name	String
UserLevelPrivPrivFld	User Privilege User Privilege Field Name	String
SecuParentUserIDFld	Parent User ID Field Name	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
TblView	Table Allow View	Boolean
TblInlineEdit	Table Allow Inline Edit	Boolean
TblEdit	Table Allow Edit	Boolean
TblAdd	Table Allow Add	Boolean
TblDelete	Table Allow Delete	Boolean
TblCaption	Table Caption	String
TblVar	Table Variable Name	String
TblSrchType	Table Search Type: "NONE" - None "BASIC" - Basic Search "ADVANCED" - Advanced Search "BOTH" - Both Basic & Advanced Search	String
TblDefault	Table link from default page	Boolean
TblCopy	Table Allow Copy	Boolean
TblFilter	Table Filter	String
TblUserIDFld	Table User ID Field for Advanced Security	String
TblSecurity	Table Security Settings for Advanced Security	String
TblMasterTbl	Master Table Name (Master/Detail)	String
TblMasterFld	Master Table Link Field (Master/Detail)	String
TblDetailFld	Detail Table Link Field (Master/Detail)	String
TblBlob	Table has Blob Field	Boolean
TblOverwrite	Overwrite Table Scripts	Boolean
TblLoaded	Table is Loaded	Boolean
TblRptShowDetails	Show Report Details (Report Only)	Boolean
TblRptShowGrandTotal	Show Report Grand Total (Report Only)	Boolean
TblCustomSQL	Table Custom SQL (Custom View)	String
TblCustomError	Error loading Custom View / Report	String
TblRptSrc	Report Source Table (Report Only)	Boolean
TblRptIndent	Report Indentation by pixel (Report Only)	Integer
TblUseGlobal	Use Global Settings (List Page)	Boolean
TblRecPerPage	Records Per Page (List Page)	Integer
TblRecPerPageList	Comma Delimited Values for Dynamic Paging (List Page)	String
TblExportHtml	Export to Html (List Page)	Boolean
TblExportWord	Export to Word (List Page)	Boolean
TblExportExcel	Export to Excel (List Page)	Boolean
TblExportXml	Export to Xml (List Page)	Boolean
TblExportCsv	Export to Csv (List Page)	Boolean
TblMultiDelete	Multiple Delete Record	Boolean
TblSort Type	Sort Type 0 - No Sort 1 - Single Column Sort 2 - Multi-Column Sort	Integer
TblPagerStyle	Pager Style: 1 - Numeric Pages 2 - NextPrev	Integer
TblTopPageLink	Pager on Top	Boolean
TblLinkOnLeft	Links on Left	Boolean
TblInlineDelete	Inline Delete	Boolean
TblDetailViewPaging	DetailsView Paging	Boolean
TblAuditTrail	Audit Trail	Boolean
TblSendMailOnAdd	Send Email on Add	Boolean
TblSendMailOnEdit	Send Email on Edit	Boolean
TblSendMailOnDelete	Send Email on Delete	Boolean

FIELD Object

Property	Description	Data Type
FldSeq	Field ordering sequence	Integer
FldName	Field Name	String
FldAlias	Field Alias Name	String
FldSourceName	Field Source Name	String
FldSourceTable	Field Source Table Name	String
FldSourceField	Field Source Field Name	String
FldType	Field Data Type	Integer
FldSupport	Field data type is supported	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
FldIsPrimaryKey	Field is Primary Key	Boolean
FldAutoIncrement	Field is Auto Increment	Boolean
FldAttribute	Field ADO Attributes	Long
FldMin	JS Validation - Mininum Value	Variant
FldMax	JS Validation - Maximum Value	Variant
FldErrMsg	JS Validation - Error Message	String
FldValidate	JS Validation - Validate format	String
FldRequired	JS Validation - Required Field	Boolean
FldPopCalendar	Generate Popup Calendar	Boolean
FldGenerate	Field Allow Generate	Boolean
FldList	Field Allow List	Boolean
FldView	Field Allow View	Boolean
FldEdit	Field Allow Edit	Boolean
FldAdd	Field Allow Add	Boolean
FldSearch	Field Allow Search	Boolean
FldBasicSearch	Field Allow Basic Search	Boolean
FldExtendedBasicSearch	Field Allow Extended Basic Search	Boolean
FldRegister	Field for Registration Page	Boolean
FldSrchOpr	Field Search Operator	String
FldSrchOpr2	Field Search Operator 2	String
FldDefault	Field Default Value	Variant
FldCaption	Field Caption	String
FldVar	Field Variable	String
FldViewTag	Field View Tag	String
FldHtmlTag	Field Html Tag	String
FldHtmlTagReadOnly	Field Html Tag as ReadOnly	Boolean
FldTagSize	Field Tag Size	Integer
FldTagMaxLength	Field Tag Maximum Length	Long
FldTagHiddenValue	Field Tag Hidden Value	String
FldSelectType	Field Select Type (Table/Values)	String
FldTagValues	Field Value List	String
FldTagLnkTbl	Field Link to Table Name	String
FldTagLnkFld	Field Link to Table Key	String
FldTagLnkDisplay	Field Link to Table Display Field	String
FldTagLnkDisp2	Field Link to Table Display Field 2	String
FldTagLnkOrderBy	Field Link to Table Order By Field	String
FldTagLnkOrderType	Field Link to Table Order Type (ASC/DESC)	String
FldTagLnkDistinct	Field Link to Table Distinct	Boolean
FldTagCols	Field Column Count (TEXTAREA)	Integer
FldTagRows	Field Row Count (TEXTAREA)	Integer
FldTagImgWidth	Image Width (IMG)	Integer
FldTagImgHeight	Image Height (IMG)	Integer
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
FileNameFld	File Name Field (for File Upload)	String
FileTypeFld	File Type Field (for File Upload)	String
FileSizeFld	File Size Field (for File Upload)	String
ImageWidthFld	Image Width Field (for File Upload)	String
ImageHeightFld	Image Height Field (for File Upload)	String
FldHrefFld	Field Hyperlink to field	String
FldStrFunc	Field String Function	String
FldUseDHTMLEditor	Use DHTML editor (for Memo field)	Boolean
FldMemoMaxLength	Memo Field Maximum Length (list page only)	Integer
FldSelectSize	Multiple Selection List Size	Integer
FldSelectMultiple	Field Allow Multiple Selection List	Boolean
FldSelectFilter	Field Select Filter	String
FldSelectFilterFld	Dynamic Combobox Filter Field	String
FldParentSelect	Dynamic Combobox Parent Field (aka First ComboBox)	String
FldSelectAllowAdd	Allow Add for Select Box (Ajax)	Boolean
FldQuoteS	Field Start Quote Character	String
FldQuoteE	Field End Quote Character	String
FldColumnWidth	List Page Field Column Width	String
FldColumnWrap	List Page Field Column Wrap	Boolean
FldAggregate	Field Aggregation Function	String
FldGroupBy	Field Grouping Sequence (Report Only)	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
FldRepeatColumns	Repeat columns	Integer
FldUploadPath	Relative Upload Path	String
FldCheckDuplicate	Check Duplicate	Boolean
FldPageIndex	Page Index (for multi-page add/edit)	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

This is equivalent to:

This line outputs the phrase "BackToList" as defined in the lang.xml. If the lang.xml file contain the node:

The line write "Back to List" to the output file.