Methods for TreeView
View method list in hierarchical order.
| 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 |
| 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 |
| AddTreeItem | Function | Adds an item to a TreeView Used to add an item to a TreeView. | AbstractTreeView |
| Adjust_Logicals | Procedure | Sets the logical coordinates for size and location to the best approximations of the actual physical coordinates of the object | DfBaseWindow |
| 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 |
| 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 |
| ClearAll | Procedure | Clears the tree data using an optimized method Clears the tree data using an optimized method. | TreeView |
| Confirm | Function | Pops up a "Yes/No" confirmation The Confirm function can be used to pop up a "Yes/No" confirmation. | cUIObject |
| 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 |
| 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 |
| 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 |
| 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 |
| DialogToGui | Function | This is used to convert dialog units to gui units. | DfBaseWindow |
| DoCollapseAll | Procedure | Programmatically collapses an item and all its children You can call DoCollapseAll to programmatically collapse an item and all its children. | TreeView |
| DoCollapseItem | Procedure | Programmatically collapses an item You can call DoCollapseItem to programmatically collapse an item. | TreeView |
| DoDeleteItem | Procedure | Deletes an item Send the DoDeleteItem message to delete an item. | AbstractTreeView |
| DoEnumerateTree | Procedure | Recurses the items in the control starting with the item you pass, hItem DoEnumerateTree is an advanced procudure. | AbstractTreeView |
| DoEnumerateTreeUp | Procedure | Recurses the items in the control starting with the item you pass, hItem DoEnumerateTreeUp is an advanced procudure. | AbstractTreeView |
| DoExpandAll | Procedure | Expands an item and all its children You can call DoExpandAll to expand an item and all its children. | TreeView |
| DoExpandItem | Procedure | Expands an item You can call DoExpandItem to expand an item. | TreeView |
| DoMakeItemFirstVisible | Procedure | Forces TreeView to display an item in its visible area and attempts to make it the first visible item | TreeView |
| DoMakeItemVisible | Procedure | Forces TreeView to display an item in its visible area Calling DoMakeItemFirstVisible forces an item to be displayed inside the TreeView control. | TreeView |
| DoReadTree | Procedure | Constructs a simple tree view by loading the values from an external file It is possible to construct a simple display by loading the values from an external file. | TreeView |
| Down | Procedure | Sends the key kdownarrow message to the object The Down message sends the key kdownarrow message to the object. | DfBaseList |
| Enumerate_Fonts | Procedure | Provides a mechanism to obtain a list of all fonts | DfBaseWindow |
| Exit_Application | Procedure | Starts the process of closing an application The Exit_Application message is used to close the program. | cObject |
| Exit_Loss_Confirmation | Function | Pops up a "Yes/No" confirmation for exit loss Prompts: Changes Exist. | cUIObject |
| 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 |
| Help | Procedure | Overridden in the help_system to activate context-sensitive help By default, this message does nothing. | cUIObject |
| 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 |
| InsertTreeItem | Function | Inserts an item in a TreeView Used to insert an item in a TreeView. | AbstractTreeView |
| 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 |
| Item | Procedure Set | cUIObject | |
| ItemExpandedState | Function | Returns whether an item is currently expanded Returns a Boolean value indicating whether an item is currently expanded. | TreeView |
| 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 |
| Line_Width | Procedure Set | DfBaseList | |
| New_Item | Procedure Set | DfBaseList | |
| 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 |
| 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 |
| Ok | Procedure | Used on items and accelerator key definitions to terminate the current level of start_ui or ui_accept | cUIObject |
| 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_Object | Procedure | Adds or removes an object from the focus tree Adds or removes an object from the focus tree. | cUIObject |
| 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 |
| 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 |
| Release_Mouse_Capture | Procedure | Restores normal mouse capture | DfBaseUIWindow |
| Request_Destroy_Object | Procedure | Use the Destroy method instead This method is used to destroy an object and all of its children. | cObject |
| Request_Status_Help | Procedure | Sent when an object is about to take or lose the focus The Request_Status_Help message is sent when an object is about to take or lose the focus. | List |
| 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 |
| 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 |
| 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_Area | Procedure | Moves the focus to the next "area" within a view The Switch_Next_Area navigation message moves the focus to the next "area" within a view. | List |
| 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_Area | Procedure | Moves the focus to the previous "area" within a view The Switch_Prior_Area navigation message moves the focus to the previous "area" within a view. | List |
| 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 |
| Up | Procedure | Sends the key kuparrow to the object The Up message sends the key kuparrow to the object. | DfBaseList |
| 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 |