MetaAttributesBreadcrumb

Description

The MetaAttributesBreadCrumb class implements the MetaAttributesBreadcrumb development environment component that is used to create a breadcrumb by indicators contained in time series database.

Class object properties inherited from IMetaAttributesBreadcrumb

	Property name	Brief description
	CustomMultiselectText	The CustomMultiselectText property determines whether a custom template is used to form component text on multiple selection by attributes.
	CustomMultiselectTextTemplate	The CustomMultiselectTextTemplate property determine the template, according to which component text is formed on multiple selection.
	Dictionary	The Dictionary property determines a dictionary, to which the component is connected.
	DimensionViewer	The DimensionViewer property returns the object for working with component's drop-down list.
	ExtendedRootItem	The ExtendedRootItem property determines whether the combo element is displayed in the component.
	HistoryButton	The HistoryButton property determines whether a button used to select an attribute set and the previous attribute selection is displayed.
	IncludeRevision	The IncludeRevision property determines whether an attribute with revisions is displayed in the component.
	LabelDropDown	The LabelDropDown property determines whether a drop-down list containing a list of attribute indicators is displayed when an element is selected in the component list.
	MetaAttributes	The MetaAttributes property determines the time series database attributes displayed in the component.
	MetaAttributeSettings	The MetaAttributeSettings property returns settings of attributes of the time series database associated with the component.
	ReadOnly	The ReadOnly property determines whether component settings are prohibited via the visual interface.
	RootHint	The RootHint property determines tooltip text for the additional button of the combo element.
	RootText	The RootText property determines text for the additional button of the combo element.
	Rubricator	The Rubricator property determines the time series database, which data is displayed in the component.
	SelectionMode	The SelectionMode property determines how indicators are selected by attributes displayed in the component.
	ShowColumnHeaders	The ShowColumnHeaders property determines whether column headers are displayed in the drop-down list of the time series database attribute values.
	VerticalMode	The VerticalMode property determines the mode of aligning elements in the component.

Properties of object class inherited from IBreadcrumb

	Property name	Brief description
	AutoScroll	The property is under development.
	BorderStyle	The BorderStyle property determines the style of a component border.
	DeleteButton	The DeleteButton property determines whether the button used to delete all component elements is displayed.
	Items	The Items property returns the component elements collection.
	ScrollLeft	The property is under development.
	ScrollRight	The property is under development.
	StartDownButton	The StartDownButton property determines whether an additional button is to be displayed after the button that deletes elements.
	Suffix	The Suffix property determines the auxiliary text shown in component area after navigation chain.

Class object 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 a 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.

Class object 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, 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.

Class object methods inherited from IMetaAttributesBreadcrumb

	Method name	Brief description
	ApplyDefaultAttriburesOrder	The ApplyDefaultAttriburesOrder method applies default hierarchy of attributes.
	GetAttributeValue	The GetAttributeValue method returns indicators selection based on the specified attribute.
	GetSelectionSet	The GetSelectionSet method returns indicators selection based on the attributes included into component breadcrumb.
	Refresh	The Refresh method refreshes data by all attributes displayed in the component breadcrumb.
	SetAttributeValue	The SetAttributeValue method selects indicators based on the specified attribute.
	SetSelectionSet	The SetSelectionSet method sets indicators selection by the attributes included into the component breadcrumb.

Object class methods inherited from IBreadcrumb

	Method name	Brief description
	BeginUpdate	The BeginUpdate method stops redrawing related components.
	EndUpdate	The EndUpdate method resumes redrawing related components.
	HitTest	The HitTest method gets element of the component in the specified point.
	LoadState	The LoadState method loads component elements state.
	SaveState	The SaveState method saves component elements state.

Class object methods inherited from IControl

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

Class object events

	Event name	Brief description
	OnBeforeReplaceItem	The OnBeforeReplaceItem event occurs before component elements are replaced.
	OnChangeSelection	The OnChangeSelection event occurs on changing element selection by any attribute.
	OnDimTreePopup	The OnDimTreePopup event occurs on opening context menu of the drop-down list of the MetaAttributesBreadcrumb component.
	OnDropDown	The OnDropDown event occurs on expanding element list of the attribute that corresponds to a component element.
	OnMetaAttributeParam	The OnMetaAttributeParam event occurs on selecting a parameter as attribute value.
	OnReplaceItem	The OnReplaceItem event occurs after component elements are replaced.
	OnRollUp	The OnRollUp event occurs after collapsing element list of the attribute that corresponds to a component element.
	OnRootClick	The OnRootClick event occurs on clicking additional button of the combo element (root).

Class object events inherited from IBreadcrumb

	Event name	Brief description
	OnAddItem	The OnAddItem event occurs on adding a new element to the collection of the component elements.
	OnBeforeAddItem	The OnBeforeAddItem event occurs before adding a new element to the collection of the component elements.
	OnBeforeMoveItem	The OnBeforeMoveItem event occurs before moving a component element.
	OnBeforeRemoveItem	The OnBeforeRemoveItem event occurs before removing a component element.
	OnButtonClick	The OnButtonClick event occurs on clicking the auxiliary button with a mouse button displayed next to the component element name.
	OnGetPopupMenu	The OnGetPopupMenu event occurs on opening the context menu for a component element.
	OnItemClick	The OnItemClick event occurs on clicking the mouse button on a component element.
	OnMoveItem	The OnMoveItem event occurs on moving a component element.
	OnRemoveItem	The OnRemoveItem event occurs on removing a component element.

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

See also:

ExtCtrls Assembly Classes