CodeCharge Studio | All ASP PHP Perl ColdFusion Java C#.NET VB.NET |
Property | Description |
---|---|
Name | The name of the form. |
Connection | The database connection from which information will be retrieved. |
Data Source Type | The type of data source or the method used to retrieve the data. |
Data Source | The database column, SQL Query or other expression from where the data will be retrieved. |
Groups | Report groups that is used to manage repeating values and totals. |
Restricted | Specify whether users must be logged in before accessing the form. |
Lines per Web Page | The size of page in the Web show mode, measured in lines. |
Page Size Limit | The maximum number of lines per page for Web view mode. |
Enable Print Mode | Specify whether print mode can be enabled in runtime. |
Lines per Print Page | The size of page in the Print view mode, measured in lines. |
Default View Mode | Specify the default view mode, which will be used for report. |
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 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. |
Property | Description |
---|---|
ViewMode | Specify the default view mode, which will be used for report. |
PageSize | Specify the page size for the print mode of report. |
RowNumber | Gets the current row number of report. |
PageNumber | Gets the current page number of report. |
Property | Description |
---|---|
DataSource.SQL | This property contains the main portion of the SQL query used to retrieve the records displayed within the form. 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 form. 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 form. |
Property | Description |
---|---|
ComponentType | Specify the type of component. Have value "Report" for Report component. |
ComponentName | Specify the name of report. |
Parent | Specifies parent container of an object, for example a record form for a textbox that is included within that form. |
Visible | This property determines whether the form is to be shown or not. |
PageNumber | Gets the current page number of report. |
PageSize | Specify the page size for the print mode of report. |
ViewMode | Specify the default view mode, which will be used for report. |
Errors | This property keeps a reference to the form's error collection. It is used to collect error messages generated during the form's execution. |
DataSource | This property stores a reference to data source bound to the form. The data source handles all data retrieval operations. It serves as an abstraction layer that hides underlying data source details, whether it is a database table, SQL query or stored procedure. |
Property | Description |
---|---|
DataSource->CountSQL | This property contains the SQL query which is executed to determine the total number of browseable rows in the Grid form. The number retrieved as a result of executing this query is used during the creation of the navigation controls for the form. |
DataSource->SQL | This property contains the main portion of the SQL query used to retrieve the records displayed within the form. 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 form. 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 form. |
DataSource->Order | This property 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 DataSource->SQL property to create the final SQL query which is executed against the datasource to retrieve the records for the control. |
DataSource->RecordsCount | This property contains a count of all the records that have been retrieved for the form. |
Property | Description |
---|---|
DataSource | Gets or sets the data source that provides data for populating the report. |
Groups | Gets the collection of grouping fields. |
TotalPages | Gets the number of pages in current report. |
PageSizeLimit | Gets or sets the page size limit for print mode of report. |
PageSize | Gets or sets the page size for the print mode of report. |
PreviewPageNumber | Gets or sets the page number for the web mode. |
RowNumber | Gets the current row number of report. |
ViewMode | Gets or sets the view mode of report. |
WebPageSize | Gets or sets the page size for the web mode of report. |
Property | Description |
---|---|
errors | This property keeps a reference to the form’s errors NameValueCollection. It is used to collect error messages generated during the object’s execution. |
<control name> | For each control that is located within the form, a member property is created with the same name as the control. |
<field name>GroupField | For each group of report, the member property is created. |
Property | Description |
---|---|
<prefix><parameter name> | For each unique parameter of the Data Source command, a member property is created with the prefix (according to the parameter source type) and parameter name (according to the parameter source). |
Variable | Description |
---|---|
viewMode | Specify the default view mode, which will be used for report. |
<control name>Items | Array contains report lines. Each array item contains structure with current report elements. |
<control name>Item | Structure with current report elements. Structure include key for each report control. |
intPageSize | Specify the page size for the print mode of report. |
intPage | Specify the page size for the print mode of report. |
Method | Description |
---|---|
getViewMode | Returns Report view mode. If print view mode is disabled Report.SHOW_MODE_WEB will always be returned. |
setViewMode | Set Report view mode. |
nextReportRow | Returns the next Report row. |
getReportLabel | Returns the ReportLabel component with specified name. |
size | Returns the number of the Report lines or zero if the Report is not populated with data. |
getRowNumber | Returns the current report row number. Starting with one. |
getTotalPages | Returns number of the report pages |
getPrintPageSize | Returns the height of Report page in print view mode |
setPrintPageSize | Sets the height of Report page in print view mode |
getWebPageSize | Returns the height of Report page in web view mode |
setWebPageSize | Sets the height of Report page in web view mode |
getPageNumber | Get current Report page number. |
getCurrentRow | Get current Report detail row. |
isDetailControl | Returns true if the specified control belongs to Detail row (Detail section); otherwise - false |
isEnablePrintMode | Returns true if print view mode is enabled for report component; otherwise - false |
setEnablePrintMode | Sets enablePrintMode value |
getPageSizeLimit | Returns int value of page size limit if viewMode is Report.VIEW_MODE_WEB; otherwise returns zero. Zero means that all records should be displayed. PageSizeLimit is applied to web mode only. |
setPageSizeLimit | Sets maximal allowed size of the Report page in the web view mode |
getSection | Get section with given name. |
getPage | Get the current page being shown in the Report. |
setPage | Set the page number to be shown in the Report. |
getNumberOfRows | Get the total number of rows in the Report. |
getNavigator | Use a name to find the Navigator among the collection of children controls. |
getSorter | Use a name to find a Sorter among the collection of children controls. |
getPageSize | Get number of records per page. |
setPageSize | Set number of records per page. |
isAllowRead | Returns a value indicating whether the data read operation can proceed or not. |
setAllowRead | Use to toggle the value which determines whether the data read operations can proceed or not. |
isRestricted | Returns a value indicating whether users must be logged in before accessing the form. |
setRestricted | Specify whether users must be logged in before accessing the form. |
getPageModel | Get the page to which the component belongs. |
isProcessed | Indicates whether a component has been processed (the ccsForm parameter is equivalent to the name of the component). |
hasNextRow | Returns true if there are more elements in a collection. |
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 the form should be shown or not. |
getParent | Get the parent component that contains the form. |