Methods for DataList
View method list in alphabetical order.
| Name | Type | Description | Defining Class |
|---|---|---|---|
| DoDisplayCheckBox | Procedure | Displays the appropriate checkbox bitmap in the passed iItm | DataList |
Inherited Methods from DataList_
| Name | Type | Description | Defining Class |
|---|---|---|---|
| Auto_Reorder_List | Procedure | Permits automatic reordering of the contents of the data list | DataList_ |
| Beginning_of_Data | Procedure | Finds the first record in the main_file of this object, and fills the display, starting with that record if the find operation was successful | DataList_ |
| Clear_Current_Record | Procedure | DataList_ | |
| Col_Index | Function | Returns the number of the main index for the field connected to Column Item# | DataList_ |
| Display | Procedure | DataList_ | |
| DoCheckDisplayableRows | Procedure | DataList_ | |
| DoSetOrderingDirection | Procedure | Sets the reverse ordering property (pbReverseOrdering) and visually reverses the order of an active non-batch dbGrid or dbList | DataList_ |
| DoToggleColumnOrdering | Procedure | DataList_ | |
| End_of_Data | Procedure | Finds the last record in the main_file of this object, and displays a new list page ending with that record if the find was successful | DataList_ |
| Establish_Find_Mode | Procedure | DataList_ | |
| File_Record | Function | DataList_ | |
| FileRecord | Function | DataList_ | |
| FileRowId | Function | DataList_ | |
| Fill_List | Procedure | DataList_ | |
| Find_Current_Buffer | Procedure | Finds the record in the main file whose data are in the buffer | DataList_ |
| Find_Init | Procedure | Initializes a list for a Find in a direction (up or down), reads the record, and prepares for the next Find_Next operation | DataList_ |
| Find_Record | Procedure | Finds the record identified by the given rec_number in the main_file of this object | DataList_ |
| Find_RowId | Procedure | DataList_ | |
| Goto_Bottom_Row | Procedure | DataList_ | |
| Goto_Top_Row | Procedure | DataList_ | |
| Move_to_Column | Procedure | Moves the cursor to the column whose number is in Col#, keeping it in the same row as it started out in | DataList_ |
| Read_By_Recnum | Procedure | DataList_ | |
| Read_Next_Record | Procedure | DataList_ | |
| ReadByRowId | Procedure | DataList_ | |
| Refresh_Page | Procedure | Displays list page, with the currently active record at Row Row#, using the index for Column Col# | DataList_ |
| Reorder_list | Procedure | Permits manual reordering of the contents of the data list | DataList_ |
| Request_New_Index | Procedure | Changes the index by which the list is sorted to any index that exists in the main file without changing the current record or column | DataList_ |
| ServerOrderingOverride | Function | Determines whether the control will use its Server DDO's Ordering or its own | DataList_ |
| Up_Row | Procedure | DataList_ |
Inherited Methods from WideList
| Name | Type | Description | Defining Class |
|---|---|---|---|
| Close_Panel | Procedure | Closes the panel or component currently open | WideList |
| Default_Prompt | Procedure | WideList | |
| Prompt_Description | Function | WideList | |
| Prompt_Description | Procedure | WideList | |
| Validate_Prompt | Function | WideList |
Inherited Methods from WideList_
| Name | Type | Description | Defining Class |
|---|---|---|---|
| Down | Procedure | WideList_ | |
| Down_Row | Procedure | Changes the current item to the next row, if any, at the same item relative to the beginning of the row | WideList_ |
| Exec_Entry | Function | Invokes the item_entry_msg of the specified item#, if any, and returns the result | WideList_ |
| Exec_Exit | Function | Invokes the item_exit_msg of the specified item#, if any, and returns the result | WideList_ |
| Exec_Validate | Function | Invokes the item_validate_msg of the specified item#, if any, and returns the result | WideList_ |
| Exit_Function | Procedure | Causes deactivation of this object's parent view or dialog | WideList_ |
| Prompt | Procedure | Pops up Prompt_Object of current object or column, or can be overwritten | WideList_ |
| Request_Cancel | Procedure | Deactivates DEO views or dialogs | WideList_ |
| Up | Procedure | WideList_ | |
| Up_Row | Procedure | Changes the current item to the prior row, if any, at the same item relative to the beginning of the row | WideList_ |
| Verify_Exit | Function | The Verify_Exit message searches through parent DEOs looking for a non-zero Verify_Exit_Msg | WideList_ |
| Zoom | Procedure | Activates zoom object of current item, if any, using popup message | WideList_ |
Inherited Methods from EntryList
| Name | Type | Description | Defining Class |
|---|---|---|---|
| Activate_Column | Procedure | Attempts to activate the object making the passed Item# in the current row the current_item | EntryList |
| Activate_Item | Procedure | Activates this object with Item Item# as the current_item | EntryList |
| Beginning_of_Data | Procedure | Causes the grid's current item to be set to the current column of the first row | EntryList |
| Beginning_of_Panel | Procedure | Gives the focus to the first item in the first object in the current parent-child hierarchy | EntryList |
| Bottom_of_Panel | Procedure | Activates the last child object of this object that is a DEO, if any | EntryList |
| Column | Function | Returns the number of the column that is connected to Item Item# | EntryList |
| Currency_Mask | Procedure Set | Provides an easy method for creating a currency mask | EntryList |
| DoadjustGridWidths | Procedure | Called any time a grid is resized | EntryList |
| DoHtmlHelp | Procedure | Launches Compiled HTML Help | EntryList |
| DoScrollDown | Procedure | Emulates pressing a spin button down | EntryList |
| DoScrollUp | Procedure | Emulates pressing a spin button up | EntryList |
| End_of_Data | Procedure | Causes the grid's current item to be set to the current column of the last row | EntryList |
| End_of_Panel | Procedure | Gives the focus to the last item in the last object in the current parent-child hierarchy | EntryList |
| Error_Help | Procedure | EntryList | |
| Extended_Help | Procedure | EntryList | |
| File_Help | Procedure | EntryList | |
| Focus | Procedure Set | EntryList | |
| Help | Procedure | Requests Help. Usually invoked by pressing F1 or pressing a Button that sends this message | EntryList |
| Help_Datafile | Function | Returns the filename and fieldname in file.field format that contains help for the current item | EntryList |
| Help_For_Help | Procedure | EntryList | |
| Help_Index | Procedure | EntryList | |
| Help_on_Topic | Procedure | EntryList | |
| Keys_Help | Procedure | EntryList | |
| Next_Object_Id | Function | Called by the switch message to determine the object_id of the next object to go to in the focus tree | EntryList |
| Numeric_Mask | Procedure Set | Provides an easy method for creating a numeric mask | EntryList |
| Prior_Object_Id | Function | Called by the switch_back message to determine the object_id of the previous object to go to in the focus tree | EntryList |
| Prompt | Procedure | The default message sent by this object's prompt button | EntryList |
| Request_Status_Help | Procedure | EntryList | |
| Scroll | Procedure | Scrolls the item list in the specified direction by the specified number of lines | EntryList |
| Switch_Next_Area | Procedure | Moves the focus to the next "area" within a view | EntryList |
| Switch_Prior_Area | Procedure | Moves the focus to the previous "area" within a view | EntryList |
| Top_of_Panel | Procedure | Activates the first child object of this object that is a DEO, if any; else activates this object | EntryList |
Inherited Methods from DfBaseEntryList
| Name | Type | Description | Defining Class |
|---|---|---|---|
| Column_Combo_Add_Item | Procedure | Adds an item to the end of the combo form's dropdown list for a column | DfBaseEntryList |
| Column_Combo_Delete_Data | Procedure | Deletes all items from the combo form's dropdown list for a column | DfBaseEntryList |
| Column_Combo_Delete_Item | Procedure | Deletes an item from the combo form's dropdown list for a column | DfBaseEntryList |
| Column_Combo_Find | Function | Searches for an item in the dropdown list of a combo form for a column by value | DfBaseEntryList |
| Column_Combo_Item_Count | Function | Returns number of items in the combo form's dropdown list for a column | DfBaseEntryList |
| Column_Combo_Refresh | Procedure | Forces a refresh for the combo form of a column | DfBaseEntryList |
| Column_Combo_Value | Function | Returns the value of a dropdown list item in the combo form for a column | DfBaseEntryList |
| DoMakeColumnVisible | Procedure | Ensures that the passed column number is fully visible | DfBaseEntryList |
Inherited Methods from DfBaseEntry
| Name | Type | Description | Defining Class |
|---|---|---|---|
| Entry_Autofind | Procedure | Sent when an item with an autofind or autofind_ge option is exited after a change has been made to the data in the window | DfBaseEntry |
| Entry_Clear | Procedure | Clears all data-entry windows that are not controlled by a retain or retainall | DfBaseEntry |
| Entry_Clear_All | Procedure | Clears all data entry windows that are not marked as retainall | DfBaseEntry |
| Entry_Display | Procedure | Displays data from the data_file and data_field to every entry_item connected to it | DfBaseEntry |
| Entry_Update | Procedure | Moves data from all DEOs whose Data_File is passed and with Changed_State of True, to the global record buffer of the passed table | DfBaseEntry |
| Validate_Items | Function | Validates all items and sends each entry_item's Item_Validate_msg | DfBaseEntry |
Inherited Methods from DfBaseForm
| Name | Type | Description | Defining Class |
|---|---|---|---|
| Copy | Procedure | Copies the marked block of text to the Clipboard | DfBaseForm |
| Cut | Procedure | Copies the marked block of text to the Clipboard and deletes it from this object | DfBaseForm |
| Delete | Procedure | Deletes the marked block of text | DfBaseForm |
| Paste | Procedure | Copies the contents of the Windows clipboard into the control | DfBaseForm |
| Select_All | Procedure | DfBaseForm | |
| SelEnd | Function | Returns end of selection | DfBaseForm |
| SelStart | Function | Returns beginning position of selection | DfBaseForm |
| SetSel | Procedure | Selects text in given position range | DfBaseForm |
| Undo | Procedure | Will undo the last change in the form | DfBaseForm |
Inherited Methods from DfBaseList
| Name | Type | Description | Defining Class |
|---|---|---|---|
| Add_Item | Procedure | Adds an item to the end of a list | DfBaseList |
| Add_Row | Procedure | Appends all of the items from the hoPrototype to the current object | DfBaseList |
| Delete_Data | Procedure | Painted to update the screen after all items in the list are destroyed | DfBaseList |
| Delete_Item | Procedure | Deletes the specified item from the list if it exists | DfBaseList |
| Down | Procedure | Sends the key kdownarrow message to the object | DfBaseList |
| Insert_Item | Procedure | Inserts an item in a list | DfBaseList |
| Insert_Row | Procedure | Used by dbGrid-class objects to insert prototype rows in the grid at the specified row number | DfBaseList |
| Line_Width | Procedure Set | Specifies the number of columns and displayable rows in a list | DfBaseList |
| New_Item | Procedure Set | Sets the current_item without triggering the code that may be associated with item_change | DfBaseList |
| Page_Down | Procedure | Scrolls the data down by the number of items in the display minus one | DfBaseList |
| Page_Up | Procedure | Scrolls the data up by the number of items in the display minus one | DfBaseList |
| Scroll | Procedure | Causes the contents of the object display window to scroll in given direction | DfBaseList |
| Select_Count | Procedure Set | DfBaseList | |
| Sort_Items | Procedure | Sorts the items in a list in ascending or descending order | DfBaseList |
| Up | Procedure | Sends the key kuparrow to the object | DfBaseList |
Inherited Methods from DfBaseUIWindow
| Name | Type | Description | Defining Class |
|---|---|---|---|
| Release_Mouse_Capture | Procedure | Restores normal mouse capture | DfBaseUIWindow |
Inherited Methods from DfBaseWindow
| Name | Type | Description | Defining Class |
|---|---|---|---|
| Adjust_Logicals | Procedure | Sets the logical coordinates for size and location to the best approximations of the actual physical coordinates of the object | DfBaseWindow |
| DialogToGui | Function | This is used to convert dialog units to gui units. | DfBaseWindow |
| Enumerate_Fonts | Procedure | Provides a mechanism to obtain a list of all fonts | DfBaseWindow |
| External_Class_Name | Procedure Set | Used to "wrap" a windows control inside of a DataFlex class | DfBaseWindow |
| External_Message | Procedure Set | Assigns Windows messages to DataFlex messages | DfBaseWindow |
| GuiClientSize | Function | This returns an object's client area size as a folded integer value | DfBaseWindow |
| GuiToDialog | Function | This is used to convert gui units to dialog units. | DfBaseWindow |
| GuiWindowSize | Function | This returns an object's outer window bounding size as a folded value | DfBaseWindow |
| Windows_Message | Procedure | Sends a message to the Windows message queue | DfBaseWindow |
Inherited Methods from cUIObject
| Name | Type | Description | Defining Class |
|---|---|---|---|
| Activate | Procedure | Gives an object the focus (and adds it to the focus tree) | cUIObject |
| Activate_Scope | Procedure | Activates objects that are separate tools to the application | cUIObject |
| Add_Focus | Procedure | Adds the object into the focus tree at the Next_Level of the hoParent in the focus tree | cUIObject |
| Bell | Procedure | Rings the PC bell | cUIObject |
| Cancel | Procedure | Used to terminate the current level of a start_ui or ui_accept | cUIObject |
| CanCopy | Function | Determines whether a Copy operation can be successfully completed | cUIObject |
| CanCut | Function | Determines whether a Cut operation can be successfully completed | cUIObject |
| CanDelete | Function | Determines whether a Delete operation can be successfully completed | cUIObject |
| CanPaste | Function | Determines whether a Paste operation can be successfully completed | cUIObject |
| CanSelect | Function | Determines whether a Select operation can be successfully completed | cUIObject |
| CanUndo | Function | Determines whether n Undooperation can be successfully completed | cUIObject |
| Confirm | Function | Pops up a "Yes/No" confirmation | cUIObject |
| Data_Loss_Confirmation | Function | Pops up a "Yes/No" confirmation for data loss | cUIObject |
| Deactivate | Procedure | Removes the object from the focus tree | cUIObject |
| Default_Key | Procedure | Used in On_key command to restore standard accelerator for an object | cUIObject |
| Delete_Confirmation | Function | Pops up a "Yes/No" confirmation for a delete | cUIObject |
| Exit_Loss_Confirmation | Function | Pops up a "Yes/No" confirmation for exit loss | cUIObject |
| Help | Procedure | Overridden in the help_system to activate context-sensitive help | cUIObject |
| Item | Procedure Set | Changes the current item to the first or last data item (depending on the value of last) in the displayed range of items | cUIObject |
| Line_Delete_Confirmation | Function | Pops up a "Yes/No" confirmation for a line delete | cUIObject |
| Line_Save_Confirmation | Function | Pops up a "Yes/No" confirmation for a line save | cUIObject |
| Next | Procedure | Moves the focus to the next object in the tab order when the Tab key is pressed | cUIObject |
| Next_Object_Id | Function | Called by the switch message to determine the object_id of the next object to go to in the focus tree | cUIObject |
| No_Confirmation | Function | Used to cancel a confirmation message | cUIObject |
| None | Procedure | Does nothing - used by on_key and commands to stop a key assignment | cUIObject |
| Ok | Procedure | Used on items and accelerator key definitions to terminate the current level of start_ui or ui_accept | cUIObject |
| Page_Object | Procedure | Adds or removes an object from the focus tree | cUIObject |
| Popup | Procedure | Activates a modal dialog | cUIObject |
| Previous | Procedure | Moves the focus to the previous object in the tab order when the Shift+Tab key is pressed | cUIObject |
| Prior_Object_Id | Function | Called by the switch_back message to determine the object_id of the previous object to go to in the focus tree | cUIObject |
| Save_Confirmation | Function | Pops up a "Yes/No" confirmation for a save | cUIObject |
| Stop_UI | Procedure | Terminates a popup_modal message and returns execution to the next line after the one on which this message was sent | cUIObject |
| Switch | Procedure | Moves the focus to the object returned by the next_object_id function | cUIObject |
| Switch_Back | Procedure | Moves the focus to the object returned by the prior_object_id function | cUIObject |
| Switch_Next_Group | Procedure | Moves the focus to the first object in the next_level of the next_object of the prior_level of this object | cUIObject |
| Switch_Next_Scope | Procedure | Moves the focus to the scope focus of the next scope | cUIObject |
| Switch_Prior_Group | Procedure | Moves the focus to the last object in the prior_level of the prior_object of the next_level of this object | cUIObject |
| Switch_Prior_Scope | Procedure | Moves the focus to the scope focus of the prior_scope | cUIObject |
Inherited Methods from cObject
| Name | Type | Description | Defining Class |
|---|---|---|---|
| ChildByIndex | Function | Can be used to iterate the direct children of an object | cObject |
| ClassSuperClass | Function | Returns the superclass of the passed class | cObject |
| Create | Function | Creates an object based on the passed Class Id | cObject |
| CreateNamed | Function | 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 | cObject |
| Exit_Application | Procedure | Starts the process of closing an application | 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 | cObject |
| ObjectClass | Function | Returns the integer class ID assigned to the class this object is based on | cObject |
| Request_Destroy_Object | Procedure | Use the Destroy method instead | cObject |