Properties for cWebAppSessionDataDictionary
View property list in hierarchical order.
| Name | Description | Defining Class |
|---|---|---|
| Allow_Foreign_New_Save_State | Allows saving of a new record when a table is being used as a foreign table | DataDictionary |
| Auto_Fill_State | Determines what a DDO should do with a relates-to constrained child when that parent changes | DataSet |
| Can_Delete | Returns whether delete is an allowed operation in the DDO object | BaseData_Set |
| Cascade_Delete_State | Determines how a delete should be affected by the existence of child-file records that relate to the record being deleted | BaseData_Set |
| Changed_State | Determines whether DEOs attached to this object have changed and/or whether a related parent record has changed | BaseData_Set |
| Child_Count | Returns the number of child objects the object contains | cObject |
| Client_File | Returns the number of the table at the passed-in position in this object's client table list | BaseData_Set |
| Client_File_Count | Returns the number of files in this object's client file list | BaseData_Set |
| Constrain_File | The number of the table that should constrain the main file of this object | DataSet |
| Current_Record | The number of the record most recently retrieved from the database | BaseData_Set |
| Data_Set_Client | Returns the object id of the DataDictionary object (DDO) at position iItem in this object's container DDO list | BaseData_Set |
| Data_Set_Client_Count | Returns the number of DataDictionary objects (DDOs) in this object's container DDO list | BaseData_Set |
| Data_Set_Server | Returns the object id of the DataDictionary object (DDO) at position iItem in this object's server DDO list | BaseData_Set |
| Data_Set_Server_Count | Returns the number of DataDictionary objects (DDOs) in this object's server DDO list | BaseData_Set |
| Data_Set_User_Interface | Returns the object id of the data entry object (DEO) at position iItem in this object's user-interface DEO list | BaseData_Set |
| Data_Set_User_Interface_Count | Returns the number of data entry objects (DEOs) in this object's user-interface DEO list | BaseData_Set |
| DDO_Server | The Object_ID of this object's server DataDictionary object (DDO) | DataSet |
| Delegation_Mode | Determines if and how unknown messages are delegated | cObject |
| Entry_Permissive_State | Determines whether changing of parent record relationships is permitted. | BaseData_Set |
| Error_Report_Mode | Determines how errors are generated through the messages Operation_Not_Allowed and Data_Set_Error | DataDictionary |
| Existing_Key_Value | Returns the concatenated values of all key table columns | DataDictionary |
| Field_Auto_Increment | Defines a column's auto-increment table and column | DataDictionary |
| Field_Changed_State | Flags a table column as changed or not, which determines whether the column participates in a save operation | DataDictionary |
| Field_Changed_Value | Sets the current value of a table column and sets the column's Field_Changed_State to True | DataDictionary |
| Field_CheckBox_Value | Returns the symbolic value for a table column for the specified checkbox state (checked or unchecked) | DataDictionary |
| Field_CheckBox_Values | Configures a table column for use with a checkbox control | DataDictionary |
| Field_Class_Name | Specifies a specific class as the default class for a table column | DataDictionary |
| Field_Count | Returns the number of columns in the DDO | DataDictionary |
| Field_Current_Description | Returns the description for the current value of a table column as listed in the column's validation table | DataDictionary |
| Field_Current_Pointer_Value | Returns a pointer to data in the extended table column object | DataDictionary |
| Field_Current_UCAValue | Sets and returns data in the extended table column object using the UChar array type | DataDictionary |
| Field_Current_Value | Get/sets the current value of a table column | DataDictionary |
| Field_Default_Value | Sets the default value of a table column without setting the DDO's Changed_State to True | DataDictionary |
| Field_Entry_msg | Sets the Id of the message to be sent when the cursor enters a table column | DataDictionary |
| Field_Error | Assigns a specific error message for validation errors for a table column | DataDictionary |
| Field_Error_Message | Returns the error message for a table column | DataDictionary |
| Field_Error_Number | Returns the error number for a table column | DataDictionary |
| Field_Exit_msg | Sets the Id of the message to be sent when the cursor exits a table column | DataDictionary |
| Field_Index | Returns the main index for a table column | DataDictionary |
| Field_Label | Returns the value of Field_Label_Long or Field_Label_Short, or the tag name of a table column | DataDictionary |
| Field_Label_Long | Long description of table column name for form captions, etc. | DataDictionary |
| Field_Label_Short | Short description of table column name for form captions, etc. | DataDictionary |
| Field_Main_Index | Returns the number of the index to use for finding on the specified table column | DataSet |
| Field_Mask | Provides the token characters for the mask for a table column | DataDictionary |
| Field_Mask_Type | Gets/sets the mask type of a table column | DataDictionary |
| Field_Option | Gets/sets the state of a field option for this table's column | DataDictionary |
| Field_Options | Sets field options for the table's column | DataDictionary |
| Field_Prompt_Object | Get/sets the object Id of the Prompt_Object for a table column, such as a lookup (selection) list | DataDictionary |
| Field_Related_Field | Retrieves the related column of a relationship at the local DD level instead of the table level | BaseData_Set |
| Field_Related_File | Retrieves the related table of a relationship at the local DD level instead of the table level | BaseData_Set |
| Field_Related_FileField | Defines a relationship at the local DD level instead of the table level | BaseData_Set |
| Field_RememberedValue | Allows you or your user to dynamically assign and remember a specific value or set a default value | DataDictionary |
| Field_Select_State | Gets/sets a table column's state in the local buffer | DataDictionary |
| Field_Table_Object | Returns the Id of the validation table set up to validate this table column | DataDictionary |
| Field_Validate_msg | Sets the Id of the message to be sent when a table column should be validated | DataDictionary |
| Field_Value_Check | Configures a check-type validation for a table column | DataDictionary |
| Field_Value_Range | Configures a range-type validation for a table column | DataDictionary |
| Field_Value_Table | Sets the Id of the validation table set up to validate this table column | DataDictionary |
| Field_WebPrompt_Object | Get/sets the object Id of the Prompt_Object for a table column, such as a lookup (selection) list | DataDictionary |
| Field_Zoom_Object | Get/sets the object Id of the Zoom_Object for a table column, such as a lookup (selection) list | DataDictionary |
| File_Field_Changed_State | Flags a foreign table column as changed or not, which determines whether the column participates in a save operation | DataDictionary |
| File_Field_Changed_Value | Sets the current value of a foreign table column and sets the column's Field_Changed_State to True | DataDictionary |
| File_Field_CheckBox_Value | Returns the symbolic value for a foreign table column for the specified checkbox state (checked or unchecked) | DataDictionary |
| File_Field_Current_Description | Returns the description for the current value of a foreign table column as listed in the column's validation table | DataDictionary |
| File_Field_Current_Pointer_Value | Returns a pointer to data in the extended foreign table column object | DataDictionary |
| File_Field_Current_UCAValue | Sets and returns data in the extended table column object using the UChar array type | DataDictionary |
| File_Field_Current_Value | Get/sets the current value of a foreign table column | DataDictionary |
| File_Field_default_Value | Sets the default value of a foreign table column without setting the DDO's Changed_State to True | DataDictionary |
| File_Field_Index | Used to retrieve the index for a table and column | DataDictionary |
| File_Field_Label | Returns the value of the value of the Field_Label_Long or the Field_Label_Short properties, or the tag name of a table column | DataDictionary |
| File_Field_Label_Long | A long description (or translation) of the name of a foreign column for such purposes as form captions | DataDictionary |
| File_Field_Label_Short | A short description (or translation) of the name of a foreign column for such purposes as form captions | DataDictionary |
| File_Field_Mask | Provides the token characters for the mask for a table column | DataDictionary |
| File_Field_Mask_Type | Returns the mask type of the column | DataDictionary |
| File_Field_Option | Gets/sets the state of a field option for a table column | DataDictionary |
| File_Field_Options | Obsolete Sets field options for a table's column | DataDictionary |
| File_Field_Prompt_Object | Gets/sets the ID of the Prompt_Object for a column, such as a lookup (selection) list | DataDictionary |
| File_Field_Select_State | Sets the field's state in the local buffer | DataDictionary |
| File_Field_Status_Help | Gets/Sets status-line help text for the passed table column | DataDictionary |
| File_Field_Table_Object | Returns the object handle of the ValidationTable object for a table column | DataDictionary |
| File_Field_WebPrompt_Object | Gets/sets the ID of the Prompt_Object for a column, such as a lookup (selection) list | DataDictionary |
| File_Field_Zoom_Object | Returns the object handle of the Zoom object for a table column | DataDictionary |
| Foreign_Field_Option | Allows you to assign additional item options to a field when that field is used as a parent field | DataDictionary |
| Foreign_Field_Options | Allows you to assign additional item options to a field type when that field type is used as a parent field | DataDictionary |
| In_Use_State | Determines whether this object has at least one active user-interface object or one of this object's containers is in use | BaseData_Set |
| Key_Field_State | Designates a table column as the primary key column for a table | DataDictionary |
| Key_Value | Returns the complete (all columns) key value for the current record | DataDictionary |
| Main_File | Identifies the table managed by this Data Dictionary class/object | BaseData_Set |
| Name | Returns the full name of the object including parentage | cObject |
| No_Delete_State | Determines whether delete operations via this object are permitted | BaseData_Set |
| No_Relate_State | Determines whether relate operations will be executed after find operations by this object | BaseData_Set |
| Object_Id | Returns the object handle of the object, can be used to determine if an object exists | cObject |
| Object_Label | Returns the short name of an object | cObject |
| Ordering | Specifies the index which should be used for all find operations | BaseData_Set |
| Parent | Returns the parent of an object | cObject |
| Parent_Changed_State | Determines if any of the DD object's parents have been changed by a find operation | BaseData_Set |
| pbApplyGlobalSQLFilters | Determines whether Data Dictionary SQL filters are appended (anded) to the value in the global table filter | DataDictionary |
| pbAutoFillFromFirst | Allows child DDOs to auto-fill from the first record | BaseData_Set |
| pbDDAttach | Detemines if an Attach is limited to the current DDO Structure | BaseData_Set |
| pbForeignReadOnly | Specifies whether this DD ever changes when it is used as a foreign (parent) table | BaseData_Set |
| pbInheritConstraints | Determines if a main DDO should inherit its constraints (finding filters) from its parent DDOs | BaseData_Set |
| pbNoCascadeDeleteStrict | Determines if your DD operates under strict or non-strict rules | BaseData_Set |
| pbSmartRelate | Controls whether DataDictionaries perform relates on parent tables that are not connected to the DDO structure | BaseData_Set |
| pbUseDDRelates | Determines if DD local relates should be used at all | BaseData_Set |
| pbUseDDSQLFilters | Determines whether Data Dictionary SQL filters are used | DataDictionary |
| peNeighborhood | Determines how an object and its descendents participate in object neighborhood referencing | cObject |
| piPrimaryIndex | Defines which index is used to generate the record ID as it is used in WebApp state hashes | DataDictionary |
| Protect_Key_State | Determines whether users are prevented from changing the values of key fields | DataDictionary |
| psSQLFilter | Defines Data Dictionary SQL filter string to be applied | DataDictionary |
| Read_Only_State | Determines whether save or delete operations will occur in this object's main table | BaseData_Set |
| Server_File | Returns the number of the table at the passed in position in this object's server-file list | BaseData_Set |
| Server_File_Count | Returns the number of table in this object's server-file list | BaseData_Set |
| Should_Save | Can be used to determine if a DataDictionary Object (DDO) has changed | BaseData_Set |
| Should_Save_Row | Determines if a DDO is changed according to dbGrid "row" logic | BaseData_Set |
| Smart_Filemode_For_Lock | Determines the locked file mode setting for tables participating in save or delete operations | BaseData_Set |
| Smart_Filemode_For_No_Lock | Determines the unlocked file mode setting for tables that should not participate in save or delete operations | BaseData_Set |
| Smart_Filemode_State | Governs whether this object can use file-locking optimization for its tables | BaseData_Set |
| Status_Help | Gets/Sets status-line help text for the field | DataDictionary |
| System_File_Count | Returns the number of system tables used by the DDO | DataDictionary |
| System_File_Lock_Mode | Returns the lock mode for a system table | DataDictionary |
| System_File_Number | Returns the table number for a system table | DataDictionary |
| Validate_All_Fields_State | Supports Request_Validate_All | DataDictionary |
| Validate_Delete_Structure_Mode | Determines what type of DataDictionary object-structure validation will occur before a delete operation | DataDictionary |
| Validate_DEOs_Only_State | Determines whether validation is limited to fields represented in the current view | DataDictionary |
| Validate_Foreign_File_State | Determines if field validation should be applied to foreign (parent) tables | DataDictionary |
| Validate_Save_Structure_Mode | Determines what type of DataDictionary object structure validation will occur before a save operation | DataDictionary |
| Which_Data_Set | Returns object id of DataDictionary Object owning specified table | BaseData_Set |