MetabaseListView

Assembly: ExtCtrls;

Namespace: Prognoz.Platform.Interop.ExtCtrls;

Description

The MetabaseListView class implements the MetabaseListView development environment component.

Properties

  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.

Properties inherited from  IListView

  Property name Brief description
The Arrangement property determines how elements are arranged in the component.
The AutoArrange property determines whether the elements are arranged automatically in regular series when their number is changed.
The BorderStyle property determines a component border style.
The Checkboxes property determines whether the component elements have checkboxes.
The ColumnClick property determines whether component column headers can be displayed as buttons.
The Columns property returns the component headers collection.
The FocusedItem property determines the component element that contains focus.
The GridLines property determines whether gridlines are 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 HotTrackStyles property determines a style of highlighting for the elements, over which the mouse cursor hovers.
The HoverTime property determines the time interval, after which the element, over which the mouse cursor hovers, should be highlighted.
The ItemHeight property determines height of the component elements.
The Items property returns the component elements collection.
The LargeImages property determines a source of large icons.
The MultiSelect property determines whether multiple selection of the list elements is possible.
The ReadOnly property determines whether changes can be made in the list.
The RowSelect property determines whether the whole row is highlighted when an element is selected.
The SelectedCount property returns the number of selected elements in the component.
The SelectedItem property determines the selected element of the component.
The ShowColumnHeaders property determines whether column headers are displayed.
The ShowHints property determines whether a tooltip appears if the mouse cursor is hovered over elements.
The SmallImages property determines a source of small icons.
The SortColumn property determines index of the column, by which sorting is executed.
The SortType property determines the component sorting type.
The StateImages property determines the list of images that are used to indicate the state of elements.
The Style property determines a style of the component elements displaying.
The TrackSelect property determines whether the component element is selected if the mouse cursor is hovered over it.
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
The Align property determines component alignment within its parent component.
The AllowDrag property determines whether an object can be dragged from a component.
The AllowDrop property determines whether the component can accept a dragged object.
The Anchors property returns settings determining % of the resize for the current component when the parent component is resized.
The Brush property determines the brush that is used to fill the component area.
The ClientHeight property determines the height of the client component area.
The ClientWidth property determines the width of the client component area.
The Color property determines color of the component background.
The Cursor property determines how the cursor looks like when is it hovered over a component during form execution.
The Enabled property determines whether a component is available for the user.
The Focused property returns True if the focus is set to the component.
The Font property determines parameters of the font that is used to display text in the component.
The Height property determines component height in pixels.
The HelpContext property determines a unique index for a section of a context help for this component.
The Hint property determines a tooltip text displayed on hovering over the component.
The HintTimeout property determines for how long a tooltip is displayed.
The Left property determines a coordinate of the component left edge in pixels.
The Parent property determines a parent component.
The ParentColor property determines whether a component inherits the color of the parent component.
The ParentFont property determines whether a component uses the font of the parent component.
The ParentShowHint property determines when a tooltip is displayed.
The PopupMenu property determines the context menu displayed when a component is clicked with the right mouse button.
The Scrolls property returns parameters of component's scrollbars.
The ShowHint property determines whether a tooltip is displayed when the component is hovered.
The TabOrder property determines a component position in a tab order.
The TabStop property determines whether the component must be focused when the Tab button is pressed.
The Text property determines a row identifying a component for the user.
The Top property determines a coordinate of the component top edge in pixels.
The Visible property determines whether the component is displayed when a form is executed.
The Width property sets component width in pixels.

Properties inherited from  IComponent

  Property name Brief description
The ComponentCount property returns the number of child components located on the parent component.
The Components property returns a child component, which index is passed via the input parameter.
The Data property is used to store any custom data.
The Name property determines the component name.
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

  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.

Methods inherited from  IListView

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

Methods inherited from  IControl

  Method name Brief description
Outdated. The BringToFront method brings a component to the foreground.
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.
Outdated. The SendToBack method is used to send a component to the background.
The SetFocus method sets focus to this component.

Events

   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.

Events inherited from  ListView

  Event name Brief description
The OnChecked event occurs after the list element is selected.
The OnChecking event occurs when the user begins to select the list element.
The OnColumnClick event occurs on clicking on one of the component columns.
The OnCompareItems event occurs on comparing two elements during user element sorting.
The OnDeletion event occurs when a component element is deleted.
The OnEdited event occurs on exiting the mode of editing the contents of the component current record field.
The OnEditing event occurs on switching to the mode of editing the current component element.
The OnFocusedChange event occurs when the focus is moved to another component element.
The OnFocusedChanging event occurs when the focus is moved to another component element.
The OnGetHint event occurs when a tooltip is displayed over the element, on which the mouse cursor stops.
The OnHover event occurs when a mouse cursor hovers over the element and the element is underlined.
The OnInsert event occurs when the new element of the component is inserted.
The OnSelectingItem event occurs before the component element selection is changed.
The OnSelectItem event occurs on the component element selection changing.

Events inherited from  IControl

   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 with the main mouse button.
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 with the mouse button.
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:

ExtCtrls Assembly Classes