The MetabaseTreeCombo class implements the MetabaseTreeCombo development environment component that is used to display repository object tree as a drop-down list.
Property name | Brief description | |
CheckedObjects | The CheckedObjects property returns the collection of descriptions for objects, which checkboxes are selected in the component. | |
DelayedFill | The DelayedFill property determines how an object tree is built in a component. | |
DisplayMode | The DisplayMode property determines how objects are displayed in a component tree. | |
Filters | The Filters property returns the collection of filters used to filter objects displayed in the component. | |
Metabase | The Metabase property determines a repository associated with the component. | |
Root | The Root property determines the root directory, which contents is displayed in the component. | |
SelectedObjects | The SelectedObjects property returns the collection of descriptions for objects selected in the component. | |
ShowEmptyFolders | The ShowEmptyFolders property determines whether empty folders are shown in the indicators tree. | |
ShowInternalObjects | The ShowInternalObjects property determines whether internal objects are displayed in the repository object tree. | |
ShowShortCuts | The ShowShortCuts property determines whether labels are displayed in the component element tree. |
Property name | Brief description | |
AnimationType | The AnimationType property determines the type of animation used when the component tree is expanded. | |
AutoUpdateInfo | The AutoUpdateInfo property determines whether the automatic refresh is executed when the data is changed. | |
CancelOnEscape | The CancelOnEscape property determines whether selection is canceled, and the list is closed when the ESC key is pressed. | |
CloseOnEnter | The CloseOnEnter property determines whether the list is closed, and the selection is saved when the ENTER key is pressed. | |
Dropped | The Dropped property returns the visibility of the drop-down list. | |
DroppedListHeight | The DroppedListHeight property determines height of the component drop-down list. | |
DroppedListWidth | The DroppedListWidth property determines width of the component drop-down list. | |
DroppedPopupMenu | The DroppedPopupMenu property determines the context menu called in the area of the components drop-down list. | |
FilterStyle | The FilterStyle property determines a mode of creating a tree of filtered elements. | |
FindEditVisible | The FindEditVisible property determines whether a search field is displayed when the component drop-down list is expanded. | |
ShowEditImage | The ShowEditImage property determines whether element icon is displayed in the component editor. |
Property name | Brief description | |
The AutoCheckParent property determines whether the parent nodes of the component automatically receive an indefinite state, if not all of the child elements are selected. | ||
The BorderStyle property determines a component border style. | ||
The Checkboxes property determines whether elements have checkboxes. | ||
The ColumnClick property determines whether component column headers can be displayed as buttons. | ||
The Columns property returns the collection of columns. | ||
The DropTargetNode property determines the component node, over which the user is currently dragging another node. | ||
The EnableFindDialog property determines whether the standard element search dialog is called when the CTRL+F key combination or F3 key is pressed. | ||
The FindMode property determines selection mode of found elements. | ||
The FocusedNode property determines a node that has focus at the moment. | ||
The GridLines property determines whether grid is displayed. | ||
The HeaderMenu property determines the context menu called on clicking the additional mouse button on the component column header. | ||
The HideSelection property determines whether the selection is displayed in the component when the focus goes to another component. | ||
The HighlightTrack property determines whether the element is highlighted on mouseover. | ||
The HotTrack property determines whether the elements are underlined on mouseover. | ||
The HotTrackAutoExpand property determines whether the state of children tree is changed on clicking a selected element. | ||
The Images property determines list of images displayed next to the elements of component tree. | ||
The InnerRoot property returns parameters of the inner root node of the tree. | ||
The Locked property determines whether it is possible to change selection and edit elements. | ||
The Nodes property returns the component elements collection. | ||
The ReadOnly property determines whether the elements are available for editing. | ||
The RowSelect property determines whether the whole row is highlighted when an element is selected. | ||
The Selected property determines the last selected tree element. | ||
The Selection property returns selection of the elements tree. | ||
The SelectionMode property determines the mode of selecting component elements. | ||
The ShowButtons property determines whether hide or show child elements buttons are displayed. | ||
The ShowColumnHeaders property determines whether column headers are displayed. | ||
The ShowHints property determines whether tooltips are displayed when the mouse hovers over elements. | ||
The ShowLines property determines whether the line that connects the node with its children is displayed. | ||
The SortColumn property determines the index of the column, by which sorting is executed. | ||
The Sorted property determines if the column specified in the SortColumn property can be sorted. | ||
The SortType property determines the component sorting type. | ||
The StateImages property checks the list of images that are used to indicate the state of component tree elements. |
Property name | Brief description | |
Align | The Align property determines component alignment within its parent component. | |
AllowDrag | The AllowDrag property determines whether an object can be dragged from a component. | |
AllowDrop | The AllowDrop property determines whether the component can accept a dragged object. | |
Anchors | The Anchors property returns settings determining % of the resize for the current component when the parent component is resized. | |
Brush | The Brush property determines the brush that is used to fill the component area. | |
ClientHeight | The ClientHeight property determines the height of the client component area. | |
ClientWidth | The ClientWidth property determines the width of the client component area. | |
Color | The Color property determines color of the component background. | |
Cursor | The Cursor property determines how the cursor looks like when is it hovered over a component during form execution. | |
Enabled | The Enabled property determines whether a component is available for the user. | |
Focused | The Focused property returns True if the focus is set to the component. | |
Font | The Font property determines parameters of the font that is used to display text in the component. | |
Height | The Height property determines component height in pixels. | |
HelpContext | The HelpContext property determines a unique index for a section of a context help for this component. | |
Hint | The Hint property determines a tooltip text displayed on hovering over the component. | |
HintTimeout | The HintTimeout property determines for how long a tooltip is displayed. | |
Left | The Left property determines a coordinate of the component left edge in pixels. | |
Parent | The Parent property determines a parent component. | |
ParentColor | The ParentColor property determines whether a component inherits the color of the parent component. | |
ParentFont | The ParentFont property determines whether a component uses the font of the parent component. | |
ParentShowHint | The ParentShowHint property determines when a tooltip is displayed. | |
PopupMenu | The PopupMenu property determines the context menu displayed when the component is clicked with the right mouse button. | |
Scrolls | The Scrolls property returns parameters of component's scrollbars. | |
ShowHint | The ShowHint property determines whether a tooltip is displayed when the component is hovered. | |
TabOrder | The TabOrder property determines a component position in a tab order. | |
TabStop | The TabStop property determines whether the component must be focused when the Tab button is pressed. | |
Text | The Text property determines a row identifying a component for the user. | |
Top | The Top property determines a coordinate of the component top edge in pixels. | |
Visible | The Visible property determines whether the component is displayed when a form is executed. | |
Width | The Width property sets component width in pixels. |
Property name | Brief description | |
ComponentCount | The ComponentCount property returns the number of child components located on the parent component. | |
Components | The Components property returns a child component, which index is passed via the input parameter. | |
Data | The Data property is used to store any custom data. | |
Name | The Name property determines the component name. | |
Tag | The Tag property is not used by the compiler. The user can change the value of this property and use it at his discretion. |
Method name | Brief description | |
FindByDescriptor | The FindByDescriptor method searches for a node in the component tree based on repository object description. | |
FindItemByKey | The FindItemByKey method searches for a node in the component tree based on a repository object key. | |
GetItemObject | The GetItemObject method returns description of the repository object corresponding to the specified tree node. | |
SelectElem | The SelectElem method selects the tree node corresponding to the specified repository object. | |
SelectElemKey | The SelectElemKey method selects the tree node corresponding to a repository object with the specified key. |
Method name | Brief description | |
DropDown | The DropDown method expands the combobox. | |
RollUp | The RollUp method collapses the combobox. | |
UpdateInfo | The UpdateInfo method updates data about the element selection displayed in the component editor. |
Method name | Brief description | |
AdjustWidth | The AdjustWidth method adjusts automatically width of the column taking into account its contents. | |
GetItemAt | The GetItemAt method allows to get the component element in the specified point. | |
HitTest | The HitTest method is an extension of the GetItemAt method. | |
Sort | The Sort method sorts by the values of the specified column. | |
SortDefault | The SortDefault method sorts by the values of column, which index is specified in the SortColumn property. |
Method name | Brief description | |
The ClientToScreen method converts point coordinates specified relative to the component's coordinate system into screen coordinates. | ||
The DoDragDrop method enables the user to start dragging operation. | ||
The GetImage method returns a graphic presentation of a component together with all child components. | ||
The ScreenToClient method converts point's screen coordinates into coordinates specified relative to the component's coordinate system. | ||
The SetFocus method sets focus to this component. |
Event name | Brief description | |
OnCheckToAddElem | The OnCheckToAddElem event occurs in adding elements to tree. | |
OnGetElementPopup | The OnGetElementPopup event occurs on opening the context menu for a tree element. | |
OnIsBrowseableElem | The OnIsBrowseableElem event is used to set whether an element is displayed in a tree. | |
OnIsDynamicElem | The OnIsDynamicElem event is used to set whether a tree of folder child elements is dynamically built. | |
OnIsEmptyFolder | The OnIsEmptyFolder event is used to set whether a folder is empty. | |
OnIsFolderElem | The OnIsFolderElem event is used to set whether elements displayed in the component tree are set as folders. |
Event name | Brief description | |
OnBeginFilter | The OnBeginFilter event occurs at the start of filtering of component elements list. | |
OnDropDown | The OnDropDown event occurs on expanding the component list. | |
OnFilter | The OnFilter event occurs after the list of components is filtered. | |
OnRollUp | The OnRollUp event occurs on collapsing the component list. |
Event name | Brief description | |
OnBeginSearch |
The OnBeginSearch event occurs when elements are started to be searched in the component. | |
OnAdded |
The OnAdded event occurs when a new element is added. | |
OnChecked |
The OnChecked event occurs when the element check box is selected. | |
OnChecking |
The OnChecking event occurs when the element check box is selected. | |
OnCollapsed |
The OnCollapsed event occurs after collapsing the hierarchy of the tree node children. | |
OnCollapsing |
The OnCollapsing event occurs before the collapsing of the hierarchy of the tree node children. | |
OnColumnClick |
The OnColumnClick event occurs on mouse click on the component column header. | |
OnCompareItems |
The OnCompareItems event occurs on comparing two elements during user element sorting. | |
OnDeleting |
The OnDeleting event occurs, when the element is deleted. | |
OnEdited |
The OnEdited event occurs on exiting the mode of editing the contents of the component current record field. | |
OnEditing |
The OnEditing event occurs when changing to the mode for editing the field contents of the current component record. | |
OnExpanded |
The OnExpanded event occurs after expanding the hierarchy of tree node children. | |
OnExpanding |
The OnExpanding event occurs directly before expanding the tree node children hierarchy. | |
OnFocusedChanged |
The OnFocusedChanged event occurs on moving the focus to another component element. | |
OnFocusedChanging |
The OnFocusedChanged event occurs when the focus is moved to another component element. | |
OnGetHint |
The OnGetHint event occurs on appearing a tooltip over the element, over which the mouse cursor is hovered. | |
OnGetNodeImage |
The OnGetNodeImage event occurs on getting an image near the tree node. | |
OnGetNodeStateImage |
The OnGetNodeStateImage event occurs on getting the status images near the tree element. | |
OnHover |
The OnHover event occurs on hovering over the element with mouse and underline it. | |
OnSearch |
The OnSearch event occurs after the element search in the component is finished. | |
OnSelected |
The OnSelected event occurs after selecting a node. | |
OnSelecting |
The OnSelecting event occurs before selecting a node. | |
OnSelectionChanged |
The OnSelectionChanged event occurs on changing the selection of the component element. | |
OnUnselected |
The OnUnselected event occurs after deselecting a node. | |
OnUnselecting |
The OnUnselecting event occurs before deselecting an element. |
Event name | Brief description | |
The OnBeginDrag event occurs for the component when the user starts to drag an object from the component. | ||
The OnClick event occurs if the user clicks the component area. | ||
The OnControlMove event occurs when the component is moved. | ||
The OnControlResize event occurs when the component is resized. | ||
The OnDblClick event occurs if the user double-clicks the component area. | ||
The OnDragDrop event occurs for the component if the user drops a dragged object over it. | ||
The OnDragEnter event occurs when a dragged object enters the component area. | ||
The OnDragLeave event occurs when a dragged object leaves component borders. | ||
The OnDragOver event occurs for the component when the user drags an object over it. | ||
The OnEnter event occurs when the component receives focus. | ||
The OnExit event occurs when the component loses focus. | ||
The OnHScroll event occurs when horizontal scrollbar slider changes its position. | ||
The OnKeyDown event occurs if the component is focused and a keyboard key is pressed. | ||
The OnKeyPress event occurs if the component is focused when the user presses a character key. | ||
The OnKeyPreview event occurs prior to each event related to key pressing. | ||
The OnKeyUp event occurs if the component is focused and the user releases any button previously pressed. | ||
The OnMouseDown event occurs if the pointer is in the component area and a mouse key is pressed. | ||
The OnMouseEnter event occurs when mouse cursor enters the component area. | ||
The OnMouseHover event occurs when mouse cursor is held in the component area. | ||
The OnMouseLeave event occurs when mouse cursor leaves the component area. | ||
The OnMouseMove event occurs when the cursor is moved over the component. | ||
The OnMouseUp event occurs when the mouse button is released and the cursor is in the component area. | ||
The OnMouseWheel event occurs if the component is focused when the user rotates a mouse wheel. | ||
The OnVScroll event occurs when vertical scrollbar slider changes its position. |
See also: