Methods for cWebGrid
View method list in alphabetical order.
| Name | Type | Description | Defining Class |
|---|---|---|---|
| AllowChangeSelectedRow | Function | Returns True if a row change is allowed. | cWebGrid |
| AppendNewRow | Procedure | Instructs the client to begin editing a new row at the bottom of the grid Instructs the client to begin editing a new row at the bottom of the grid. | cWebGrid |
| ClearRow | Procedure | Instructs the client to clear the current row at the client Instructs the client to clear the current row at the client. | cWebGrid |
| ClearSelectedRow | Function | Performs a DD Clear operation, clearing any changes in the current row and restoring it to its unchanged state | cWebGrid |
| InsertNewRow | Procedure | Instructs the client to insert a new row above the currently selected row Instructs the client to insert a new row above the currently selected row and begin editing this new row. | cWebGrid |
| MoveToColumnObject | Procedure | Moves the focus to the specified column Send MoveToColumnObject to instruct the client to move the focus to the specified grid column. | cWebGrid |
| MoveToNextColumn | Procedure | Moves the focus to the next column Send MoveToNextColumn to instruct the client to move the focus to the next grid column, i.e. | cWebGrid |
| MoveToPreviousColumn | Procedure | Moves the focus to the previous column Send MoveToPreviousColumn to instruct the client to move the focus to the previous grid column, i.e. | cWebGrid |
| RequestClearExec | Procedure | Performs the second half of a DD clear row operation which was started by Request_Clear/ClearSelectedRow | cWebGrid |
| RequestSaveExec | Procedure | Performs the second half of a DD save row operation which was started by Request_Save/SaveSelectedRow | cWebGrid |
| SaveSelectedRow | Function | Performs a DD save row operation | cWebGrid |
| ShouldSaveRow | Function | Returns True if the row has changes ShouldSaveRow is called to determines if the current row has changed values in which case it should be saved. | cWebGrid |
| UpdateRow | Procedure | Refreshes the client's current row data Send UpdateRow to refresh the client's current row data. | cWebGrid |
| ValidateRow | Function | Validates the selected row Validates the selected row. | cWebGrid |
Inherited Methods from cWebList
| Name | Type | Description | Defining Class |
|---|---|---|---|
| AllowChangeSelectedRow | Function | Tests whether you can move off the selected row to a different row | cWebList |
| AppendNewRow | Procedure | Instructs the client to add a new row to the end of the grid Send AppendNewRow to instruct the client to add a new row to the end of the grid (cWebGrid). | cWebList |
| ApplyColumnLayout | Procedure | Applies a column layout Applies a column layout. | cWebList |
| ApplyGroupConfig | Procedure | Applies a group configuration for automatic grouping Applies a group configuration for automatic grouping. | cWebList |
| ClearGrid | Procedure | Clears the grid rows creating an empty grid If you have a non-data-aware grid or list, you can send ClearGrid to clear all of the grid's row data, thus creating an empty grid. | cWebList |
| ClearGroupConfig | Procedure | Clears the grouping configuration Clears the grouping configuration for automatic grouping resulting in the data showing ungrouped. | cWebList |
| ClearSelectedRow | Function | Does nothing in cWebList Does nothing in cWebList class. | cWebList |
| ClientSortable | Function | Determines whether the list could be sorted on the client ClientSortable is called to determine if sorting on the client is possible. | cWebList |
| CollapseAllGroups | Procedure | Collapses all groups Collapses all the currently shown groups. | cWebList |
| ColumnCount | Function | Returns the number of columns in the list Returns the number of columns in the list. | cWebList |
| DataSetAppendRow | Procedure | Appends a new row of data to the end of the list Send DataSetAppendRow to append a new row of data to the end of the list. | cWebList |
| DataSetInsertRowAfter | Procedure | Inserts a new row of data into the list after a specified row Send DataSetInsertRowAfter to inserts a new row of data into the list after the row with the provided row id. | cWebList |
| DataSetInsertRowBefore | Procedure | Inserts a new row of data into the list before a specified row Send DataSetInsertRowBefore to inserts a new row of data into the list before the row with the provided row id. | cWebList |
| DataSetRemoveRow | Procedure | Removes a single row of data from the list Send DataSetRemoveRow to remove a single row of data from the list. | cWebList |
| DataSetUpdateRow | Procedure | Updates a single row in the list with new data Send DataSetUpdateRow to update an existing row in the list with new data. | cWebList |
| Define_cFilterExpression_mixin | Procedure | cWebList | |
| DeleteSelectedRow | Function | Performs a DD delete row operation | cWebList |
| DragData | Function | Returns the DragData for this control Returns the DragData for this control, set by the active cWebDragDropHelper object. | cWebList |
| DropData | Function | Returns the DragData for this control Returns the DragData for this control, set by the active cWebDragDropHelper object. | cWebList |
| ExpandAllGroups | Procedure | Expands all groups Expands all the currently shown groups. | cWebList |
| FindDDRecordInBuffer | Procedure | Performs a full refresh of the list and tries to maintain the current record in the DD Finds the record in the buffer and rebuilds the list. | cWebList |
| FindFromBottom | Procedure | Performs a full refresh of the list / grid selecting the last record of the new data set | cWebList |
| FindFromTop | Procedure | Performs a full refresh of the list / grid selecting the first record of the new data set | cWebList |
| GetColumnObject | Function | Returns the column object handle of the passed column ID Returns the column object handle of the passed column ID. | cWebList |
| GridRefresh | Procedure | Send this message to fire an action on the client telling it to refresh the grid (for non-data-aware grids only) Send this message to fire an action on the client telling it to refresh the grid. | cWebList |
| HandleCacheError | Procedure | Called when the grid cannot find a cached record on the back end This method is called when the grid cannot find a cached record on the back end. | cWebList |
| IndexOrder | Function | Returns the database index number currently used to sort the rows of a data-aware grid or list Returns the database index number currently used to sort the rows of a data-aware grid or list. | cWebList |
| InsertNewRow | Procedure | Instructs the client to insert a new row above the current row of the grid Send InsertNewRow to instruct the client to insert a new row above the current row of the grid (cWebGrid). | cWebList |
| LoadDataPage | Procedure | Sent by the client to load a page of data This message is sent by the client to load a page of data. | cWebList |
| LoadGridRow | Function | Helper function for manually loading data LoadGridRow can be used as a helper function within the OnManualLoadData event handler. | cWebList |
| MoveDownRow | Procedure | Instructs the client to move the current row down one row Send MoveDownRow to instruct the client to move the current row down one row. | cWebList |
| MovePageDown | Procedure | Instructs the client to move the current row down one page Send MovePageDown to instruct the client to move the current row down one page. | cWebList |
| MovePageUp | Procedure | Instructs the client to move the current row up one page Send MovePageUp to instruct the client to move the current row up one page. | cWebList |
| MoveToFirstRow | Procedure | Instructs the client to navigate to the first row Send MoveToFirstRow to instruct the client to navigate to the first row in the list or grid. | cWebList |
| MoveToLastRow | Procedure | Instructs the client to navigate to the last row Send MoveToLastRow to instruct the client to navigate to the last row in the list or grid. | cWebList |
| MoveToRow | Procedure | Instructs the client to navigate to the row matching the passed row index Send MoveToRow to instruct the client to navigate to the row matching the passed row index. | cWebList |
| MoveToRowByID | Procedure | Instructs the client to navigate to the row matching the passed RowID Send MoveToRowByID to instruct the client to navigate to the row matching the passed RowID. | cWebList |
| MoveUpRow | Procedure | Instructs the client to move the current row up one row Send MoveUpRow to instruct the client to move the current row up one row. | cWebList |
| ProcessDataSet | Procedure | Called to retrieve the entire set of grid data (rows & columns) | cWebList |
| ReadingServer | Function | Returns the actual Server DDO used by the list | cWebList |
| RefreshListFromDD | Procedure | Refreshes a data-aware grid around the current record in the server Data Dictionary | cWebList |
| RemoveRow | Procedure | Instructs the client to remove the specified row at the client Instructs the client to remove the specified row at the client. | cWebList |
| ReportCacheError | Procedure | Called when a cache error should be reported Is called when a cache error should be reported. | cWebList |
| Request_Clear | Procedure | Attempts to clear changes in a row Request_Clear attempts to clear changes in a row. | cWebList |
| Request_Delete | Procedure | Attempts to delete the current row Request_Delete attempts to delete the current row. | cWebList |
| Request_Save | Procedure | Attempts to save changes in the current row Request_Save attempts to save the changes in current row. | cWebList |
| RequestDeleteExec | Procedure | Performs the second half of a DD delete row operation which was started by Request_Delete/DeleteSelectedRow | cWebList |
| ResetColumnLayout | Procedure | Resets the column layout to the original design time layout Resets the column layout to the original design time layout. | cWebList |
| SaveSelectedRow | Function | Does nothing in cWebList Does nothing in cWebList class, since cWebLists are read only. | cWebList |
| ScrollToColumnObject | Procedure | Scrolls a column into the view by scrolling horizontally Scrolls a column into the view by scrolling horizontally. | cWebList |
| Search | Procedure | Sends the showSearch client action to the client This sends the showSearch client action to the client. | cWebList |
| SelectBestColumn | Function | Finds the best column for the passed table and column number | cWebList |
Inherited Methods from cWebBaseControl
| Name | Type | Description | Defining Class |
|---|---|---|---|
| HideInfoBalloon | Procedure | Hides an information balloon HideInfoBalloon hides an information balloon displayed with ShowInfoBalloon. | cWebBaseControl |
| ShowInfoBalloon | Procedure | Displays an information balloon It is possible to show information balloons next to a control using the ShowInfoBalloon procedure. | cWebBaseControl |
Inherited Methods from cWebBaseDEOServer
| Name | Type | Description | Defining Class |
|---|---|---|---|
| DataLossConfirmation | Procedure | Default data loss Yes/No confirmation message | cWebBaseDEOServer |
| DDRefreshTableStatus | Function | Returns the table's status for the Refresh event DDRefreshTableStatus returns the table's status for the Refresh event. | cWebBaseDEOServer |
| DeleteConfirmation | Procedure | Default delete confirmation message This is the default delete confirmation message. | cWebBaseDEOServer |
| DEO_Control_Object | Function | Indicates if this DEO is a data bindable control or container Required DD/DEO interface. | cWebBaseDEOServer |
| DEO_Find_Object | Function | Indicates that this DEO understands the DEO Request_Find protocol Required DD/DEO interface. | cWebBaseDEOServer |
| Request_Clear | Procedure | Performs a DD Clear operation Request_Clear performs a clear operation by sending Clear to the object's DataDictionary object (DDO) Server. | cWebBaseDEOServer |
| Request_Clear_All | Procedure | Performs a DD Clear_All operation | cWebBaseDEOServer |
| Request_Delete | Procedure | Performs a DD delete operation | cWebBaseDEOServer |
| Request_Save | Procedure | Performs a DD save operation | cWebBaseDEOServer |
| RequestClearAllExec | Procedure | Performs the second half of a DD Clear_All operation which was started by Request_Clear_All | cWebBaseDEOServer |
| RequestClearExec | Procedure | Performs the second half of a DD Clear operation which was started by Request_Clear | cWebBaseDEOServer |
| RequestDeleteExec | Procedure | Performs the second half of a DD delete operation which was started by Request_Delete | cWebBaseDEOServer |
| RequestSaveExec | Procedure | Performs the second half of a DD save operation which was started by Request_Save RequestSaveExec performs the second part of a Request_Save operation. | cWebBaseDEOServer |
| SaveClearCancelConfirmation | Procedure | Default save, clear, cancel Yes/No/Cancel confirmation message | cWebBaseDEOServer |
| SaveConfirmation | Procedure | Default save confirmation message This is the default save confirmation message. | cWebBaseDEOServer |
| ServerDEO | Function | Returns the DEO that sets the server Returns the data entry object (DEO) that sets the Server property. | cWebBaseDEOServer |
Inherited Methods from cWebBaseUIObject
| Name | Type | Description | Defining Class |
|---|---|---|---|
| AddKeyHandler | Procedure | Adds a client side key handler It is possible to assign custom key handlers to controls and containers. | cWebBaseUIObject |
| ConditionalFocus | Procedure | Gives the control the focus but only if the browser platform is not a mobile device (tablet / phone) | cWebBaseUIObject |
| DragData | Function | Returns the DragData for this control Returns the DragData for this control, set by the active cWebDragDropHelper object. | cWebBaseUIObject |
| DropData | Function | Returns the DragData for this control Returns the DragData for this control, set by the active cWebDragDropHelper object. | cWebBaseUIObject |
| Focus | Procedure | Gives the control the focus Gives the control the focus. | cWebBaseUIObject |
| IsControlAccessible | Function | Determines if the control is currently accessible Determines if the control is currently accessible. | cWebBaseUIObject |
| IsControlEnabled | Function | Determines if a control is enabled | cWebBaseUIObject |
| IsControlRendered | Function | Determines if a control is rendered Determines if a control is rendered (if pbRender is True of itself and its parents). | cWebBaseUIObject |
| IsControlVisible | Function | Determines if a control is visible Determines if a control is visible (if pbVisible is True of itself and its parents). | cWebBaseUIObject |
| RemoveKeyHandler | Procedure | Removes a client side key handler It is possible to assign custom key handlers to controls and containers. | cWebBaseUIObject |
| ScrollIntoView | Procedure | Scrolls an object that is currently scrolled out of the view into view Scrolls an object that is currently scrolled out of the view/hidden because the view has scrolled into view. | cWebBaseUIObject |
Inherited Methods from cWebObject
| Name | Type | Description | Defining Class |
|---|---|---|---|
| CallBack | Procedure | Use this procedure to delay a task to a new server round-trip Use this procedure to delay a task to a new server next round-trip. | cWebObject |
| ClientAction | Procedure | Calls a function of the client JavaScript object Send ClientAction to call a function that belongs to the JavaScript object on the client that represents the DataFlex object. | cWebObject |
| ClientActionEx | Procedure | Adds a client action to the response that will be executed on the client Adds a client action to the response that will be executed on the client. | cWebObject |
| DEO_Object | Function | Determines if the object understands the DEO interface Determines if the object understands the data entry object (DEO) interface (is data-aware). | cWebObject |
| Host | Function | Returns a Handle to the Host object of this web object Use this function to get a handle to the host for this Web Object. | cWebObject |
| InitDynamicProp | Procedure | Sets a dynamic property value Sets a dynamic property value. | cWebObject |
| IsDynamicObject | Function | Checks whether the object is dynamic or not Checks whether the object is dynamic or not. | cWebObject |
| IsLoaded | Function | Checks if the webobject is loaded to the client | cWebObject |
| NavigateInfo | Function | Returns array of navigation paths that the current object has registered Returns an array of navigation paths that the current object has registered. | cWebObject |
| NavigatePath | Procedure | Performs the navigation registered for this web object Performs the navigation registered for this web object. | cWebObject |
| ptActionData | Function | Retrieves the action data for a server action as value tree Retrieves the action data for a server action as value tree. | cWebObject |
| ResourceManager | Function | Returns handle to the cWebResourceManager object Use this function to get a handle to the cWebResourceManager object. | cWebObject |
| ServerPropStore | Function | Returns handle to the cWebServerPropStore object Use this function to get a handle to the cWebServerPropStore object. | cWebObject |
| ServiceDispatcher | Function | Returns handle to the cWebServiceDispatcher object Use this function to get a handle to the cWebServiceDispatcher object. | cWebObject |
| SessionManager | Function | Returns handle to the cWebSessionManager object Use this function get a handle to the cWebSessionManager object. | cWebObject |
| SetActionMode | Procedure | Allows developer to configure a wait dialog for every server action | cWebObject |
| UnSyncWebProperty | Procedure | Unsynchronizes a client web property Unsynchronizes a client web property. | cWebObject |
| ViewStack | Function | Returns handle to the cWebViewStack object Use this function to get a handle to the cWebViewStack object used in drill-down applications. | cWebObject |
| WebMethodByName | Function | Searches for the message handle of a message based on the name of a web method This function searches for the message handle of a message based on the name of a web method. | cWebObject |
| WebMethodIsFunction | Function | Determines if a web method is a function or a procedure Use this function to determine if a web method is a function or a procedure. | cWebObject |
| WebMethodName | Function | Converts the message handle of a web method into a string Converts the message handle of a web method into a string. | cWebObject |
| WebObjectByName | Function | Searches for the object handle of a web object using its public name This function searches for the object handle of a web object using its public name. | cWebObject |
| WebObjectName | Function | The public web object name of this object Returns the public web object name of this object. | cWebObject |
Inherited Methods from cObject
| Name | Type | Description | Defining Class |
|---|---|---|---|
| ChildByIndex | Function | Can be used to iterate the direct children of an object ChildByIndex is a function that can be used to iterate the direct children of an object. | cObject |
| ClassSuperClass | Function | Returns the superclass of the passed class This returns the superclass of the passed class. | cObject |
| Create | Function | Creates an object based on the passed Class Id The Create function is used to dynamically create objects. | cObject |
| CreateNamed | Function | Creates an object based on the passed Class Id and assigns it a name Name based on a passed name Creates an object based on the passed Class Id and assigns it a name Name based on a passed name. | cObject |
| Destroy | Procedure | Destroys the object that receives the message and any child objects of that object The Destroy message destroys the object that receives the message. | cObject |
| Exit_Application | Procedure | Starts the process of closing an application The Exit_Application message is used to close the program. | cObject |
| IsClassOfClass | Function | Determines whether the target class is part of the searched class's hierarchy | cObject |
| IsObjectOfClass | Function | Determines whether the passed class is part of the object's class hierarchy This returns True if the passed class is part of the object's class hierarchy. | cObject |
| ObjectClass | Function | Returns the integer class ID assigned to the class this object is based on Returns the integer class ID assigned to the class this object is based on. | cObject |
| Request_Destroy_Object | Procedure | Use the Destroy method instead This method is used to destroy an object and all of its children. | cObject |