TermEdit

Inheritance Hierarchy

Description

The TermEdit component is an editor of expressions made using terms.

Working with the Component

This component is used to make equations using terms. A term is a text element containing a reference to an object. On create the equation in the component editing area the text notifications specified in the Text property of each term are displayed. On calculate the internal term representation, specified in the Formula property of each term is used. It is possible to set up character color including using a term as a hyperlink. Term properties and methods are used for that: CustomHyperlinkStyle, Color, SetTextColor.

The common expression displayed in the component is defined by the Text property, and the expression used to perform calculations (expression based on the terms internal representations (formulas)), is defined by the Formula methods.

To create an expression it is necessary to organize term collection available in the Terms property. An expression is formed by inserting the required terms at the specific positions. The inserting is performed by the PutCustom, PutLiteral and PutTerm.

To manage the expression direct input possibility the DirectInput property is used. When you input an expression manually, the text is automatically converted into terms.

NOTE. The TermEdit component and the TermEditEx component differ in their internal implementation.

Properties of the TermEdit Component

	Property name	Brief description
	Align	The Align property determines the behavior of the component, when the size of its parent component is changed.
	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 that determine the percentage of the size change for the current component when the parent component is resized.
	AutoReparsing	The AutoReparsing property determines, whether the text should be automatically transformed into terms and operands.
	AutoSelect	The AutoSelect property determines, whether all the text of a component must be selected, when a component receives focus.
	BorderStyle	The BorderStyle property determines the style of a component border.
	Brush	The Brush property specifies the brush used to fill the component area.
	CanUndo	The CanUndo property returns True, if it is possible to undo text changes in the component.
	CharacterCasing	The CharacterCasing property determines the case of the entered characters.
	ClientHeight	The ClientHeight property is used to receive or specify the height of the component’s client space.
	ClientWidth	The ClientWidth property is used to receive or specify the width of the component’s client space.
	Color	The Color property determines the background color of a component.
	ComponentCount	The ComponentCount property returns the number of child components.
	Components	The Components property returns the child component.
	Cursor	The Cursor property determines the look of the cursor over the component.
	Data	The Data property is used to store any custom data.
	DirectInput	The DirectInput property determines the possibility of direct input.
	Enabled	The Enabled property determines whether the component is available for the user.
	EnableHyperlinks	The EnableHyperlinks property determines whether it is possible to display a term as a hyperlink.
	Focused	The Focused property returns True, if the focus is set on the component.
	Font	The Font property determines the set of characteristics, describing the font, used to display text.
	Formula	The Formula property determines the term formula.
	Height	The Height property determines the component height.
	HelpContext	The HelpContext property determines a unique index for the context help section for this component.
	HideSelection	The HideSelection property determines, whether the selected component text should remain the same, when the focus goes to another component.
	Hint	The Hint property determines the hint text for the component.
	Hyperlink	The Hyperlink property determines, whether the expression, the index of which is an input parameter, is a hyperlink.
	Left	The Left property determines the coordinate of the left border of the component.
	MaxLength	The MaxLength property determines the maximum length of the entered text.
	Modified	The Modified property returns True, if the component text has been changed.
	Name	The Name property determines the component name.
	Parent	The Parent property determines the parent component.
	ParentColor	The ParentColor property determines whether the component inherits the color of the parent component.
	ParentFont	The ParentFont property determines whether the component should use the font of the parent component.
	ParentShowHint	The ParentShowHint property determines when a tooltip is displayed.
	PopupMenu	The PopupMenu property determines the context menu to be displayed on right-click.
	ReadOnly	The ReadOnly property determines, whether a user is able to change the component text.
	Scrolls	The Scrolls property returns parameters of component's scrollbars.
	SelLength	The SelLength property determines the number of characters selected in the component text.
	SelStart	The SelStart property determines the position of the cursor from which to start text selection in the component.
	SelText	The SelText property determines text, selected in the component.
	ShowHint	The ShowHint property enables and disables showing a hint for the component.
	TabOrder	The TabOrder property determines the component position in the tab order.
	TabStop	The TabStop property determines whether the focus is set to a component when the TAB button is pressed.
	Tag	The Tag property is not used by the compiler. The user can change the value of the Tag property and use it as required.
	Terms	The Terms property returns the terms collection.
	Text	The Text property determines the row identifying a component for user.
	Top	The Top property determines the coordinate of the top border of the component.
	Visible	The Visible property determines the visibility of the component during execution.
	WantReturns	The WantReturns property determines whether it should be possible to insert a carriage return symbol into the edited text.
	WantTabs	The WantTabs property determines whether it should be possible to insert a tab symbol into the edited text.
	Width	The Width property determines the component width.
	WordWrap	The WordWarp property determines, whether the lines exceeding component length should be wrapped to a new line.

Methods of the TermEdit Component

	Method name	Brief description
	BeginUpdate	The BeginUpdate method disables a set of internal mechanisms for accelerating insertion of terms into the component.
	BringToFront	The BringToFront method brings a component to front.
	Clear	The Clear method deletes all the text in the input field.
	ClearSelection	The ClearSelection method deletes the records, selected in the input field.
	ClearUndo	The ClearUndo method is used to fix the changes of the Text property.
	ClientToScreen	The ClientToScreen method converts point coordinates relative to component coordinates into display coordinates.
	CopyToClipboard	The CopyToClipboard method allows to copy the selected data to clipboard.
	CutToClipboard	The CutToClipboard method allows to cut the selected data and place it to clipboard.
	DoDragDrop	The DoDragDrop method allows to start drag-and-drop operation.
	EndUpdate	The EndUpdate method restores work of internal mechanisms of the component, which were disabled for acceleration of insertion of terms into the component.
	GetImage	The GetImage method returns the image of the component with all the child components.
	PasteFromClipboard	The PasteFromClipboard method pastes data from clipboard.
	PutCustom	The PutCustom method allows to place the user-defined term into the specified position, after which it returns the term index in the collection.
	PutLiteral	The PutLiteral method allows to place the literal term into the specified position, after which it returns the term index in the collection.
	PutTerm	The PutTerm method allows to place the term into the specified position, after which it returns the term index in the collection.
	Reparse	The Reparse method transforms editor text and redistributes terms in the component.
	ScreenToClient	The ScreenToClient method converts screen coordinates of a point to coordinates specified relative to the component coordinate system.
	SelectAll	The SelectAll method selects all the controls.
	SetFocus	The SetFocus method sets focus to this component.
	SendToBack	The SendToBack method sends a component to back.
	Undo	The Undo method allows to undo all the changes in the Text property after the last time the ClearUndo method was invoked.

Events of the TermEdit Component

	Event name	Brief description
	OnBeginDrag	The OnBeginDrag event occurs for a component, when a user starts to drag an object from the component.
	OnChange	The OnChange event occurs after changing the Text property of the editing component.
	OnClick	The OnClick event occurs if a user clicks a component area using the main mouse button.
	OnDblClick	The OnDblClick event occurs if a user double-clicks a component area using the mouse button.
	OnDragDrop	The OnDragDrop event occurs for a component if a user drops a dragged object over it.
	OnDragEnter	The OnDragEnter event occurs when a dragged object crosses the borders of this component.
	OnDragLeave	The OnDragLeave event occurs when a dragged object leaves the borders of this component.
	OnDragOver	The OnDragOver event occurs for this component when a user drags a dragged object over it.
	OnEnter	The OnEnter event occurs when a component receives focus.
	OnExit	The OnExit event occurs when a component loses focus.
	OnHScroll	The OnHScroll event occurs when the horizontal scrollbar slider changes its position.
	OnHyperlink	The OnHyperlink event occurs on clicking on the term hyperlink in the expression.
	OnKeyDown	The OnKeyDown event occurs if a component is focused and a keyboard key is pressed.
	OnKeyPress	The OnKeyPress event occurs if a component is focused when a user presses a character key.
	OnKeyUp	The OnKeyUp event occurs if a component is focused and a user releases any button previously pressed.
	OnMouseDown	The OnMouseDown event occurs when the pointer is in 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 on moving the cursor over component.
	OnMouseUp	The OnMouseUp event occurs on releasing mouse button when the cursor is in component area.
	OnMouseWheel	The OnMouseWheel event occurs if the component has focus when the mouse wheel is rotated.
	OnParseTerm	The OnParseTerm event occurs when the editor text is transformed into terms and operands.
	OnVScroll	The OnVScroll event occurs when the vertical scrollbar slider changes its position.