Methods for cWebAppUserDataDictionary
View method list in hierarchical order.
| Name | Type | Description | Defining Class |
|---|---|---|---|
| Add_Client_File | Procedure Set | Adds a table to this object's related-child list dataflex Set Add_Client_File to Orderdtl.File_Number A Data Dictionary needs to know about its related-from, child tables. |
DataDictionary |
| Add_Server_File | Procedure Set | Adds a table to this object's related-parent list dataflex Set Add_Server_File to Customer.File_Number A Data Dictionary needs to know about its related-to, parent tables. |
DataDictionary |
| Add_System_File | Procedure Set | Obsolete Adds iFile to this object's system file list | DataDictionary |
| Add_User_Interface | Procedure | Adds the passed in hoDEO to the list of data entry objects (DEOs) for this object Adds specified hoDEO to the set of DEOs attached to this object. | BaseData_Set |
| Alias_File | Procedure Set | Declares this DD to be an alias DD This declares this DD to be an alias DD and makes iTable the Main_File for this DD. | DataDictionary |
| AllowParentFind | Function | Called to determine if the parent DD can be use to do a parent find Called to determine if the parent DD can be use to do a parent find. | DataDictionary |
| ApplySQLFilter | Procedure | Called before a Data Dictionary find/read and is used to set DD SQL Filters This is called before a DataDictionary (DD) find/read and is used to set DD SQL Filters. | DataDictionary |
| ApplySQLFilterStr | Procedure | Called before a Data Dictionary find / read to set DD SQL Filters Applies the passed SQL filter. | DataDictionary |
| Attach_Server | Procedure | Use DDO_Server instead Obsolete Use DDO_Server instead. | BaseData_Set |
| AutoIncrement | Procedure | Handles incrementing of auto-increment columns | BaseData_Set |
| CascadeDeleteAllowed | Procedure Set | Child DDs can specify if they will allow their records to be deleted as part of a cascade delete | DataDictionary |
| CascadeDeleteNull | Procedure Set | Allows child DDs to specify if they should be deleted or have their child to parent relationship set to null | DataDictionary |
| 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 |
| Clear | Procedure | Clears all tables owned by this object | BaseData_Set |
| Clear_All | Procedure | Clears all files owned by this object and all connected server DataDictionary objects (DDOs) Clear_All sends Refresh to notify data entry objects (DEOs). | BaseData_Set |
| ClearAllRememberedDefaults | Procedure | Clears all dynamically assigned defaults for all DDOs in this structure Clears all dynamically assigned defaults for all DataDictionary Objects (DDOs) in this DDO structure. | DataDictionary |
| ClearDDRelates | Procedure | Clears all local DD relationships Clears all local Data Dictionary (DD) relationships allowing you to start with a blank slate. | BaseData_Set |
| ClearForTable | Procedure | Clears all tables owned by this object by redirecting Clear to the table's owner | BaseData_Set |
| ClearRememberedDefaults | Procedure | Clears all dynamically assigned defaults for this one DDO Clears all dynamically assigned defaults for this one DataDictionary Object (DDO). | DataDictionary |
| Constrain | Procedure | Defines constraint set for this object The Constrain procedure defines constraint set for this object, using Constrain_File. | BaseData_Set |
| 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 |
| CurrentRowId | Function | Returns the RowId of the current record | BaseData_Set |
| Data_Set | Function | Returns the object id of the DataDictionary object whose main file is passed to the function | DataDictionary |
| Data_set_error | Procedure | Declares DataDictionary object (DDO) errors The Data_set_error procedure is used to declare DataDictionary object (DDO) errors. | DataDictionary |
| Data_Set_PostFind | Procedure | Hook after a find to allow application or removal of Data Dictionary SQL filters | BaseData_Set |
| Data_Set_PreFind | Procedure | Hook prior to a find to allow application or removal of Data Dictionary SQL filters | BaseData_Set |
| DDOConstraintFindMeta | Function | Returns Constraints MetaData information for a particular index | DataDictionary |
| DDOConstraintNeedsRelate | Function | Determines whether the constraints you are using require relates to determine if a record is valid | DataDictionary |
| DDOConstraints | Function | Used to query array of DataFlex constraints | DataDictionary |
| DefineAllExtendedFields | Procedure | Obsolete Creates extended DataDictionary fields for all text and binary fields within a DataDictionary object (DDO) | DataDictionary |
| DefineAsAlias | Procedure | Sets this DD to work as an alias This sets this DD to work as an alias, by clearing all required servers and clients. | DataDictionary |
| DefineExtendedField | Procedure | Obsolete Creates extended DataDictionary field for a text or binary field within a DataDictionary object (DDO) | DataDictionary |
| 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 |
| Detach_Server | Procedure | Disconnects this object and the specified DataDictionary object (DDO), where this object was the client of that DDO server | BaseData_Set |
| ErrorMessageTableName | Function | Returns the table name to be used when a DDO displays an error with a table name | DataDictionary |
| Establish_Find_Direction | Procedure | Initializes the constrained find commands to perform searches using the given parameters | BaseData_Set |
| Exit_Application | Procedure | Starts the process of closing an application The Exit_Application message is used to close the program. | cObject |
| Extended_Error_Field | Function | Extends the extended error logic of the Error handler | DataDictionary |
| Extended_Error_File | Function | Extends the extended error logic of the Error handler The Extended_Error_File function extends the extended error logic of the Error handler. | DataDictionary |
| Extended_Error_Message | Function | Called by the standard DataFlex error handler when a DataDictionary error occurs | DataDictionary |
| Field_CommitNoEnterOnIndex | Function | Determines if a committed table column that has an index should support entry | DataDictionary |
| Field_Option_Clear | Procedure Set | Clears a field option for a table column | DataDictionary |
| Field_Option_Toggle | Procedure Set | Toggles a field option of a table column Obsolete Field_Option_Toggle is used to toggle (reverse) the value of a field option. | DataDictionary |
| File_Field_AutoFind | Procedure | Performs an AutoFind on a foreign table column File_Field_AutoFind performs an AutoFind on a foreign table column. | DataDictionary |
| File_Field_Default_AutoFind | Procedure | Performs an AutoFind on a foreign table column without setting the DDO's Changed_State to True File_Field_Default_AutoFind performs an AutoFind on a foreign table column in "default" mode. | DataDictionary |
| File_Field_DynamicEntryOptions | Function | Used to check the current state of NoPut and NoEnter field options Used to check the current state of NoPut and NoEnter Field_Options. | DataDictionary |
| File_Field_Entry | Procedure Set | Allows you to place data into a DataDictionary field buffer using all the same logic that gets applied to data entry object/keyboard entry | DataDictionary |
| File_Field_Find | Procedure | Allows you to simulate the find-key process of data entry objects within batch processes | DataDictionary |
| File_Field_Option_Clear | Procedure Set | Obsolete Clears a DD field option | DataDictionary |
| File_Field_Option_Toggle | Procedure Set | Obsolete Toggles (reverse) the value of a DD field option Obsolete File_Field_Option_Toggle is used to toggle (reverse) the value of a DD field option. | DataDictionary |
| File_Field_Pointer_Entry | Procedure Set | Called to move data from an entry source to the DataDictionary (DD) extended buffer | DataDictionary |
| Find | Procedure | Performs a find operation on the DataDictionary's main data file using the passed mode and index | DataDictionary |
| Find_By_Recnum | Procedure | Finds record in specified table with record number equal to the passed in record number ### Obsolete This method is obsolete as it can only be used with tables that support recnum. | BaseData_Set |
| FindByRowId | Procedure | Finds record in specified table with record identity equal to the passed RowId and updates the DDO structure | BaseData_Set |
| FindByRowIdEx | Function | Finds record in specified table with record identity equal to the passed RowId and updates the DDO structure, with silent find errors and returning success or failure | BaseData_Set |
| HasRecord | Function | Determines if the DataDictionary object (DDO) has a current record | BaseData_Set |
| IsAlias | Function | Returns whether table is an alias table This can be used in the main (master) DD classes to write custom code regular and alias DDs. | DataDictionary |
| IsCascadeDeleteAllowed | Function | Determines whether a child record can be deleted When a delete operation has found a child record, it will see if it can be deleted by calling IsCascadeDeleteAllowed. | BaseData_Set |
| IsClassOfClass | Function | Determines whether the target class is part of the searched class's hierarchy | cObject |
| IsCommitted | Function | Called to determine if the record is committed Called to determine if the record is committed (see Commit Field_Option). | DataDictionary |
| IsCommittedParentChangeAllowed | Function | Called to determine if the server's parent is allowed to be switched Called to determine if the server's parent is allowed to be switched. | DataDictionary |
| IsFieldCommitted | Function | Called to determine if the column's commit field option is set Called to determine if the column's Commit Field_Option is set. | DataDictionary |
| IsNullParentAllowed | Function | Called to determine if an inactive parent DDO can be null Called to determine if an inactive parent DDO can be null. | DataDictionary |
| 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 |
| IsRelatesToConstrained | Function | Determines if a child DDO is currently constrained to a particular parent table | BaseData_Set |
| Locate_Next | Procedure | Finds the next logical record using the passed in find mode, file, and index specified in a prior Establish_Find_Direction invocation | BaseData_Set |
| MasterForAlias | Function | Returns the master table for an alias table Returns the master table for an alias table. | DataDictionary |
| 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 |
| Operation_Not_Allowed | Procedure | Executes the error command with the passed in error number. | DataDictionary |
| ParentDDOSwitched | Function | Determines whether the parent DDO has switched to a different record Determines whether the parent DDO has switched to a different record. | BaseData_Set |
| ParentNoSwitchIfCommitted | Procedure Set | Determines if a parent record can be switched, once it is committed | DataDictionary |
| ParentNullAllowed | Procedure Set | Specifies whether a null parent is allowed or not By default, this is always False. | DataDictionary |
| Read_By_Recnum | Procedure | Finds record in specified tabile with record number equal to the passed in record number ### Obsolete This method is obsolete as it can only be used with tables that support recnum. | BaseData_Set |
| ReadByRowId | Procedure | Finds record in specified table with record identity equal to the passed RowId without updating or altering the DDO structure | BaseData_Set |
| ReadByRowIdEx | Function | Finds record in specified table with record identity equal to the passed RowId without updating or altering the DDO structure, with silent find errors and returning success or failure | BaseData_Set |
| Rebuild_Constraints | Procedure | Builds the constraint set for a DDO The Rebuild_Constraints procedure builds the constraint set for a DDO. | BaseData_Set |
| RebuildAllConstraints | Procedure | Can be sent to any DDO within a DDO structure to rebuild all constraint within the structure | BaseData_Set |
| Refind_Records | Procedure | Checks to see if the record in the global table buffer is the same as the record in the DDO buffer and refinds the record in the global table buffer if needed | BaseData_Set |
| Remove_Client_File | Procedure | Removes a table from this object's container-file list The Remove_Client_File procedure removes a table from this object's container-table list. | BaseData_Set |
| Remove_Server_File | Procedure | Removes a table from this object's server-file list The Remove_Server_File procedure removes a table from this object's server-table list. | BaseData_Set |
| Remove_System_File | Procedure | Removes a table from this object's system file list The Remove_System_File procedure removes a table from the DataDictionary structure. | DataDictionary |
| Remove_User_Interface | Procedure | Removes a table from this object's data entry object (DEO)-list The Remove_User_Interface procedure removes a data entry object (DEO)-id from this object's DEO-list. | BaseData_Set |
| Request_Assign | Procedure | Causes the Refresh message to be sent to all data entry objects for this object and its client and server DataDictionary objects as appropriate | BaseData_Set |
| Request_Clear | Procedure | See (and use) Clear Obsolete See (and use) Clear for clearing DataDictionaries. | DataDictionary |
| Request_Clear_File | Procedure | Performs the Clear command on the specified table of the data-server structure The Request_Clear_File procedure performs the Clear command on the specified table of the data-server structure. | BaseData_Set |
| Request_Delete | Procedure | Responsible for deleting a record in the DDO for the main_file, updating all parent DDOs (and tables) and possibly deleting all child records | BaseData_Set |
| Request_Destroy_Object | Procedure | Use the Destroy method instead This method is used to destroy an object and all of its children. | cObject |
| Request_Entry_Update | Procedure | Sends entry_update to all DEOs of the data set and DEOs of servers of the data set as required to store changes to record buffers | BaseData_Set |
| Request_Find | Procedure | Finds on specified table using given find mode and index The Request_Find procedure finds on specified table using given find mode and index. | BaseData_Set |
| Request_Read | Procedure | Finds on specified table using given find mode and index The Request_Read procedure finds on specified table using given find mode and index. | BaseData_Set |
| Request_Relate | Procedure | Performs a relate on the specified table without initializing the done-array The Request_Relate procedure performs a relate on the specified table without initializing the done-array. | BaseData_Set |
| Request_Save | Procedure | Saves all changes in DEOs attached to this object or to any DDO that is a server of this object directly or indirectly | BaseData_Set |
| Request_Superfind | Procedure | Performs superfind on the designated table by the Main_Index of the designated field and notifies all connected DataDictionary objects (DDOs) of the result | BaseData_Set |
| Request_Validate | Function | Request_Validate sends validation messages to all DDO Field's that will participate in the upcoming save Request_Validate returns 0 (zero) if all items are valid, else returns a non-zero value. | BaseData_Set |
| Request_Validate_All | Function | Similar to Request_Validate, except that a validation will continue after a validation error has occurred | DataDictionary |
| ResetChangedStates | Procedure | DataDictionary | |
| RestoreDefaultSQLFilters | Procedure | Restores the global table SQL filters back to their original pre-find state This restores the global table SQL filters back to their original pre-find state. | DataDictionary |
| ShouldSaveConstrainedToServer | Function | Determines if any relates-to constrained parent is changed Determines if any relates-to constrained parent is changed. | DataDictionary |
| SQLEscapedStr | Function | Converts string to a string that is better suited and safer for SQL WHERE clauses SQLEscapedStr changes a string to an "escaped" string that is better suited for being used in SQL statements. | DataDictionary |
| SQLStrAppend | Function | Helper function that will take two SQL filter strings and combine them using proper SQL AND syntax This is a helper function that will take two SQL filter strings and combine them (i.e. | DataDictionary |
| SQLStrAppendOr | Function | Helper function that will take two SQL filter strings and combine them using proper SQL OR syntax This is a helper function that will take two SQL filter strings and combine them (i.e. | DataDictionary |
| SQLStrFieldName | Function | Helper function that returns a string representing the SQL column in a format that can be used by an SQL WHERE clause | DataDictionary |
| SQLStrFileFieldName | Function | Helper function that returns a string representing the SQL table and column in a format that can be used by an SQL WHERE clause | DataDictionary |
| SQLStrFileName | Function | Helper function that returns a string representing the SQL table name in a format that can be used by an SQL WHERE clause | DataDictionary |
| SQLStrLike | Function | Helper function that will create an SQL LIKE string for a table column and a target value to be used in the WHERE clause of SQL statements | DataDictionary |
| SQLStrSchemaFileFieldName | Function | Helper function that will create a string that that represents the SQL schema, table and column in a format that can be used by an SQL WHERE clause | DataDictionary |
| StoreDefaultSQLFilters | Procedure | Stores any information about the table's current SQL filters This stores any information about the table's current SQL filters. | DataDictionary |
| SupportsSQLFilters | Function | Can be queried to determine if this table is capable of supporting SQL filtering and the Data Dictionary SQL filter interface | DataDictionary |
| Validate_Constraints | Function | Validates this object's constraints against the record buffer's current content | BaseData_Set |