FormulaEditor

Description

The FormulaEditor component is a formula editor.

Comments

The component is implemented by the FormulaEditor class.

Example

Component has the following view.

The example of creating a formula editor is given on the Example of Creating the FormulaEditor Component page.

Constructor

  Constructor name Brief description
FormulaEditor The FormulaEditor constructor creates an instance of the FormulaEditor class.

Properties

  Property name Brief description
CalculationPanelContent The CalculationPanelContent property determines the contents of the panel for calculation of expression editor parameters.
CaretPosition The CaretPosition property sets cursor position in the expression editor.
DescriptionTemplate The DescriptionTemplate property determines a template for description of expression editor operators and functions.
InitialFunctionCategories The InitialFunctionCategories property determines initial functions that will be added to expression editor during component initialization.
InitialOperators The InitialOperators property determines initial operators that will be added to expression editor during component initialization.
InitialTerms The InitialTerms property determines initial terms that will be added to expression editor during component initialization.
IsNamingVisible The IsNamingVisible property determines whether the Name container is displayed.
LeftColumnContent The LeftColumnContent property determines the contents of the left column of expression editor.
MinCenterColumnWidth The MinCenterColumnWidth property determines minimum width of expression editor central column.
NamingTextBox The NamingTextBox property sets a text field of the Name container.

Methods

  Method name Brief description
addCategory The addCategory method adds a category to the list of functions.
addFunction The addFunction method adds a function to the list of functions.
addOperator The addOperator method adds an operator to the list of operators.
getCalcParamsContainer The getCalcParamsContainer method returns the panel for calculation of expression editor parameters.
getFilterMenuButton The getFilterMenuButton method returns the button for filtering of expression editor.
getFormula The getFormula method returns the final formula of expression editor.
getFunctionList The getFunctionList method returns the list of expression editor functions.
getTermEdit The getTermEdit method returns the term editor included into expression editor.
insertTerm The insertTerm method adds a term or term array described as an object or string.
setCalcParamsVisibility The setCalcParamsVisibility method determines whether the panel for calculation of parameters is visible.
setFilterPanelVisibility The setFilterPanelVisibility method determines whether the filtering panel is visible.
setFocusTermEdit The setFocusTermEdit method sets focus on the term editor included into expression editor.
setWarningMessage The setWarningMessage method displays the Warning button in expression editor.

Events

  Event name Brief description
CalcParamsPanelResized The CalcParamsPanelResized event occurs after changing the size of the panel for calculation of expression editor parameters.
LeftPanelResized The LeftPanelResized event occurs after changing the size of the left panel of expression editor parameters.
TermDrop The TermDrop event occurs after adding a term from the lists of functions or operators.
TermsChanged The TermsChanged event occurs after changing expression editor terms.

Properties inherited from the class Control

  Property name Brief description
Anchors The Anchors property determines position of the component placed within container.
Animation The Animation property determines component animation parameters.
Bottom The Bottom property determines a bottom margin if a component is placed inside LayoutPanel.
Content The Content property determines component contents.
ContextMenu The ContextMenu property determines a component's context menu.
Data The Data property is used to store any custom data.
Enabled The Enabled property determines whether a component can be used.
Height The Height property determines component height.
IsRTL The IsRTL property determines whether component elements are aligned to the right.
IsVisible The IsVisible property determines whether a component is displayed.
Left The Left property determines a left margin if a component is placed inside GridPanel.
Opacity The Opacity property determines component transparency.
Parent The Parent property determines a parent component of a control.
ParentNode The ParentNode property determines a parent DOM node.
ResourceKey The ResourceKey property determines a component resource key.
Right The Right property determines a right margin if a component is placed inside LayoutPanel.
Rotate The Rotate property determines a component rotation angle.
ShowToolTip The ShowToolTip property determines whether a tooltip of the component can be displayed.
Style The Style property determines a component style.
TabIndex The TabIndex property determines the order of the control element passing inside the container.
Tag The Tag property determines a JSON object associated with the component.
ToolTip The ToolTip property determines text of component tooltip.
Top The Top property determines a top margin if a component is placed inside GridPanel.
Value The Value property determines a component value.
Width The Width property determines component width.

Methods inherited from the class Control

  Method name Brief description

addClass

The addClass method adds a CSS class to the component.
addEventHandler The addEventHandler method adds an event handler to a DOM node.

addStateClass

The addStateClass method adds a CSS class to the component and removes the previous CSS class.

addToNode

The addToNode method adds a component to the specified node.
bindEvents The bindEvents method subscribes an element to all available events.

getAnchorFlags

The getAnchorFlags method returns JSON object that contains settings of the current component's position.

getClass

The getClass method returns the current CSS classes of the component.

getCssStyle

The getCssStyle method returns style for the specified node.

getDomNode

The getDomNode method returns main DOM node of the component.

getFocused

The getFocused method determines whether the component is focused.
getIsBinded The getIsBinded method returns whether an element is subscribed to all DOM node events.

hide

The hide method hides a control.

hideToolTip

The hideToolTip method clears tooltip timeout and hides the tooltip if it is shown.
refreshStyle The refreshStyle method refreshes element CSS styles.

removeClass

The removeClass method removes CSS class from the component.
removeEventHandler The removeEventHandler method removes event handler from DOM node.
removeFromDOM The removeFromDOM method removes node from the DOM structure.

removeStateClasses

The removeStateClasses method removes CSS classes of the component.

setDraggable

The setDraggable method determines whether a component can be dragged on the HTML page.

setFocus

The setFocus method sets the component focus.

setIsHovered

The setIsHovered method sets up component displaying only on mouseover.

setSize

The setSize method establishes the sizes of the component.

show

The show method displays a control.
unBindEvents The unBindEvents method unsubscribes an element from all standard events.

updatePosition

The updatePosition method updates size and position when absolute positioning based on the current parameters is used.

updateSize

The updateSize method updates the component size on changing the size of the container that contains the component.

Events inherited from the class Control

  Event name Brief description
Drag The Drag event occurs on clicking and holding the mouse button.
DragEnd The DragEnd event occurs when dragging the component finishes.
DragStart The DragStart event occurs when dragging the component starts.
OnContextMenu The OnContextMenu event occurs on calling context menu of the component.
SizeChanged The SizeChanged event occurs after the component is resized.
SizeChanging The SizeChanging event occurs during component resize.

Properties inherited from the class Object

  Property name Brief description

Id

The Id property determines a repository object identifier.

Methods inherited from the class Object

  Method name Brief description
clone The clone method creates an object copy.
dispose The dispose method deletes the component.
getHashCode The getHashCode method returns hash code of repository object.
getId The getId method returns repository object identifier.
getSettings The getSettings method returns repository object settings.
getTypeName The getTypeName method returns the name of the object type without the namespace, to which it belongs.
isEqual The isEqual method determines whether the specified object is equal to the current repository object.
isLive The isLive method determines validity of repository object.
removeAllEvents The removeAllEvents method removes all object event handlers by the specified context.
setId The setId method determines a repository object identifier.
setSettings The setSettings method determines repository object settings.
defineProps The defineProps method creates get and set methods from name array for the specified class.
keys The keys method returns array of methods and properties names for the specified object.

See also:

DHTML Components