RdsDictionaryBox

Description

The RdsDictionaryBox class implements the RdsDictionaryBox development environment component that is used to display data of the MDM dictionaries.

Properties inherited from IRdsDictionaryBox

	Property name	Brief description
	AdjustWidthOnlyVisible	The AdjustWidthOnlyVisible property determines the method of column width autofit.
	BorderStyle	The BorderStyle property determines component border style.
	CanElementDown	The CanElementDown property returns whether the selected elements can be moved one position down.
	CanElementLevelUp	The CanElementLevelUp property returns whether the selected elements can be moved one level up.
	CanElementUp	The CanElementUp property returns whether the selected elements can be moved one position up.
	Columns	The Columns property returns the collection of MDM dictionary columns displayed in the RdsDictionaryBox component.
	FindResultsMenu	The FindResultsMenu property determines whether the search dialog box displays the context menu for the found elements.
	FocusedElement	The FocusedElement property determines the key of the MDM dictionary focused element.
	HighlightTrack	The HighlightTrack property determines whether the element is highlighted on mouseover.
	RootImageIndex	The RootImageIndex property determines index of the icon for the root component element.
	SelectionMode	The SelectionMode property determines the mode of selecting component elements.
	ShowHeaderButton	The ShowHeaderButton property determines whether to show the button that opens column header menu.
	ShowHints	The ShowHints property determines whether tooltips should be displayed when the mouse is held over the elements of the RdsDictionaryBox component.
	Source	The Source property determines data source for the RdsDictionaryBox component.

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 a component can accept a dragged object.
	Anchors	The Anchors property returns settings determining % 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 client component area height.
	ClientWidth	The ClientWidth property determines the client component area width.
	Color	The Color property determines the component background color.
	Cursor	The Cursor property determines type of the cursor displayed on hovering 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 this component is focused.
	Font	The Font property determines parameters of the font used to display text in a component.
	Height	The Height property determines the component height in 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 tooltip text displayed on hovering over a component.
	HintTimeout	The HintTimeout property determines for how long the tooltip is shown.
	Left	The Left property determines the coordinate of the component left edge in pixels.
	Parent	The Parent property determines the parent component.
	ParentColor	The ParentColor property determines whether a component inherits the parent component color.
	ParentFont	The ParentFont property determines whether a component should use the parent component color.
	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 scrollbars.
	ShowHint	The ShowHint property determines whether a tooltip is displayed on hovering over a component.
	TabOrder	The TabOrder property determines the position of a component in a tab order.
	TabStop	The TabStop property determines whether the component is focused 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 in pixels.
	Visible	The Visible property determines whether a component is displayed during the form execution.
	Width	The Width property determines the horizontal size of a component 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 the child property, index of which is passed by the input parameter.
	Data	The Data property is used to store any user data.
	Name	The Name property determines component name.
	Tag	The Tag property is not used by the compiler. A user can change the value of the Tag property and use it as he wishes.

Methods inherited from IRdsDictionaryBox

	Method name	Brief description
	AddElement	The AddElement method opens a standard dialog box for creating of a new MDM dictionary element.
	CanCopy	The CanCopy method returns whether the element can be copied to the clipboard.
	ClearElements	The ClearElements method clears all MDM dictionary elements.
	CanPaste	The CanPaste method returns whether the element can be pasted from the clipboard.
	Copy	The Copy method copies selected element to the clipboard.
	Cut	The Cut method moves the selected dictionary element to clipboard.
	EditElement	The EditElement method opens a standard dialog box for editing properties of the focused element and returns the element key.
	FindElement	The FindElement method searches for an MDM dictionary element.
	MoveElementDown	The MoveElementDown method moves the selected elements one position down if it is allowed.
	MoveElementLevelUp	The MoveElementLevelUp method moves the selected elements one level up if it is allowed.
	MoveElementUp	The MoveElementUp method moves the selected elements one position up if it is allowed.
	Paste	The Paste method pastes an element from the clipboard.
	RefreshElements	The RefreshElements method refreshes the element tree.
	RemoveElement	The RemoveElement method removes the selected elements.
	RenameElement	The RenameElement method switches the name of the focused element to edit mode.
	ShowFindDialog	The ShowFindDialog method opens the standard dialog box for searching MDM dictionary elements.

Methods inherited from IControl

	Method name	Brief description
	BringToFront	Outdated. The BringToFront method brings a component to front.
	ClientToScreen	The ClientToScreen method converts the coordinates of a point specified relative to the component coordinate system to screen coordinates.
	DoDragDrop	The DoDragDrop method starts dragging.
	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 sends a component to back.
	SetFocus	The SetFocus method sets focus to this component.

Events

	Event name	Brief description
	OnAfterElementAdd	The OnAfterElementAdd event occurs after a new element is added to the component.
	OnAfterElementChange	The OnAfterElementChange event occurs after element is changed in the component.
	OnAfterElementDelete	The OnAfterElementDelete event occurs after element is deleted from the component.
	OnBeforeElementAdd	The OnBeforeElementAdd event occurs before a new element is added to the component.
	OnBeforeElementChange	The OnBeforeElementChange event occurs before element is changed in the component.
	OnBeforeElementDelete	The OnBeforeElementDelete event occurs before element is deleted from the component.
	OnSelectionChanged	The OnSelectionChanged event occurs when selection is changed in the tree of elements displayed in the component.

Events inherited from IControl

	Event name	Brief description
		The OnBeginDrag event occurs for a component when a user starts dragging an object from the component.
		The OnClick event occurs if a user clicks a component area using the main mouse button.
		The OnControlMove event occurs when a component is moved.
		The OnControlResize event occurs when a component is resized.
		The OnDblClick event occurs if a user double clicks a component area using the mouse button.
		The OnDragDrop event occurs for a component if a user drops a dragged object over it.
		The OnDragEnter event occurs when a dragged object enters the space of this component.
		The OnDragLeave event occurs when a dragged object leaves the borders of this component.
		The OnDragOver event occurs for this component when a user drags a dragged object over it.
		The OnEnter event occurs when a component gets focused.
		The OnExit event occurs when a component loses focus.
		The OnHScroll event occurs on changing position of horizontal scrollbar slider.
		The OnKeyDown event occurs if a component is focused and a keyboard key is pressed.
		The OnKeyPress event occurs if a component is focused when a user presses a character key.
		The OnKeyPreview event occurs prior to each event requiring clicking.
		The OnKeyUp event occurs if a component is focused and a user releases any button previously pressed.
		The OnMouseDown event occurs when the pointer is in component area and a mouse button 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 on moving the cursor over component.
		The OnMouseUp event occurs on releasing mouse button when the cursor is in component area.
		The OnMouseWheel event occurs if the component has focus when the mouse wheel is rotated.
		The OnVScroll event occurs on changing position of vertical scrollbar slider.

See also:

Rds Assembly Classes