MetabaseTreeCombo

Description

The MetabaseTreeCombo class implements the MetabaseTreeCombo development environment component used to display repository object tree as dropdown list.

Properties inherited from IMetabaseTreeCombo

	Property name	Brief description
	CheckedObjects	The CheckedObjects property returns a collection of descriptions for objects, that are checked 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.
	EnableInfotips	Outdated. The EnableInfotips property determines whether the object information is displayed in a tool tip.
	Filters	The Filters property returns a collection of filters used to filter objects displayed in the component.
	Metabase	The Metabase property determines a repository associated with a component.
	Root	The Root property determines the root directory whose contents is displayed in the component.
	SelectedObjects	The SelectedObjects property returns a collection of descriptions for objects selected in the component.
	ShowEmptyFolders	The ShowEmptyFolders property determines whether empty folders are shown in the factors 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.

Properties inherited from ITreeCombo

	Property name	Brief description
	AnimationType	The AnimationType property determines the type of animation used when component tree is expanded.
	AutoUpdateInfo	The AutoUpdateInfo property determines whether the auto update is executed when the data is changed.
	CancelOnEscape	The CancelOnEscape property determines whether selection is cancelled, and the list is closed, when the Escape 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 status of the drop-down list.
	DroppedListHeight	The DroppedListHeight property determines height of the component's drop-down menu.
	DroppedListWidth	The DroppedListWidth property determines width of the component's drop-down menu.
	DroppedPopupMenu	The DroppedPopupMenu property determines context menu which can be opened in the area of the components's drop-down menu.
	FilterStyle	The FilterStyle property determines mode of creating a tree of filtered elements.
	FindEditVisible	The FindEditVisible property determines whether a search string is displayed when the component dropdown list is expanded.
	ShowEditImage	The ShowEditImage property determines whether icon of the element is displayed in the component editor.

Properties inherited from ITreeControl

	Property name	Brief description
	AlwaysSelectFocusedNode	Outdated. Use ITreeControl.SelectionMode.
	AutoCheckParent	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.
	BorderStyle	The BorderStyle property determines the style of the border of the component.
	Checkboxes	The Checkboxes property determines whether check boxes of the component elements are present.
	ColumnClick	The ColumnClick property determines whether it is possible to display the component column headings as buttons.
	Columns	The Columns property returns the collection of columns.
	DropTargetNode	The DropTargetNode property determines the component node, over which a user is currently dragging another node.
	EnableFindDialog	The EnableFindDialog property determines whether the standard element search dialog is to be opened when the CTRL+F key combination or F3 key is pressed.
	FindMode	The FindMode property determines selection mode of found elements.
	FocusedNode	The FocusedNode property determines a node that has focus at the moment.
	GridLines	The GridLines property determines whether grid is displayed.
	HeaderMenu	The HeaderMenu property determines context menu that is called on clicking the additional mouse button on the component column header.
	HideSelection	The HideSelection property determines whether the selection is displayed in the component, when the focus goes to another component.
	HighlightTrack	The HighlightTrack property determines whether the element is highlighted on mouse over.
	HotTrack	The HotTrack property determines whether the elements are underscored on mouse over.
	HotTrackAutoExpand	The HotTrackAutoExpand property determines whether the state of children tree is changed on clicking a selected element.
	Images	The Images property determines list of images displayed next to the elements of component tree.
	InnerRoot	The InnerRoot property returns parameters of the inner root node of the tree.
	Locked	The Locked property determines whether it is possible to change selection and edit elements.
	MultiSelect	Outdated. Use ITreeControl.SelectionMode.
	Nodes	The Nodes property returns the component items collection.
	ReadOnly	The ReadOnly property determines whether the elements are available for editing.
	RowSelect	The RowSelect property determines, whether the whole row should be highlighted, when an element is selected.
	Selected	The Selected property determines the last selected tree element.
	Selection	The Selection property returns selection of the elements tree.
	SelectionMode	The SelectionMode property determines the mode of selecting component elements.
	ShowButtons	The ShowButtons property determines whether hide or show child elements buttons are displayed.
	ShowColumnHeaders	The ShowColumnHeaders property determines, whether column headers are displayed.
	ShowHints	The ShowHints property determines whether hints are displayed when the mouse hovers over elements.
	ShowLines	The ShowLines property determines whether the line that connects the node with its successors should be displayed.
	SortColumn	The SortColumn property determines the index of the column, by which sorting is executed.
	Sorted	The Sorted property determines if the column specified in the SortColumn property can be sorted.
	SortType	The SortType property determines the component sorting type.
	StateImages	The StateImages property checks the list of images used to indicate the condition of component tree elements.

Properties inherited from IControl

	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 that determine the percentage of the size change for the current component when the parent component is resized.
	Brush	The Brush property specifies the brush 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 the background color of a component.
	Cursor	The Cursor property determines how the cursor looks like when you hover over a component during form execution.
	Enabled	The Enabled property determines whether a component is available for a user.
	Focused	The Focused property returns True if the focus is set on the component.
	Font	The Font property defines the parameters of the font used to display text in a component.
	Height	The Height property determines the component height (pixels).
	HelpContext	The HelpContext property determines the unique index for a section of a context help for this component.
	Hint	The Hint property determines the tip text displayed if the mouse pointer is hovered over a component.
	HintTimeout	The HintTimeout determines the time for which the tooltip is displayed.
	Left	The Left property determines the coordinate of the component left edge (pixels).
	Parent	The Parent property determines the 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 should use 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 a component is clicked using the right mouse button.
	Scrolls	The Scrolls property returns parameters of component's scroll bars.
	ShowHint	The ShowHint property determines whether a tool tip should be displayed when you hover over a component.
	TabOrder	The TabOrder property determines the position of a component in a tab order.
	TabStop	The TabStop property determines whether the focus is set to a component when the Tab button is pressed.
	Text	The Text property determines the row identifying a component for a user.
	Top	The Top property determines the coordinate of the component upper edge (pixels).
	Visible	The Visible property determines whether a component is displayed when a form is executed.
	Width	The Width property sets component width in pixels.

Properties inherited from IComponent

	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, the index of which 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.

Methods inherited from IMetabaseTreeCombo

	Method name	Brief description
	FindByDescriptor	The FindByDescriptor method searches for a node in a component tree basing on a repository object description.
	FindItemByKey	The FindItemByKey method searches for a node in a component tree basing 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.

Methods inherited from ITreeCombo

	Method name	Brief description
	DropDown	The DropDown method expands the drop-down menu.
	RollUp	The RollUp method collapses the drop-down menu.
	UpdateInfo	The UpdateInfo method updates data.

Methods inherited from ITreeControl

	Method name	Brief description
	AdjustWidth	The AdjustWidth method is used to automatically fit a column based on its contents.
	GetItemAt	The GetItemAt method allows to get the component element in the specified point.
	HitTest	The HitTest method is an extension of GetItemAt method.
	Sort	The Sort method sorts by the values of the specified column.
	SortDefault	The SortDefault method sorts by the values of column, index of which is specified in the SortColumn property.

Methods inherited from IControl

	Method name	Brief description
	BringToFront	Outdated. The BringToFront method brings a component to the foreground.
	ClientToScreen	The ClientToScreen method converts the coordinates of a point specified relative to the component coordinate system to screen coordinates.
	DoDragDrop	The DoDragDrop method enables to start drag-and-drop operation.
	GetImage	The GetImage method returns a graphic presentation of a component together with all children.
	ScreenToClient	The ScreenToClient method converts screen coordinates of a point to coordinates specified relative to the component coordinate system.
	SendToBack	Outdated. The SendToBack method is used to send a component to the background.
	SetFocus	The SetFocus method sets focus to this component.

Events

	Event name	Brief description
	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.

Events inherited from TreeCombo

	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.

Events inherited from ITreeControl

	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 during comparing two elements during the 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 entry.
	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 when a hint appears over the element, over which the mouse cursor is located.
	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 when the componen element selection is changed.
	OnUnselected	The OnUnselected event occurs after deselecting a node.
	OnUnselecting	The OnUnselecting event occurs before deselecting an element.

Events inherited from IControl

	Event name	Brief description
	OnBeginDrag	The OnBeginDrag event occurs for a component, when a user starts to drag an object from the component.
	OnClick	The OnClick event occurs if a user clicks a component area using the main mouse button.
	OnControlMove	The OnControlMove event occurs when a component is moved.
	OnControlResize	The OnControlResize event occurs when a component is resized.
	OnDblClick	The OnDblClick event occurs if a user double-clicks a component area using the mouse button.
	OnDragDrop	The OnDragDrop event occurs for a component if a user drops a dragged object over it.
	OnDragEnter	The OnDragEnter event occurs when a dragged object crosses the borders of this component.
	OnDragLeave	The OnDragLeave event occurs when a dragged object leaves the borders of this component.
	OnDragOver	The OnDragOver event occurs for this component when a user drags a dragged object over it.
	OnEnter	The OnEnter event occurs when a component receives focus.
	OnExit	The OnExit event occurs when a component loses focus.
	OnHScroll	The OnHScroll event occurs when the horizontal scrollbar thumb changes its position.
	OnKeyDown	The OnKeyDown event occurs if a component is focused and a keyboard key is pressed.
	OnKeyPress	The OnKeyPress event occurs if a component is focused when a user presses a character key.
	OnKeyPreview	The OnKeyPreview event occurs prior to each event requiring clicking.
	OnKeyUp	The OnKeyUp event occurs if a component is focused and a user releases any button previously pressed.
	OnMouseDown	The OnMouseDown event occurs if the pointer is in component's area and a mouse key is pressed.
	OnMouseEnter	The OnMouseEnter event occurs when mouse cursor enters the component area.
	OnMouseHover	The OnMouseHover event occurs when the mouse cursor is held in the component area.
	OnMouseLeave	The OnMouseLeave event occurs when mouse cursor leaves the component area.
	OnMouseMove	The OnMouseMove event occurs on moving the cursor over component.
	OnMouseUp	The OnMouseUp event occurs on releasing mouse button when the pointer is in component area.
	OnMouseWheel	The OnMouseWheel event occurs if the component has focus when the mouse wheel is rotated.
	OnVScroll	The OnVScroll event occurs when the vertical scrollbar thumb changes its position.

See also:

ExtCtrls Assembly Classes