WorkspaceBox

Description

The WorkspaceBox class implements the WorkspaceBox development environment component that is used to display repository workspaces data.

Class object properties inherited from IWorkspaceBox

	Property name	Brief description
	ActiveTool	The ActivTool property determines an active tool of the workspace.
	BorderStyle	The BorderStyle property determines a component border style.
	DefaultMenu	The DefaultMenu property determines whether workspace and shapes placed on it have the system context menu.
	DefaultHandlers	The DefaultHandlers property determines whether it is possible to execute default action with the workspace shape.
	DisplayConnectionPoints	The DisplayConnectionsPoint property determines whether connection points are displayed.
	DisplayFocusFrame	The DisplayFokusFrame property determines whether the focus is displayed.
	DisplayGrid	The DisplayGrid property determines whether the grid is displayed on the workspace.
	DisplayIntersections	The DisplayIntersections property determines whether intersections are displayed.
	DisplayScrollBars	The DisplayScrollBar property determines whether workspace scrollbars are displayed.
	DisplaySelections	The DisplaySelections property determines whether the selection of objects on workspace is displayed.
	Scale	The Scale property determines a workspace scale.
	Source	The Source property determines a data source for the WorkspaceBox component.
	View	The View property determines display settings of the workspace.

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 a 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 a component background color.
	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 the component is available for the user.
	Focused	The Focused property returns True if this component is focused.
	Font	The Font property determines parameters of the font that is used to display text in a 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 a 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 a context menu displayed when a component is clicked using 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 a 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 determines horizontal size of a component 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 the 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 a component name.
	Tag	The Tag property is not used by the compiler. The user can change the value of the Tag property and use it as he wishes.

Class object methods inherited from IWorkspaceBox

	Method name	Brief description
	ConvertPtToView	The ConvertPtToView method enables the user to get point coordinates on the workspace using point display coordinates.
	GetShapeByPt	The GetShapeByPt method enables the user to get information about the shape by the screen coordinate of a point within the shape.

Class object methods inherited from IControl

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

Events

	Event name	Brief description
	OnAfterMoveCP	The OnAfterMoveCP method implements the event that occurs after shifting one of the end points of the connecting line.
	OnBeforeMoveCP	The OnBeforeMoveCP method implements the event that occurs before shifting one of the end points of the connecting line.
	OnSelectionChanged	The OnSelectionChanged event occurs on changing focus of any workspace object.
	OnShapeChanged	The OnShapeChanged event occurs after any changes related to workspace shape.

Class object events inherited from IControl

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

See also:

Workspace Assembly Classes