Working with General Visual Components > Classes > TextEditor
Namespace: PP.Ui;
TextEditor
The TextEditor class implements the TextEditor component used to edit some text.
PP.initClass(PP.Ui.TextEditor, PP.Ui.Control, "TextEditor");
Constructor name | Brief description | |
![]() |
TextEditor | The TextEditor constructor creates an instance of the TextEditor component. |
Property name | Brief description | |
![]() |
Alignment | The Alignment property determines horizontal text alignment. |
![]() |
BackgroundColor | The BackgroundColor property determines background color for the selected text. |
![]() |
EnableResize | The EnableResize property determines whether text area can be resized. |
![]() |
FontColor | The FontColor property determines font color for the selected text. |
![]() |
FontFamily | The FontFamily property determines font family for the selected text. |
![]() |
FontSize | The FontSize property sets font size for the selected text. |
![]() |
IsBold | The IsBold property determines whether the bold type text is used. |
![]() |
IsItalic | The IsItalic property determines whether the italic font is used. |
![]() |
IsUnderline | The IsUnderline property determines whether the selected text must be underlined. |
![]() |
ReadOnly | The ReadOnly property determines whether the text can be edited. |
![]() |
Text | The Text property sets text displayed in text area of the editor. |
![]() |
TextAreaHeight | The TextAreaHeight property sets height of editor's text area. |
Method name | Brief description | |
![]() |
focus | The focus method sets focus to text area. |
![]() |
getFontBox | The getFontBox method returns the FontBox component included into the TextEditor component. |
![]() |
getFormattedText | The getFormattedText method returns HTML line from text area. |
![]() |
getHyperlinkUrl | The getHyperlinkUrl method returns URL of the selected hyperlink. |
![]() |
getTextArea | The getTextArea method returns text area of the editor. |
![]() |
insertHyperlink | The insertHyperlink method creates a hyperlink in the selected text. |
![]() |
insertNode | The insertNode method inserts a DOM node to the text area. |
![]() |
removeHyperlink | The removeHyperlink method removes hyperlink in the selected text. |
![]() |
selectAll | The selectAll method selects all contents of the component text area. |
![]() |
updateControls | The updateControls method updates the FontBox component according to the current text settings. |
Event name | Brief description | |
![]() |
Blur | The Blur event occurs when the element, included into the TextEditor component, loses focus. |
![]() |
PropertyChanged | The PropertyChanged event occurs on changing settings of text editor. |
![]() |
SelectionChanged | The SelectionChanged event occurs on selecting contents of editor's text area. |
![]() |
TextChanged | The TextChanged event occurs on changing text in editor's text area. |
Property name | Brief description | |
![]() |
Anchors | The Anchors property determines position of the component placed within container. |
![]() |
Animation | The Animation property sets animation parameters for component. |
![]() |
Bottom | The Bottom property sets bottom offset on placing the component within the LayoutPanel. |
![]() |
Content | The Content property sets the component contents. |
![]() |
ContextMenu | The ContextMenu property sets the context menu for the component. |
![]() |
Data | The Data property is used to store any custom data. |
![]() |
DataContext | The DataContext property contains an object with data. |
![]() |
Enabled | The Enabled property sets whether the component is enabled. |
![]() |
Height | The Height property determines the component height. |
![]() |
IsResizable | The IsResizable property determines whether the component can be resized. |
![]() |
IsRTL | The lsRTL property sets right to left text direction. |
![]() |
IsVisible | The IsVisible property determines whether the component is displayed. |
![]() |
Left | The Left property sets left offset on placing the component within the GridPanel. |
![]() |
Offset | The Offset property determines coordinates of root DOM node of a control. |
![]() |
Opacity | The Opacity property determines component transparency. |
![]() |
Parent | The Parent property determines a parent component of a control. |
![]() |
ParentNode | The ParentNode property sets parent DOM node. |
![]() |
ResourceKey | The ResourceKey property sets the resource key for the component. |
![]() |
Right | The Right property sets right offset on placing the component within the LayoutPanel. |
![]() |
Rotate | The Rotate property sets component rotation angle. |
![]() |
ShowToolTip | The ShowToolTip property determines whether the tooltip of the component can be displayed. |
![]() |
Style | The Style property sets component style. |
![]() |
TabIndex | The TabIndex property sets the order of the control element passing inside the container. |
![]() |
Tag | The Tag property sets JSON object associated with the component. |
![]() |
ToolTip | The ToolTip property determines text of component tooltip. |
![]() |
Top | The Top property sets top offset on placing the component within the GridPanel. |
![]() |
Value | The Value property sets the value to the component. |
![]() |
Width | The Width property sets the component width. |
Method name | Brief description | |
![]() |
The addClass method adds a CSS class to the component. | |
![]() |
addEvent | The addEvent method adds an event handler to a DOM node. |
![]() |
addEventHandler | The addEventHandler method adds an event handler to a DOM node. |
![]() |
addEvents | The addEvents method adds an array of event handlers to a DOM node. |
![]() |
The addStateClass method adds a CSS class to the component and removes the previous CSS class. | |
![]() |
addStyleBySelector | The addStyleBySelector method creates a block that contains a style with the specified CSS selector. |
![]() |
The addToNode method adds a component to the specified node. | |
![]() |
bindEvents | The bindEvents method subscribes an element to all available events. |
![]() |
The clearStylesCache method clears cache of component styles. | |
![]() |
The getAnchorFlags method returns JSON object that contains settings of the current component's position. | |
![]() |
The getClass method returns the current CSS classes of the component. | |
![]() |
The getCssStyle method returns style for the specified node. | |
![]() |
The getDomNode method returns main DOM node of the component. | |
![]() |
The getFocused method determines whether the component is focused. | |
![]() |
getFunctionByName | The getFunctionByName method returns function by name. |
![]() |
getIsBinded | The getIsBinded method returns whether an element is subscribed to all DOM node events. |
![]() |
The hasClass method determines whether the specified CSS class is set for root DOM node of the control. | |
![]() |
The hide method hides a control. | |
![]() |
The hideToolTip method clears tooltip timeout and hides the tooltip if it is displayed. | |
![]() |
The isResingNow method determines whether the component is being resized. | |
![]() |
refreshBindingProperty | The refreshBindingProperty method refreshes the bound property by name. |
![]() |
refreshItemsStyle | The refreshItemsStyle method refreshes CSS styles of child elements. |
![]() |
refreshStyle | The refreshStyle method refreshes element CSS styles. |
![]() |
The removeClass method removes CSS class from the component. | |
![]() |
The removeEvent method removes event handler from DOM node. | |
![]() |
removeEventHandler | The removeEventHandler method removes event handler from DOM node. |
![]() |
removeFromDOM | The removeFromDOM method removes node from the DOM structure. |
![]() |
The removeStateClasses method removes CSS classes of the component. | |
![]() |
The setDraggable method determines whether it is possible to drag component on the HTML page. | |
![]() |
The setFocus method sets the component focus. | |
![]() |
The setIsHovered method displays the component as on hover. | |
![]() |
The setIsPressed method displays the component as if clicked upon. | |
![]() |
The setOpacityIE8 method sets component transparency value in Internet Explorer 8. | |
![]() |
The setSize method establishes the sizes of the component. | |
![]() |
The show method displays a control. | |
![]() |
unBindEvents | The unBindEvents method unsubscribes an element from all standard events. |
![]() |
The updatePosition method updates size and position when absolute positioning based on the current parameters is used. | |
![]() |
The updateSize method updates the component size on changing the size of the container that contains the component. |
Event name | Brief description | |
![]() |
Drag | The Drag event occurs on clicking and holding the left 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. |
Property name | Brief description | |
![]() |
The Id property determines a repository object identifier. |
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. |
![]() |
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. |
![]() |
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: PP.Ui