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

Path Reference

Design-Time Properties

Property Description
Name Name of the control.
Connection Select one of the project database connection names.
Data Source Type Specify the type of Data Source.
Data Source Specify the actual source of data for the list of values depending on the Source Type.
ID Field Specify the field containing the unique ID that identifies the categories.
Parent Field Specify the field with primary key values of the parent categories.

Events

Event Description
Server Side Events
Before Select This event occurs at the onset of the operations performed to select records from the database.
Before Show This event occurs before a component is rendered to the page.
Before Show Category This event occurs before each category in the Path is displayed.
Before Build Select This event occurs before the creation of the query that will be used to retrieve records from the database.
Before Execute Select This event occurs immediately before a row selection query is executed but after the query has been composed.
After Execute Select This event occurs after the row selection query has been executed and a recordset for the result is returned.

Run-Time Properties (ASP)

Property Description
DataSource  This property stores a reference to the data source bound to the component. The data source handles all data retrieval and update operations. It serves as an abstraction layer that hides underlying data source details, whether it is a database table, SQL query or stored procedure.
Errors  This property contains any error messages pertaining to the entire form as a whole.
Recordset  This property contains a recordset in which are all the records that will be shown in the form.
Visible  This property determines whether the component is to be shown or not.

Data Source properties

Property Description
DataSource.SQL  This property contains the main portion of the SQL query used to retrieve the records displayed within the component. In terms of SQL, this property defines the SELECT and FROM clauses of the SQL query.
DataSource.Where  This property contains the WHERE clause portion of the SQL query used to retrieve records for the component. The WHERE clause provides the criteria which filters the records retrieved. The value of this property is appended to the value of the DataSource.SQL property to create the final SQL query which is executed against the datasource to retrieve the records for the component.

Run-Time Properties (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.
DataSource This property stores a reference to the data source bound to the specified object. The data source handles all data retrieval and update operations. It serves as an abstraction layer that hides underlying data source details, whether it is a database table, SQL query or stored procedure.
Errors  This property keeps the reference to the objectís error collection. It is used to collect error messages generated during the objectís execution. 
Visible  This property determines whether the component is to be shown or not.

Data Source properties

Property Description
DataSource->SQL  This property contains the main portion of the SQL query used to retrieve the records displayed within the component. In terms of SQL, this property defines the SELECT and FROM clauses of the SQL query.
DataSource->Where  This property contains the WHERE clause portion of the SQL query used to retrieve records for the component. The WHERE clause provides the criteria which filters the records retrieved. The value of this property is appended to the value of the DataSource->SQL property to create the final SQL query which is executed against the datasource to retrieve the records for the component.

Run-Time Properties (.NET)

Interface

Property Description
DataSource  This property stores a reference to the data source bound to the component.
Visible  This property determines whether the component will be shown or not. 

Model Layer

Property Description
errors  This property keeps a reference to the objectís error collection. It is used to collect error messages generated during the objectís execution. 
<control name>  For each control that is located within a component, a member property is created with the same name as the control.  

Directory Data Provider

Property Description
<prefix><parameter name>  For each unique parameter of the Data Source command, a member property is created with the prefix (according to parameter source type) and parameter name (according to parameter source).

Methods (.NET)

Data Provider

Method Description
GetResultSet  Executes an SQL command and returns results in an Items array.

Run-Time Variables (CF,CFT)

Property Description
query<control name>  This variable contains the query object associated with the component.
strOrder  This variable contains the ORDER BY clause portion of the SQL query used to retrieve records for the control. The ORDER BY clause determines the order of appearance of the retrieved records. The value of this property is appended to the value of the strSQL variable to create the final SQL query which is executed against the datasource to retrieve the records for the control.
strSQL  This variable contains the main portion of the SQL query used to retrieve the records displayed within the component. In terms of SQL, this property defines the SELECT and FROM clauses of the SQL query.
strWhere  This variable contains the WHERE clause portion of the SQL query used to retrieve records for the component. The WHERE clause provides the criteria which filters the records retrieved. The value of this property is appended to the value of the strSQL variable to create the final SQL query which is executed against the datasource to retrieve the records for the component.
hide<control name>  This variable determines whether the control is to be shown or not.

Methods (Servlets & JSP)

MethodDescription
isRestricted Indicates whether users must be logged in before accessing the component.
setRestricted Specify whether users must be logged in before accessing the component.
getPageModel Get the page to which the component belongs.
isProcessed Indicate whether the component has been processed.
hasNextRow Returns true if there are more elements in a collection
nextRow Returns the next row. If the next row isn't available, this method returns an empty HashMap; This method never returns a null.
currentRow Returns the current row.
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 component should be shown.
getParent Get the parent component that contains this control or component.

See also

Path Overview


On-line, printable versions and updates