MetabaseListView: Class

The MetabaseListView class implements the MetabaseListView development environment component.

Properties

Properties inherited from IListView

	Property name	Brief description
	Arrangement	The Arrangement property determines how elements are arranged in the component.
	AutoArrange	The AutoArrange property determines whether the elements are arranged automatically in regular series when their number is changed.
	BorderStyle	The BorderStyle property determines a component border style.
	Checkboxes	The Checkboxes property determines whether the component elements have checkboxes.
	ColumnClick	The ColumnClick property determines whether component column headers can be displayed as buttons.
	Columns	The Columns property returns the component headers collection.
	FocusedItem	The FocusedItem property determines the component element that contains focus.
	GridLines	The GridLines property determines whether gridlines are 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.
	HotTrackStyles	The HotTrackStyles property determines a style of highlighting for the elements, over which the mouse cursor hovers.
	HoverTime	The HoverTime property determines the time interval, after which the element, over which the mouse cursor hovers, should be highlighted.
	ItemHeight	The ItemHeight property determines height of the component elements.
	Items	The Items property returns the component elements collection.
	LargeImages	The LargeImages property determines a source of large icons.
	MultiSelect	The MultiSelect property determines whether multiple selection of the list elements is possible.
	ReadOnly	The ReadOnly property determines whether changes can be made in the list.
	RowSelect	The RowSelect property determines whether the whole row is highlighted when an element is selected.
	SelectedCount	The SelectedCount property returns the number of selected elements in the component.
	SelectedItem	The SelectedItem property determines the selected element of the component.
	ShowColumnHeaders	The ShowColumnHeaders property determines whether column headers are displayed.
	ShowHints	The ShowHints property determines whether a tooltip appears if the mouse cursor is hovered over elements.
	SmallImages	The SmallImages property determines a source of small icons.
	SortColumn	The SortColumn property determines index of the column, by which sorting is executed.
	SortType	The SortType property determines the component sorting type.
	StateImages	The StateImages property determines the list of images that are used to indicate the state of elements.
	Style	The Style property determines a style of the component elements displaying.
	TrackSelect	The TrackSelect property determines whether the component element is selected if the mouse cursor is hovered over it.
	WrapText	The WrapText property determines whether it is possible to carry over the element text into several lines if it exceeds icon borders.

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

Methods inherited from IListView

Methods inherited from IControl

Events

Events inherited from ListView

	Event name	Brief description
	OnChecked	The OnChecked event occurs after the list element is selected.
	OnChecking	The OnChecking event occurs when the user begins to select the list element.
	OnColumnClick	The OnColumnClick event occurs on clicking on one of the component columns.
	OnComparelItems	The OnCompareItems event occurs on comparing two elements during user element sorting.
	OnDeletion	The OnDeletion event occurs when a component 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 on switching to the mode of editing the current component element.
	OnFocusChange	The OnFocusedChange event occurs when the focus is moved to another component element.
	OnFocusChanging	The OnFocusedChanging event occurs when the focus is moved to another component element.
	OnGetHint	The OnGetHint event occurs when a tooltip is displayed over the element, on which the mouse cursor stops.
	OnHover	The OnHover event occurs when a mouse cursor hovers over the element and the element is underlined.
	OnInsert	The OnInsert event occurs when the new element of the component is inserted.
	OnSelectingItem	The OnSelectingItem event occurs before the component element selection is changed.
	OnSelectItem	The OnSelectItem event occurs on the component element selection changing.

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
	CheckedObjects	The CheckedObjects property returns the collection of descriptions for objects, which checkboxes are selected in the component.
	EnableFindAll	The EnableFindAll property determines whether there is the Find All button in the search dialog box.
	EnableSystemPopupMenu	The EnableSystemPopupMenu property determines whether the system context menu is available for the elements displayed in the component.
	Filters	The Filters property returns the collection of filters used in the component.
	Root	The Root property determines description of the root directory, which contents is displayed in the component.
	SelectedObjects	The SelectedObjects property returns the collection of element descriptions selected in the component list.
	Tree	The Tree property determines the component, which will control the current component contents.

	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 component element based on repository object description.
	FindItemByKey	The FindItemByKey method searches for a component element based on a repository object key.
	GetItemObject	The GetItemObject method returns description of the repository object corresponding to the specified component element.
	SelectElem	The SelectElem method selects a component element corresponding to the repository object with the specified description.
	SelectElemKey	The SelectElemKey method selects the component element corresponding to a repository object with the specified key.
	ShowFindDialog	The ShowFindDialog method displays the dialog for object search.

	Method name	Brief description
	AdjustWidth	The AdjustWidth method automatically adjusts width of the column taking into account its contents.
	GetItemAt	The GetItemAt method gets the component element in the specified point.
	HitTest	The HitTest method is an enhanced version of the GetItemAt method.
	InsertControl	The InsertControl method inserts the component to the component element area.

	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
	OnAfterSearch	The OnAfterSearch event occurs for the component if the search dialog box is opened and all objects that satisfy given conditions were searched.
	OnGetItemPopup	The OnGetItemPopup event occurs when the context menu for the component element is being called.
	OnRootChanged	The OnRootChanged event occurs when the root directory is changed.

MetabaseListView

Description