CalcCubeFormulaEdit

Description

The CalcCubeFormulaEdit class implements the CalcCubeFormulaEdit development environment component that is used to create and edit calculated cube formulas.

Class object properties inherited from ICalcCubeFormulaEdit

  Property name Brief description
Cube The Cube property determines the data source cube.

Class object properties inherited from IExpressionEdit

  Property name Brief description
Expression The Expression property determines an expression located in the component.

Class object properties inherited from ITermEdit

  Property name Brief description
The AutoReparsing property determines whether the text is automatically transformed into terms (expressions) and operands.
The DirectInput property determines whether direct input is available.
The EnableHyperlinks property determines whether a term can be displayed as a hyperlink.
The Formula property determines a term formula.
The Hyperlink property determines whether the expression, which index is an input parameter, is a hyperlink.
The Terms property returns the terms (expressions) collection.
The WantReturns property determines whether carriage return symbol can be inserted into the edited text.
The WantTabs property determines whether a tab symbol can be inserted into the edited text.
The WordWarp property determines whether the lines exceeding component length are wrapped to a new line.

Class object properties inherited from ICustomEdit

  Property name Brief description
The AutoSelect property determines whether all the text of a component must be selected, when a component receives focus.
The BorderStyle property determines the style of a component border.
The CanUndo property returns True if it is possible to undo text changes in the component.
The CharacterCasing property determines the case of entered component characters.
The HideSelection property determines whether the selected component text should remain the same when the focus goes to another component.
The MaxLength property determines the maximum length of the entered text.
The Modified property returns True if the component text has been changed.
The ReadOnly property determines whether a user is able to change the component text.
The SelLength property determines the length in characters of the selected text in the component.
The SelStart property determines the position to start text selection in the component.
The SelText property determines text selected in the component.

Class object properties inherited from IControl

  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 resize for the current component when the parent component is resized.
The Brush property determines the brush that is 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 color of the component background.
The Cursor property determines how the cursor looks like when is it hovered over a component during form execution.
The Enabled property determines whether a component is available for the user.
The Focused property returns True if the focus is set to the component.
The Font property determines parameters of the font that is used to display text in the component.
The Height property determines component height in pixels.
The HelpContext property determines a unique index for a section of a context help for this component.
The Hint property determines a tooltip text displayed on hovering over the component.
The HintTimeout property determines for how long a tooltip is displayed.
The Left property determines a coordinate of the component left edge in pixels.
The Parent property determines a parent component.
The ParentColor property determines whether a component inherits the color of the parent component.
The ParentFont property determines whether a component uses 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 with the right mouse button.
The Scrolls property returns parameters of component's scrollbars.
The ShowHint property determines whether a tooltip is displayed when the component is hovered.
The TabOrder property determines a component position in a tab order.
The TabStop property determines whether the component must be focused when the Tab button is pressed.
The Text property determines a row identifying a component for the user.
The Top property determines a coordinate of the component top edge in pixels.
The Visible property determines whether the component is displayed when a form is executed.
The Width property sets component width in pixels.

Class object properties inherited from IComponent

  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, which index is passed via the input parameter.
The Data property is used to store any custom data.
The Name property determines the component name.
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 ICalcCubeFormulaEdit

   Method name Brief description
PutCoord The PutCoord method places the term corresponding to the specified cube coordinate to the editor.

Class object methods inherited from IExpressionEdit

   Method name Brief description
UpdateExpression The UpdateExpression method updates the expression.

Methods inherited from ITermEdit

   Method name Brief description
The BeginUpdate method disables a set of internal mechanisms for accelerating insertion of terms into the component.
The EndUpdate method restores work of internal mechanisms of the component, which were disabled for acceleration of insertion of terms into the component.
The PutCustom method places the custom term into the specified position.
The PutLiteral method places the literal term into the specified position.
The PutTerm method places the term into the specified position.
The Reparse method transforms editor text and redistributes terms in the component.

Methods inherited from ICustomEdit

   Method name Brief description
The Clear method deletes all text in the component.
The ClearSelection method deletes selected text in component.
The ClearUndo method is used to fix the changes of the Text property.
The CopyToClipboard method copies selected data to clipboard.
The CutToClipboard method cuts selected data to clipboard.
The PasteFromClipboard method pastes data from clipboard.
The SelectAll method selects all text in the component.
The Undo method cancels last text change in the component.

Methods inherited from IControl

  Method name Brief description
Outdated. The BringToFront method brings a component to the foreground.
The ClientToScreen method converts point coordinates specified relative to the component's coordinate system into screen coordinates.
The DoDragDrop method enables the user to start dragging operation.
The GetImage method returns a graphic presentation of a component together with all child components.
The ScreenToClient method converts point's screen coordinates into coordinates specified relative to the component's coordinate system.
Outdated. The SendToBack method is used to send a component to the background.
The SetFocus method sets focus to this component.

Events

   Event name Brief description
OnFormatCoord The OnFormatCoord event occurs when a term corresponding to cube coordinate is created.

Events inherited from TermEdit

   Event name Brief description
OnHyperlink The OnHyperlink event occurs on clicking the term hyperlink in the expression.
OnParseTerm The OnParseTerm event occurs when the editor text is transformed into terms (expressions) and operands.

Events inherited from ICustomEdit

   Event name Brief description
OnChange The OnChange event occurs after changing the Text property of the editing component.

Events inherited from IControl

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

See also:

ExtCtrls Assembly Classes