MsExpressionEdit

Assembly: Ms;

Namespace: Prognoz.Platform.Interop.Ms;

Description

The MsExpressionEdit class implements the MsExpressionEdit development environment component.

Inheritance Hierarchy

          IComponent

          IControl

          ICustomEdit

          ITermEdit

          IMsExpressionEdit

          MsExpressionEdit

Comments

The MsExpressionEdit component is used to edit expression and contains a tooltip for used functions and methods.

Properties inherited from IMsExpressionEdit

  Property name Brief description
The Expression property determines expression edited in the  MsExpressionEditcomponent.
The FormulaTermList property determines term collection available in the  MsExpressionEditcomponent.
The FormulaTransform property determines parameters of the model to which the  MsExpressionEditcomponent is set up.
The HeavyDelimiters property determines expression delimiter.
The LightDelimiters property determines the delimiter for words of the same term.
The MaxTermWordCount property sets maximum number of words in a term.
The Rubricator property determines the time series database, which attributes are available in the MsExpressionEditcomponent.
The SelectionSet property determines selection of time series database attributes.
The UseFullVariableNames property determines whether to use full operand names.

Properties inherited from ITermEdit

  Property name Brief description
Outdated. The AutoReparsing property determines whether text is automatically converted to terms and operators.
The DirectInput property determines whether direct input is possible.
The EnableHyperlinks property determines whether expression can be displayed as a hyperlink.
The Formula property determines expression formula.
The Hyperlink property determines whether selected expression is displayed as a hyperlink.
The Terms property returns collection of component terms.
The WantReturns property determines whether it is possible to insert a carriage return character in the edited text.
The WantTabs property determines whether it is possible to insert a tab character in the edited text.
The WordWrap property determines whether the words that are longer than component length should be wrapped to a new line.

Properties inherited from ICustomEdit

  Property name Brief description
The AutoSelect property determines whether all component text is selected when component gets focus.
The BorderStyle property determines component border style.
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 selected component text should remain selected on transferring focus to another component.
The MaxLength property determines the maximum length of entered text.
The Modified property returns True if the component text has been changed.
The ReadOnly property determines whether the user is allowed to change component text.
The SelLength property determines length of the selected component text in characters.
The SelStart property determines the position to start text selection in the component.
The SelText property determines text selected in the component.

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 a 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 component background color.
The Cursor property determines how the cursor looks like when it is hovered 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 to this component.
The Font property determines parameters of the font used to display text in a component.
The Height property determines the component height in pixels.
The HelpContext property determines the unique index for a section of a context help for this component.
The Hint property determines the tooltip text displayed on hovering over a component.
The HintTimeout determines the time, during which the tooltip is displayed.
The Left property determines the coordinate of the component left edge in pixels.
The Parent property determines the parent component.
The ParentColor property determines whether a component inherits the parent component color.
The ParentFont property determines whether a parent component font is used for the 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 scrollbars.
The ShowHint property determines whether a tooltip should be displayed when the cursor is hovered over a component.
The TabOrder property determines the component position 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 string identifying a component for a user.
The Top property determines the coordinate of the component upper edge in pixels.
The Visible property determines whether a component is visible during the form runtime.
The Width property determines the horizontal size of a component in pixels.

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 the child component, which index is passed by 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. A user can change the value of the Tag property and use it as required.

Methods inherited from IMsExpressionEdit

  Method name Brief description
AddStub The AddStub method adds a cube as a data source of MsExpressionEdit.
The AddAttribute method adds the attribute, which values are used to create series in the component.
The ClearAttributes method deletes all attributes, added for using in the component.
The GetAttributeCount method returns the number of the attributes, available for using in the component.
The RemoveAttribute method deletes the selected attribute from the attributes list, the values of which are used in the component.

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 custom term to selected position.
The PutLiteral method places literal term to selected position.
The PutTerm method inserts term to selected position.
The Reparse method transforms editor text and redistribution of terms in the components.

Methods inherited from ICustomEdit

  Method name Brief description
The Clear method deletes all text in the component.
The ClearSelection method deletes selected text in the component.
The ClearUndo method fixes 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 front.
The ClientToScreen method converts the point coordinates specified regarding 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 child components.
The ScreenToClient method converts screen coordinates of a point to coordinates specified regarding the component coordinate system.
Outdated. The SendToBack method sends a component to back.
The SetFocus method sets focus to this component.

Events

  Event name Brief description
The OnUpdateFormula event that occurs on converting the external presentation of expression to the internal one.
The OnUpdateText event occurs on converting the internal presentation of expression into the external one.

Events inherited from IControl

  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 enters the component area.
The OnDragLeave event occurs when a dragged object leaves the borders of this component.
The OnDragOver event occurs for a 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 scrollbar 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 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 when position of vertical scrollbar slider is changed.

See also:

Ms Assembly Classes