EtlBox

Assembly: Etl;

Description

The EtlBox class implements the EtlBox development environment component.

Class object properties inherited from IEtlBox

  Property name Brief description
ActiveTool The ActiveTool property determines the active tool of the ETL task working area.
BorderStyle The BorderStyle property determines a component border style.
DefaultHandlers The DefaultHandlers property determines whether default action can be executed with a shape in ETL task.
DefaultMenu The DefaultMenu property determines whether system context menu is available for ETL task objects and its working area.
DisplayConnectionPoints The DisplayConnectionPoints 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 in the ETL task working area.
DisplayIntersections The DisplayIntersections property determines whether line intersections are displayed.
DisplayScrollBars The DisplayScrollBars property determines whether scrollbars are displayed in ETL task working area.
DisplaySelections The DisplaySelections property determines whether the selection of objects in ETL task working area is displayed.
Source The Source property determines a component data source.
View The View property determines display settings of ETL task working area.

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 the 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 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 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 the context help section 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 the 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 for the component.
Scrolls The Scrolls property returns parameters of component 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 determines column 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 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 IEtlBox

  Method name Brief description
ConvertPtToView The ConvertPtToView method enables the user to get point coordinates in the working area using point display coordinates.
ExecuteTask The ExecuteTask method starts ETL task execution.
GetShapeByPt The GetShapeByPt method enables the user to get information about the shape by using screen coordinates of the point that is located within the shape.
OrderOperations The OrderOperations method opens setup dialog box for operation execution order.
UpdateObjectsState The UpdateObjectsState method updates display of calculation chain activity state.

Class object methods inherited from IControl

  Method name Brief description
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.
SetFocus The SetFocus method sets focus to this component.

Class Object Events

   Event name Brief description
OnAfterMoveCP The OnAfterMoveCP event occurs after the line connection point is moved.
OnBeforeMoveCP The OnBeforeMoveCP event occurs before moving the line connection point.
OnSelectionChanged The OnSelectionChanged event occurs on changing the selected object in the component working area.
OnShapeChanged The OnShapeChanged event occurs after any changes related to any shape.

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.
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.
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 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 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 the 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 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 cursor is in the 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 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:

ETL Assembly Classes