CodeCharge Studio All ASP PHP Perl ColdFusion Java C#.NET VB.NET

Page Reference

Design-Time Properties

Property Description
Restricted Specify if the Group Access authorization is used.
Access Denied Page Page used for redirection in case of denied access.
Convert URL To Specify if the Access Denied URL should be converted to different format.
Includable Specify of the Page is included in other pages
SSL Access Only If the page is not accessed via SSL then the connection error occurs.

Events

Event Description
Server Side Events
After Initialize Occurs after all page components have been initialized, before processing submitted data or showing components. It can be used for defining code that should be executed before any other event code. It can be used on pages that don't contain any objects and are used only for processing data, without outputting the rendered template (e.g. for pages that should output binary data, like images or files). Another common application is conditional redirecting (using Redirect global variable).
On Initialize View Occurs after handling submitted data and before loading templates for page showing. A common application is changing template filename to use different page templates conditionally.
Before Show Occurs after the template object has been initialized with the template page contents and before showing (populating template with data) page components and controls. This event can be used for putting dynamic content into template variables (i.e. {var_name}, where var_name is the name of the variable).
Before Output Occurs after page template is rendered and before output content to the client.
Before Unload Occurs before disposing page’s components objects, after page output is completed. It can be used for defining code that should be executed just before the page execution is complete. Another application is closing additional database connections or freeing other custom resources.
Client Side Events
On Load Used for binding Validation rules to control, initializing any JavaScript functions. It is invoked when the page loading is completed by the browser. It can be used to initialize some DHTML components like menus or trees placed on page.
On Unload Invoked when the page is about to be closed, or the user navigates to another page. It can be used to detect unsubmitted changes or ask for page leaving confirmation.

Global variables (ASP)

Property Description
DB<connection name> For each connection used by page's components a global variable is created to hold connection's functionality. Variable name consists of constant DB prefix and variable suffix dependent on the name of the connection.
FileName This global variable holds the name of the page that is currently processed. This variable is useful to determine which page is currently being processed from within included page. This variable can be used to construct link on included pages too.
HTMLTemplate This variable holds template object that can be used to perform global operations on the page's template.
PathToCurrentPage This variable contains path from site's root directory to currently executed page's directory.
PathToRoot This variable holds relative path to access site's root directory from page's parent directory. It is usually composed of number of .. parent paths (depending on page's level).
Redirect This variable contains relative or absolute URL, or just page name to redirect. This redirection is made just before On Initialize View event, so it only makes sense to set variable's value in After Initialize event or some submit processing event in page sub components.
ScriptPath This variable contains absolute filesystem path to current page's directory.
TemplateFileName This variable contains name of the template file. This file is loaded to retrieve page and components rendering HTML blocks.
Tpl This variable holds a reference to root template block. It can be used to access template variables defined in HTML code.

Global variables (PHP)

Property Description
ComponentType Specifies type of an object, such as "TextBox", "Record", etc.
Parent Specifies parent container of an object, for example a record form for a textbox that is included within that form.
DB<connectionname> For each connection used by page's components a global variable is created to hold connection's functionality. Variable name consists of constant DB prefix and variable suffix dependent on the name of the connection.
FileName This global variable holds the name of the page that is currently processed. This variable is useful to determine which page is currently being processed from within included page. This variable can be used to construct link on included pages too.
PathToRoot This variable holds relative path to access site's root directory from page's parent directory. It is usually composed of number of .. parent paths (depending on page's level).
Redirect This variable contains relative or absolute URL, or just page name to redirect. This redirection is made just before On Initialize View event, so it only makes sense to set variable's value in After Initialize event or some submit processing event in page sub components.
TemplateFileName This variable contains name of the template file. This file is loaded to retrieve page and components rendering HTML blocks.
Tpl An object that contains CCS internal representation of the template HTML file used for the page's layout.

Global constants (PHP)

Property Description
RelativePath This constant contains path from site's root directory to currently executed page's directory.

Methods (Servlets & JSP)

MethodDescription
getComponent Find Component in children collection by name.
getGrid Find Grid in children collection by name.
getRecord Find Record in children collection by name.
getEditableGrid Find EditableGrid in children collection by name.
getDirectory Find Directory in children collection by name.
getPath Find Path in children collection by name.
getRedirectString Returns redirection URL string.
setRedirectString Specify URL string for redirect. This redirection is made just before On Initialize View event, so it only makes sense to set variable's value in After Initialize event or some submit processing event in page sub components.
getRequest Returns the current request associated with this page.
getResponse Returns the current response associated with this page.
getHttpGetParameters
getHttpGetParameter Returns the value of a request GET parameter as a String, or null if parameter does not exist.
getHttpPostParameters
getHttpPostParameter Returns the value of a request POST parameter as a String, or null if parameter does not exist.
getParameter Returns the value of a request parameter as a String, or null if parameter does not exist.
getFile Returns a UploadedFile object that present a uploaded file, or null if file does not uploaded.
getTemplate Returns the Template object for the direct usage of the template library or null for JSP.
isRestricted Whether users must be logged in before accessing the form.
setRestricted Specify whether users must be logged in before accessing the form.
getChild Specify a name to find a child control among the collection of children controls.
getChildren Return all children controls of a collection.
getControl Specify a name to find a Control among the collection of controls.
getFileUpload Specify a name to find a FileUpload control among the collection of children controls.
getButton Specify a name to find a Button control among the collection of children controls.
getListBox Specify a name to find a Listbox control among the collection of children controls.
getRadioButton Specify a name to find a Radiobutton control among the collection of children controls.
getCheckBoxList Specify a name to find a Checkbox List control among the collection of children controls.
getLink Specify a name to find a Link control among the collection of children controls.
getDatePicker Specify a name to find a Date Picker control among the collection of children controls.
isVisible Returns a value indicating whether this control should be displayed or not.
setVisible Specify whether this control or component should be shown.
getParent Get the parent component that contains this control or component.

Run-Time Variables (CF,CFT)

Property Description
DB_<connection name>_USER_NAME For each connection a request scope variable is created to hold connection's functionality.This variable contains username value specified in the connection
DB_<connectionname>_USER_PASSWORD For each connection a request scope variable is created to hold connection's functionality.This variable contains password value specified in the connection
DB_<connectionname>_DB_TYPE For each connection a request scope variable is created to hold connection's functionality.This variable contains database driver type value specified in the connection
DB_<connectionname>_DB_DS For each connection a request scope variable is created to hold connection's functionality.This variable contains name of the data source connection
strFileName This variable holds the name of the page that is currently processed. This variable is useful to determine which page is currently being processed from within included page. This variable can be used to construct link on included pages too.
PathToCurrentPage This variable contains path from site's root directory to currently executed page's directory.
PathToRoot This variable holds relative path to access site's root directory from page's parent directory.
strRedirect This variable contains relative or absolute URL, or just page name to redirect. This redirection is made just before On Initialize View event, so it only makes sense to set variable's value in After Initialize event or some submit processing event in page sub components.
strTemplateFileName (for CFT only) This variable contains name of the template file. This file is loaded to retrieve page and components rendering HTML blocks.


On-line, printable versions and updates