Html Area
Last updated
Was this helpful?
Last updated
Was this helpful?
(part of package 'Servoy Extra Components') Extends designtime/SolutionModel: JSWebComponent Extends runtime: RuntimeWebComponent
A Servoy Extra Component that provides a rich HTML editing area.
This is a reference page; many components have detailed usage guides here.
Bound data provider identifier for the HTML content. Type:
Flag indicating whether HTML tags should be displayed. Type: Boolean
Flag indicating whether the HTML area is editable. Type: Default Value: true
Flag indicating whether the HTML area is enabled for user interaction. Type: Default Value: true
Min height of the html editor, set only in responsive forms. Type: Number Default Value: 300
Fired when an action is triggered in the HTML area.
Parameters:
{JSEvent} event The event object containing details about the action event.
Fired when the HTML content changes.
Parameters:
{JSEvent} event The event object associated with the data change.
Returns: {Boolean}
Fired when the HTML area gains focus.
Parameters:
{JSEvent} event The event object containing details about the focus gained event.
Fired when the HTML area loses focus.
Parameters:
{JSEvent} event The event object containing details about the focus lost event.
Fired when the HTML area is right-clicked.
Parameters:
{JSEvent} event The event object containing details about the right-click event.
Gets the plain text for the formatted Html Area.
Example:
Returns: String The plain text
Returns the x scroll location of specified element - only for an element where height of element is less than the height of element content. NOTE: getScrollX() can be used with getScrollY() to set the scroll location of an element using the setScroll function.
For Example:
Example:
Returns: Number The x scroll location in pixels.
Returns the y scroll location of specified element - only for an element where height of element is less than the height of element content. NOTE: getScrollY() can be used with getScrollX() to set the scroll location of an element using the setScroll function.
For Example:
Example:
Returns: Number The y scroll location in pixels.
Returns the currently selected text in the specified Html Area.
Example:
Returns: String The selected text in the Html Area.
Replaces the selected text; if no text has been selected, the replaced value will be inserted at the last cursor position.
Example:
Parameters:
{String} selectedText The replacement text
Returns: String The new content after replace.
Set the focus to this Html Area.
Example:
Parameters:
{Boolean} [mustExecuteOnFocusGainedMethod] If false will not execute the onFocusGained method; the default value is true[0m
Selects all the contents of the Html Area.
Example:
Sets the scroll location of an element. It takes as input the X (horizontal) and Y (vertical) coordinates - starting from the TOP LEFT side of the screen - only for an element where the height of the element is greater than the height of element content NOTE: getScrollX() can be used with getScrollY() to return the current scroll location of an element; then use the X and Y coordinates with the setScroll function to set a new scroll location.
For Example:
Example:
Parameters:
Placeholder text displayed when no HTML content is present. Type:
Flag indicating whether the HTML area is read-only. Type:
Configuration for the scrollbars in the HTML area. Type:
CSS style classes applied to the HTML area component. Type:
Tab sequence order for keyboard navigation. Type:
The HTML content displayed in the editor. Type:
Tooltip text displayed when hovering over the HTML area. Type:
Flag indicating whether the HTML area is visible. Type:
{} oldValue The previous HTML content.
{} newValue The new HTML content.