The WorkspaceBox class implements the WorkspaceBox component of development environment used to display the repository workspaces data.
| Property name | Brief description | |
| The ActivTool property determines the active tool of the workspace. | ||
| The BorderStyle property determines the style of a component border. | ||
| The DefaultMenu property determines whether workspace and shapes placed on it have the system context menu. | ||
| The DefaultHandlers property determines whether it is possible to execute default action on the workspace shape. | ||
| The DisplayConnectionsPoint property determines whether connection points are displayed. | ||
| The DisplayFokusFrame property determines whether the focus is displayed. | ||
| The DisplayGrid property determines whether the grid is displayed on the workspace. | ||
| The DisplayIntersections property determines whether intersections are displayed. | ||
| The DisplayScrollBar property determines whether workspace scroll bars are displayed. | ||
| The DisplaySelections property determines whether the selection of objects on workspace is displayed. | ||
| The Scale property determines the scale of the workspace. | ||
| The Source property determines the data source for the WorkspaceBox component. | ||
| The View property determines display settings of the workspace. |
| 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 size change for the current component when the parent component is resized. | ||
| The Brush property specifies the brush 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 the background color of a component. | ||
| The Cursor property determines how the cursor looks like when you hover over a component during form execution. | ||
| The Enabled property determines whether a component is available for a user. | ||
| The Focused property returns True if the focus is set on this component. | ||
| The Font property defines the parameters of the font used to display text in a component. | ||
| The Height property determines the component height (pixels). | ||
| The HelpContext property determines the unique index for a section of a context help for this component. | ||
| The Hint property determines the tip text displayed if you hover over a component. | ||
| The HintTimeout determines the time for which the tooltip is displayed. | ||
| The Left property determines the coordinate of the component left edge (pixels). | ||
| The Parent property determines the parent component. | ||
| The ParentColor property determines whether a component inherits the color of the parent component. | ||
| The ParentFont property determines whether a component should use 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 using the right mouse button. | ||
| The Scrolls property returns parameters of component's scroll bars. | ||
| The ShowHint property determines whether a tool tip should be displayed when you hover over a component. | ||
| The TabOrder property determines the position of a component in a tab order. | ||
| The TabStop property determines whether the focus is set to a component when the Tab button is pressed. | ||
| The Text property determines the row identifying a component for a user. | ||
| The Top property determines the coordinate of the component upper edge (pixels). | ||
| The Visible property determines whether a component is displayed when a form is executed. | ||
| The Width property determines the horizontal size of a component (pixels). |
| 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, the index of which is passed via the input parameter. | ||
| The Data property is used to store any custom data. | ||
| The Name property deterines the component name. | ||
| 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. |
| Method name | Brief description | |
| ConvertPtToView | The ConvertPtToView method allows to get point coordinates in the workspace using point display coordinates. | |
| GetShapeByPt | The GetShapeByPt method allows to receive information about the figure by the screen coordinate of a point within the figure. |
| Method name | Brief description | |
| Outdated. The BringToFront method sends a component to the foreground. | ||
| The ClientToScreen method converts the coordinates of a point specified relative to the component coordinate system to screen coordinates. | ||
| The DoDragDrop method allows to start dragging operation. | ||
| The GetImage method returns a graphic presentation of a component together with all children. | ||
| The ScreenToClient method converts screen coordinates of a point to coordinates specified relative to the component coordinate system. | ||
| Outdated. The SendToBack method is used to send a component to the background. | ||
| The SetFocus method sets focus to this component. |
| 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 takes place before the shift of 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. |
| Event name | Brief description | |
| The OnBeginDrag event occurs for a component, when a user starts to drag 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 crosses the borders 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 receives focus. | ||
| The OnExit event occurs when a component loses focus. | ||
| The OnHScroll event occurs when horizontal scroll bar slider changes its position. | ||
| 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 if the pointer is in component's 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 user moves the cursor over a component. | ||
| The OnMouseUp occurs if user releases a mouse button while the cursor is in component's area. | ||
| The OnMouseWheel event occurs if a component is focused when a user rotates a mouse wheel. | ||
| The OnVScroll event occurs when position of vertical scroll bar slider is changed. |
See also: