MetabaseTreeList: Class

The MetabaseTreeList class implements the MetabaseTreeList development environment component that is used to display repository object tree.

Properties inherited from IMetabaseTreeList

	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 the component.
	DisplayMode	The DisplayMode property determines how objects are displayed in a component tree.
	Filters	The Filters property returns the collection of filters that are 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.

Properties inherited from ITreeControl

	Property name	Brief description
	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 a component border style.
	Checkboxes	The Checkboxes property determines whether elements have checkboxes.
	ColumnClick	The ColumnClick property determines whether component column headers can be displayed as buttons.
	Columns	The Columns property returns the collection of columns.
	DropTargetNode	The DropTargetNode property determines the component node, over which the user is currently dragging another node.
	EnableFindDialog	The EnableFindDialog property determines whether the standard element search dialog is called 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 the context menu 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 mouseover.
	HotTrack	The HotTrack property determines whether the elements are underlined on mouseover.
	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.
	Nodes	The Nodes property returns the component elements collection.
	ReadOnly	The ReadOnly property determines whether the elements are available for editing.
	RowSelect	The RowSelect property determines whether the whole row is 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 tooltips are displayed when the mouse hovers over elements.
	ShowLines	The ShowLines property determines whether the line that connects the node with its children is 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 that are used to indicate the state 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 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.

Properties inherited from IComponent

Methods inherited from IMetabaseTreeList

Methods inherited from ITreeList

Methods inherited from ITreeControl

Methods inherited from IControl

Events

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 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.

Events inherited from IControl

	Event name	Brief description
	OnBeginDrag	The OnBeginDrag event occurs for the component when the user starts to drag an object from the component.
	OnClick	The OnClick event occurs if the user clicks the component area.
	OnControlMove	The OnControlMove event occurs when the component is moved.
	OnControlResize	The OnControlResize event occurs when the component is resized.
	OnDblClick	The OnDblClick event occurs if the user double-clicks the component area.
	OnDragDrop	The OnDragDrop event occurs for the component if the user drops a dragged object over it.
	OnDragEnter	The OnDragEnter event occurs when a dragged object enters the component area.
	OnDragLeave	The OnDragLeave event occurs when a dragged object leaves component borders.
	OnDragOver	The OnDragOver event occurs for the component when the user drags an object over it.
	OnEnter	The OnEnter event occurs when the component receives focus.
	OnExit	The OnExit event occurs when the component loses focus.
	OnHScroll	The OnHScroll event occurs when horizontal scrollbar slider changes its position.
	OnKeyDown	The OnKeyDown event occurs if the component is focused and a keyboard key is pressed.
	OnKeyPress	The OnKeyPress event occurs if the component is focused when the user presses a character key.
	OnKeyPreview	The OnKeyPreview event occurs prior to each event related to key pressing.
	OnKeyUp	The OnKeyUp event occurs if the component is focused and the user releases any button previously pressed.
	OnMouseDown	The OnMouseDown event occurs if the pointer is in the component 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 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 when the cursor is moved over the component.
	OnMouseUp	The OnMouseUp event occurs when the mouse button is released and the cursor is in the component area.
	OnMouseWheel	The OnMouseWheel event occurs if the component is focused when the user rotates a mouse wheel.
	OnVScroll	The OnVScroll event occurs when vertical scrollbar slider changes its position.

	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 a component tree based on repository object description.
	FindItemByKey	The FindItemByKey method searches for a node in a 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
	ShowFindDialog	The ShowFindDialog method opens the dialog box of element search in the component.

	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
	ClientToScreen	The ClientToScreen method converts point coordinates specified relative to the component's coordinate system into screen coordinates.
	DoDragDrop	The DoDragDrop method enables the user to start dragging operation.
	GetImage	The GetImage method returns a graphic presentation of a component together with all child components.
	ScreenToClient	The ScreenToClient method converts point's screen coordinates into coordinates specified relative to the component's coordinate system.
	SetFocus	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.

MetabaseTreeList

Description