Skip to content

Methods for dbGrid

View method list in alphabetical order.

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 This is the message that must be used to fill the list of items that appear in the combo form's dropdown list. dbGrid

Inherited Methods from dbGridDD

Name Type Description Defining Class
Activate Procedure Gives an object the focus (and adds it to the focus tree) dbGridDD
Code_Description Function Used to mark an entry_item in a grid as being the validation list description of the previous item dbGridDD
DDFieldRemember Procedure Sets the remember value for the appropriate DD column to this DEO's current value Sets the remember value for the appropriate DD column to this DEO's current value. dbGridDD
DDFieldRememberLast Procedure Set the remember value for the appropriate DD column to whatever is in the DEO at the time that it is cleared dbGridDD
DDFieldUnRemember Procedure Clears the remember value for the appropriate DD column Clears the remember value for the appropriate DD column. dbGridDD
DDRefreshTableStatus Function dbGridDD
Request_ClearBindingTable Procedure Sends clear to the DDO that owns the binding table dbGridDD

Inherited Methods from dbGridDS

Name Type Description Defining Class
Create_Prompt_Button Procedure Creates or removes a prompt button Create_Prompt_Button is used internally to create or remove a prompt button. dbGridDS

Inherited Methods from DataList

Name Type Description Defining Class
DoDisplayCheckBox Procedure Displays the appropriate checkbox bitmap in the passed iItm The DoDisplayCheckbox message 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 The Auto_reorder_list message 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# Col_index 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 Find_Current_Buffer 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 Reorder_list 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 Returns True if Ordering is determined by the control's Server DDO. DataList_
Up_Row Procedure DataList_

Inherited Methods from WideList

Name Type Description Defining Class
Default_Prompt Procedure WideList
Prompt_Description Function 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_
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_

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 Activate_item 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
Column Function Returns the number of the column that is connected to Item Item# Column returns the number of the column that is connected to Item Item#. EntryList
DoadjustGridWidths Procedure Called any time a grid is resized The DoAdjustGridWidths procedure is called any time a grid is resized, passing iGuiDelta as the horizontal difference between the old and new grid size in GUI units. EntryList
DoScrollDown Procedure Emulates pressing a spin button down Sending the DoScrollDown message emulates pressing a spin button down. EntryList
DoScrollUp Procedure Emulates pressing a spin button up Sending the DoScrollUp message 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
Focus Procedure Set EntryList
Prompt Procedure The default message sent by this object's prompt button The Prompt message is the default message sent by this object's prompt button. EntryList
Scroll Procedure Scrolls the item list in the specified direction by the specified number of lines Scroll scrolls the item list in the specified direction by the specified number of lines. 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 This is the message that must be used to fill the list of items that appear in the combo form's dropdown list. DfBaseEntryList
Column_Combo_Delete_Data Procedure Deletes all items from the combo form's dropdown list for a column 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 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 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 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 If the combo form is displayed and changes are made to the dropdown list (e.g. DfBaseEntryList
Column_Combo_Value Function Returns the value of a dropdown list item in the combo form for a column 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 Sending the DoMakeColumnVisible messages ensures that the passed column number is fully visible. DfBaseEntryList

Inherited Methods from DfBaseForm

Name Type Description Defining Class
Copy Procedure Copies the marked block of text to the Clipboard The 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 The 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 The Delete procedure deletes the marked block of text. DfBaseForm
Paste Procedure Copies the contents of the Windows clipboard into the control The Paste procedure copies the entire text contents of the Windows clipboard into the control. DfBaseForm
Select_All Procedure DfBaseForm
SelEnd Function Returns end of selection Returns ending position of selection. DfBaseForm
SelStart Function Returns beginning position of selection Returns beginning position of selection. DfBaseForm
SetSel Procedure Selects text in given position range Selects text in control in given position range. DfBaseForm
Undo Procedure Will undo the last change in the form The 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 Items are added to the end of the object. DfBaseList
Add_Row Procedure Appends all of the items from the hoPrototype to the current object The add_row message is used to append 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 All items in the list are destroyed, and the memory taken up by their data is returned back to the system. DfBaseList
Delete_Item Procedure Deletes the specified item from the list if it exists Delete_Item is used to delete the specified item from the list if it exists. DfBaseList
Down Procedure Sends the key kdownarrow message to the object The Down message sends the key kdownarrow message to the object. DfBaseList
Insert_Item Procedure Inserts an item in a list The 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 DfBaseList
New_Item Procedure Set DfBaseList
Page_Down Procedure Scrolls the data down by the number of items in the display minus one The Page_Down procedure allow the object to scroll 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 The Page_Up procedure allows the object to scroll 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
Sort_Items Procedure Sorts the items in a list in ascending or descending order The items displayed in the list are sorted. DfBaseList
Up Procedure Sends the key kuparrow to the object The Up message 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 DfBaseWindow
External_Message Procedure Set DfBaseWindow
GuiClientSize Function This returns an object's client area size as a folded integer value This returns an object's client area size as a folded 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 This returns an object's window bounding size as a folded value. DfBaseWindow
Windows_Message Procedure Sends a message to the Windows message queue Use of this method requires Windows API knowledge about the message being sent and the control that will process the message. 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 The Activate_scope message is used to activate 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 This message is used to terminate the current level of a start_ui or ui_accept with a return value of msg_cancel. cUIObject
CanCopy Function Determines whether a Copy operation can be successfully completed Determines whether a Copy operation can be successfully completed. cUIObject
CanCut Function Determines whether a Cut operation can be successfully completed Determines whether a Cut operation can be successfully completed. cUIObject
CanDelete Function Determines whether a Delete operation can be successfully completed Determines whether a Delete operation can be successfully completed. cUIObject
CanPaste Function Determines whether a Paste operation can be successfully completed Determines whether a Paste operation can be successfully completed. cUIObject
CanSelect Function Determines whether a Select operation can be successfully completed Determines whether a Select operation can be successfully completed. cUIObject
CanUndo Function Determines whether n Undooperation can be successfully completed Determines whether an Undo operation can be successfully completed. cUIObject
Confirm Function Pops up a "Yes/No" confirmation The Confirm function can be used to pop 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 The Deactivate message removes the object from the focus tree and, if successful, sends the Deactivating message. cUIObject
Default_Key Procedure Used in On_key command to restore standard accelerator for an object The Default_Key message is only used as part of the On_Key command. 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 Prompts: Changes Exist. cUIObject
Help Procedure Overridden in the help_system to activate context-sensitive help By default, this message does nothing. cUIObject
Item Procedure Set 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 Next 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 The No_Confirmation function is used to cancel a confirmation message. cUIObject
None Procedure Does nothing - used by on_key and commands to stop a key assignment This message is always used to make a on_key assignment or an add_item message do nothing. 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 Adds or removes an object from the focus tree. cUIObject
Popup Procedure Activates a modal dialog Popup 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 Previous 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 The 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 The Switch_Next_Scope message 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 The Switch_Prior_Scope message 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 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