Members
Methods
# addEventListener(eventName, callback)
The addEventListener function registers event listener functions on the TXTextControl object.
Parameters:
| Name | Type | Description |
|---|---|---|
eventName |
T
|
|
callback |
TXTextControlTypeDefinition.EventMapCallback.<T>
|
# addMergeField(mergeField)
Inserts a merge field at the current input position.
Parameters:
| Name | Type | Description |
|---|---|---|
mergeField |
TXTextControlTypeDefinition.MergeField
|
TXTextControlTypeDefinition.IfField
|
TXTextControlTypeDefinition.IncludeTextField
|
TXTextControlTypeDefinition.DateField
|
TXTextControlTypeDefinition.NextField
|
TXTextControlTypeDefinition.NextIfField
|
# append(streamType, base64Data, loadSettings, appendSettings) → {Promise.<void>}
Appends text to the document in a certain format.
Parameters:
| Name | Type | Description |
|---|---|---|
streamType |
TXTextControlTypeDefinition.StreamType
|
Specifies one of the numerical StreamType values. |
base64Data |
string
|
Base64 encoded document data. For encoding strings containing characters outside of the Latin1 range use TXTextControl.btoaUTF8. |
loadSettings |
TXTextControlTypeDefinition.LoadSettings
|
null
|
Additional settings for appending the data. Can be null. |
appendSettings |
TXTextControlTypeDefinition.AppendSettings
|
Settings on how the document is appended. |
Promise.<void>
# appendDocument(streamType, base64Data)
Appends text in a certain format to the current document.
Parameters:
| Name | Type | Description |
|---|---|---|
streamType |
TXTextControlTypeDefinition.StreamType
|
Specifies one of the numerical StreamType values. |
base64Data |
string
|
Base64 encoded document data. For encoding strings containing characters outside of the Latin1 range use TXTextControl.btoaUTF8. |
# atobUTF8(inputString, keepBOM) → {string}
Decodes a string of data which has been encoded using base-64 encoding.
Parameters:
| Name | Type | Description |
|---|---|---|
inputString |
string
|
A base-64 encoded unicode string. |
keepBOM |
boolean
|
Optional. Set this to true in case the original string had a byte order mark and you want to keep it. |
The original unicode string.
string
# beginUndoAction(actionName) → {Promise.<void>}
Begins a user - defined undo operation.
All editing and fomatting changes made between beginUndoAction and endUndoAction belong to the undo operation.
These changes are undone or redone in a single step.
The specified user-defined name is available via getUndoActionName.
Parameters:
| Name | Type | Description |
|---|---|---|
actionName |
string
|
null
|
Specifies the undo action's name. If an action name is not necessary, this parameter can be null or an empty string. |
Promise.<void>
# btoaUTF8(inputString, addBOM) → {string}
Creates a base-64 encoded ASCII string from a unicode string.
In contrast to the browser provided method btoa() this method handles all unicode characters
and not only characters in the Latin1 range.
Parameters:
| Name | Type | Description |
|---|---|---|
inputString |
string
|
A unicode string to be encoded into base-64. |
addBOM |
boolean
|
Optional. Set this to true if a byte order mark should be added to the encoded string. |
A base-64 encoded string.
string
# clear() → {Promise.<void>}
Clears the selected text or the character right from the current input position.
Promise.<void>
# endUndoAction() → {Promise.<void>}
Ends a user-defined undo operation.
All editing and fomatting changes made between beginUndoAction and endUndoAction belong to the undo operation.
These changes are undone or redone in a single step.
Promise.<void>
# find(text, start, options) → {Promise.<number>}
Finds a text string. The search starts at the specified position.
Parameters:
| Name | Type | Description |
|---|---|---|
text |
string
|
Specifies the text to search for. |
start |
number
|
Specifies the text position where the search starts, beginning with 0. If this value is -1, the search begins at the current text input position. |
options |
TXTextControlTypeDefinition.FindOptions
|
null
|
Optional. Specifies search options. It can be a combination of the FindOptions values. |
index of first character of the search string
Promise.<number>
# flattenFormFields() → {Promise.<void>}
Flatten all form fields in the document. This means that all form fields are converted to static text.
Promise.<void>
# getActivationState() → {Promise.<TXTextControlTypeDefinition.ActivationState>}
Gets a value indicating the current activation state.
Promise.<TXTextControlTypeDefinition.ActivationState>
# getAllowUndo() → {Promise.<boolean>}
Gets a value indicating whether the undo buffer is active or not.
Promise.<boolean>
# getBaseline() → {Promise.<number>}
Gets the baseline alignment, in twips, of the Text Control.
Promise.<number>
# getCanCharacterFormat() → {Promise.<boolean>}
Informs whether the currently selected text can be formatted with character formatting attributes.
Promise.<boolean>
# getCanCopy() → {Promise.<boolean>}
Informs whether a part of a Text Control document has been selected and can be copied to the clipboard.
Promise.<boolean>
# getCanDocumentFormat() → {Promise.<boolean>}
Informs whether the document can be formatted with page and section formatting attributes.
Promise.<boolean>
# getCanPaste() → {Promise.<boolean>}
Informs whether the document's text and/or formatting attributes can be changed.
Promise.<boolean>
# getCanPrint() → {Promise.<boolean>}
Informs whether the document can be printed.
Promise.<boolean>
# getCanRedo() → {Promise.<boolean>}
Informs whether an operation can be re - done using the Redo method.
Promise.<boolean>
# getCanStyleFormat() → {Promise.<boolean>}
Informs whether the document can be formatted with formatting styles.
Promise.<boolean>
# getCanTableFormat() → {Promise.<boolean>}
Informs whether the currently selected text can be formatted with table formatting attributes.
Promise.<boolean>
# getCanUndo() → {Promise.<boolean>}
Gets a value indicating whether the user can undo the previous operation in a Text Control.
Promise.<boolean>
# getCommentHighlightMode() → {Promise.<TXTextControlTypeDefinition.HighlightMode>}
Gets the global comment highlight mode.
Promise.<TXTextControlTypeDefinition.HighlightMode>
# getControlChars() → {Promise.<boolean>}
Gets whether the control characters are visible or not.
Promise.<boolean>
# getCultures()
Returns the culture and the UI culture of the control.
# getDocumentTargetMarkers() → {Promise.<boolean>}
Gets a value indicating that markers for hypertext targets are shown or not.
Promise.<boolean>
# getDrawingMarkerLines() → {Promise.<boolean>}
Gets whether a marker frame is shown around a drawing to indicate its position and size.
Promise.<boolean>
# getEditMode() → {Promise.<TXTextControlTypeDefinition.EditMode>}
Gets a value indicating whether the document's text is protected, or can be freely edited and formatted.
Promise.<TXTextControlTypeDefinition.EditMode>
# getEditableRegionHighlightMode() → {Promise.<TXTextControlTypeDefinition.HighlightMode>}
Gets the global editable region highlight mode.
Promise.<TXTextControlTypeDefinition.HighlightMode>
# getFontUnderlineStyle() → {Promise.<TXTextControlTypeDefinition.FontUnderlineStyle>}
Gets underlining style for the text displayed by the control.
Promise.<TXTextControlTypeDefinition.FontUnderlineStyle>
# getForeColor() → {Promise.<string>}
Gets the foreground color of the control which is the color of the document's text.
Promise.<string>
# getFormattingPrinter() → {Promise.<string>}
Returns the name of the currently selected formatting printer by calling a provided callback function.
Promise.<string>
# getFormulaReferenceStyle() → {Promise.<TXTextControlTypeDefinition.FormulaReferenceStyle>}
Gets a value determining how references to table cells in formulas are specified.
Promise.<TXTextControlTypeDefinition.FormulaReferenceStyle>
# getInstalledPrinters() → {Promise.<Array.<string>>}
Gets the names of the printers installed on the server which are usable by Text Control.
Promise.<Array.<string>>
# getIsFormFieldValidationEnabled() → {Promise.<boolean>}
Gets a value indicating whether form field validation is active or not.
Promise.<boolean>
# getIsFormulaCalculationEnabled() → {Promise.<boolean>}
Gets a value indicating whether formulas in tables are automatically calculated when the text of an input cell is changed.
Promise.<boolean>
# getIsHyphenationEnabled() → {Promise.<boolean>}
Gets a value indicating whether hyphenation is active or not.
Promise.<boolean>
# getIsLanguageDetectionEnabled() → {Promise.<boolean>}
Gets a value indicating whether language detection is active or not.
Promise.<boolean>
# getIsSpellCheckingEnabled() → {Promise.<boolean>}
Gets a value indicating whether spell checking is active or not.
Promise.<boolean>
# getIsTrackChangesEnabled() → {Promise.<boolean>}
Gets a value indicating whether track changes is active or not.
Promise.<boolean>
# getLandscape() → {Promise.<boolean>}
Gets a value indicating whether the page orientation is landscape.
Promise.<boolean>
# getPageCount() → {Promise.<number>}
Gets the number of pages contained in the current document.
Promise.<number>
# getPageUnit() → {Promise.<TXTextControlTypeDefinition.MeasuringUnit>}
Gets the measure used for page sizes and page margins.
Promise.<TXTextControlTypeDefinition.MeasuringUnit>
# getPermanentControlChars() → {Promise.<TXTextControlTypeDefinition.PermanentControlChar>}
Gets a value indicating which control characters are shown permanently on the screen.
Promise.<TXTextControlTypeDefinition.PermanentControlChar>
# getRedoActionName() → {Promise.<string>}
Gets a string that represents the name of the action that will be performed when a call to the redo method is made.
Promise.<string>
# getRenderMode() → {Promise.<TXTextControlTypeDefinition.ComponentRenderMode>}
Gets the component render mode.
Promise.<TXTextControlTypeDefinition.ComponentRenderMode>
# getSelectObjects() → {Promise.<boolean>}
Gets a value controlling the selection of objects which are inserted behind the text.
Promise.<boolean>
# getStatusBarColor() → {Promise.<string>}
Returns the background color of the status bar as a hexadecimal CSS color string.
Promise.<string>
# getSupportedFonts() → {Promise.<Array.<string>>}
Gets an array of strings specifying the names of all currently supported fonts.
Promise.<Array.<string>>
# getSupportedPaperSizes() → {Promise.<Array.<TXTextControlTypeDefinition.PaperSize>>}
Gets an array of PaperSize structures specifying the names and the size of all currently supported paper sizes.
Promise.<Array.<TXTextControlTypeDefinition.PaperSize>>
# getTextFieldsByType(fieldType) → {Promise.<Array.<TXTextControlTypeDefinition.TextFieldInfo>>}
Returns an array of static text field information objects. (Inherited from FormattedText)
Parameters:
| Name | Type | Description |
|---|---|---|
fieldType |
TXTextControlTypeDefinition.TextFieldType
|
Promise.<Array.<TXTextControlTypeDefinition.TextFieldInfo>>
# getTextFrameMarkerLines() → {Promise.<boolean>}
Gets whether text frames that have no border line are shown with marker lines.
Promise.<boolean>
# getUndoActionName() → {Promise.<string>}
Gets a string that represents the name of the action that will be performed when a call to the undo method is made.
The property's value is null if there is no action that can be undone.
Promise.<string>
# getUserNames() → {Promise.<Array.<string>>}
Gets a list of names specifying users who have access to editable regions.
Promise.<Array.<string>>
# getViewMode() → {Promise.<TXTextControlTypeDefinition.ViewMode>}
Gets the mode how Text Control displays a document.
Promise.<TXTextControlTypeDefinition.ViewMode>
# init(settings)
Initializes the document editor.
Parameters:
| Name | Type | Description |
|---|---|---|
settings |
TXTextControlTypeDefinition.ComponentSettings
|
# async initialize(componentSettings, jsResourceFilePathopt) → {Promise.<void>}
Loads resource files and initializes the document editor after TXTextControl is available
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
componentSettings |
TXTextControlTypeDefinition.ComponentSettings
|
|||
jsResourceFilePath |
string
|
<optional> |
"/GetResource?name=tx-document-editor.min.js" |
Promise.<void>
# load(streamType, base64Data, loadSettingsopt) → {Promise.<TXTextControlTypeDefinition.LoadDocumentCallbackData>}
Loads text in a certain format.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
streamType |
TXTextControlTypeDefinition.StreamType
|
||
base64Data |
string
|
||
loadSettings |
TXTextControlTypeDefinition.LoadSettings
|
<optional> |
Promise.<TXTextControlTypeDefinition.LoadDocumentCallbackData>
# loadDocument(streamType, base64Data, loadSettingsopt) → {Promise.<TXTextControlTypeDefinition.LoadDocumentCallbackData>}
Loads text in a certain format.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
streamType |
TXTextControlTypeDefinition.StreamType
|
||
base64Data |
string
|
||
loadSettings |
TXTextControlTypeDefinition.LoadSettings
|
<optional> |
Promise.<TXTextControlTypeDefinition.LoadDocumentCallbackData>
# loadJsonData(jsonData) → {Promise.<void>}
Loads JSON data which is used to create table and field name menu items in the mailings ribbon tab.
Parameters:
| Name | Type | Description |
|---|---|---|
jsonData |
string
|
Promise.<void>
# loadXMLDatabase(xmlData) → {Promise.<void>}
Loads an XML database which is used to create table and field name menu items in the mailings ribbon tab.
Parameters:
| Name | Type | Description |
|---|---|---|
xmlData |
string
|
Promise.<void>
# printDocument()
Attempts to print the current document in the browser. Not all browsers support this.
# refreshLayout()
Forces a layout refresh of the document editor.
Use this method in cases where the editor doesn't automatically react to layout changes of your web site.
# removeEventListener(eventName, callback)
The removeListener function removes the specified event listener from the TXTextControl object.
Parameters:
| Name | Type | Description |
|---|---|---|
eventName |
T
|
|
callback |
TXTextControlTypeDefinition.EventMapCallback.<T>
|
# removeFromDom()
Closes the WebSocket connection gracefully and removes the whole editor from the DOM.
# async save(streamType, saveSettingsopt) → {Promise.<TXTextControlTypeDefinition.SaveDocumentResult>}
Saves the current document in a certain format and sends the result back asynchronously by calling a given callback function.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
streamType |
TXTextControlTypeDefinition.StreamType
|
||
saveSettings |
TXTextControlTypeDefinition.SaveSettings
|
<optional> |
Promise.<TXTextControlTypeDefinition.SaveDocumentResult>
# saveDocument(streamType, saveSettingsopt) → {Promise.<TXTextControlTypeDefinition.SaveDocumentResult>}
Saves the current document in a certain format and sends the result back asynchronously by calling a given callback function.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
streamType |
TXTextControlTypeDefinition.StreamType
|
||
saveSettings |
TXTextControlTypeDefinition.SaveSettings
|
<optional> |
Promise.<TXTextControlTypeDefinition.SaveDocumentResult>
# select(start, length) → {Promise.<void>}
Selects text within the control.
Parameters:
| Name | Type | Description |
|---|---|---|
start |
number
|
|
length |
number
|
Promise.<void>
# selectWord() → {Promise.<void>}
Selects the word at the current text input position.
Promise.<void>
# setActivationState(activationState) → {Promise.<void>}
Sets a value indicating the current activation state.
Parameters:
| Name | Type | Description |
|---|---|---|
activationState |
TXTextControlTypeDefinition.ActivationState
|
Promise.<void>
# setAllowUndo(allowUndo) → {Promise.<void>}
Sets a value indicating whether the undo buffer is active or not.
Parameters:
| Name | Type | Description |
|---|---|---|
allowUndo |
boolean
|
Promise.<void>
# setBackColor(htmlColor) → {Promise.<void>}
Sets the Text Control's background color.
Parameters:
| Name | Type | Description |
|---|---|---|
htmlColor |
string
|
Promise.<void>
# setBaseline(baseline) → {Promise.<void>}
Sets the baseline alignment, in twips, of the Text Control.
Parameters:
| Name | Type | Description |
|---|---|---|
baseline |
number
|
Promise.<void>
# setCommentHighlightMode(value) → {Promise.<void>}
Sets the global comment highlight mode.
Parameters:
| Name | Type | Description |
|---|---|---|
value |
TXTextControlTypeDefinition.HighlightMode
|
Promise.<void>
# setControlChars(controlChars) → {Promise.<void>}
Sets whether the control characters are visible or not.
Parameters:
| Name | Type | Description |
|---|---|---|
controlChars |
boolean
|
Promise.<void>
# setDocumentTargetMarkers(documentMarkerLines) → {Promise.<void>}
Sets a value indicating that markers for hypertext targets are shown or not.
Parameters:
| Name | Type | Description |
|---|---|---|
documentMarkerLines |
boolean
|
Promise.<void>
# setDrawingMarkerLines(drawingMarkerLines) → {Promise.<void>}
Sets whether a marker frame is shown around a drawing to indicate its position and size.
Parameters:
| Name | Type | Description |
|---|---|---|
drawingMarkerLines |
boolean
|
Promise.<void>
# setEditMode(editMode) → {Promise.<void>}
Sets a value indicating whether the document's text is protected, or can be freely edited and formatted.
Parameters:
| Name | Type | Description |
|---|---|---|
editMode |
TXTextControlTypeDefinition.EditMode
|
Promise.<void>
# setEditableRegionHighlightMode(value) → {Promise.<void>}
Sets the global editable region highlight mode.
Parameters:
| Name | Type | Description |
|---|---|---|
value |
TXTextControlTypeDefinition.HighlightMode
|
Promise.<void>
# setFontUnderlineStyle(style) → {Promise.<void>}
Sets underlining style for the text displayed by the control.
Parameters:
| Name | Type | Description |
|---|---|---|
style |
TXTextControlTypeDefinition.FontUnderlineStyle
|
Promise.<void>
# setForeColor(foreColor) → {Promise.<void>}
Sets the foreground color of the control which is the color of the document's text.
Parameters:
| Name | Type | Description |
|---|---|---|
foreColor |
string
|
Promise.<void>
# setFormattingPrinter(printerName)
Sets the name of a printer the text dimensions and capabilities of which are used to format the document.
Parameters:
| Name | Type | Description |
|---|---|---|
printerName |
string
|
# setFormulaReferenceStyle(style) → {Promise.<void>}
Sets a value determining how references to table cells in formulas are specified.
Parameters:
| Name | Type | Description |
|---|---|---|
style |
TXTextControlTypeDefinition.FormulaReferenceStyle
|
Promise.<void>
# setInputPositionByLocation(location) → {Promise.<void>}
Sets a new input position from a geometric location.
Parameters:
| Name | Type | Description |
|---|---|---|
location |
TXTextControlTypeDefinition.Point
|
Promise.<void>
# setInputPositionByPage(page, line, column) → {Promise.<void>}
Sets a new input position from a page, line and column number.
Parameters:
| Name | Type | Description |
|---|---|---|
page |
number
|
|
line |
number
|
|
column |
number
|
Promise.<void>
# setInputPositionByTextPosition(textPosition, textFieldPosition) → {Promise.<void>}
Sets a new input position from a text position.
Parameters:
| Name | Type | Description |
|---|---|---|
textPosition |
number
|
|
textFieldPosition |
TXTextControlTypeDefinition.TextFieldPosition
|
Promise.<void>
# setIsFormFieldValidationEnabled(value) → {Promise.<void>}
Sets a value indicating whether form field validation is active or not.
Parameters:
| Name | Type | Description |
|---|---|---|
value |
boolean
|
Promise.<void>
# setIsFormulaCalculationEnabled(enable) → {Promise.<void>}
Sets a value indicating whether formulas in tables are automatically calculated when the text of an input cell is changed.
Parameters:
| Name | Type | Description |
|---|---|---|
enable |
boolean
|
Promise.<void>
# setIsHyphenationEnabled(enable) → {Promise.<void>}
Sets a value indicating whether hyphenation is active or not.
Parameters:
| Name | Type | Description |
|---|---|---|
enable |
boolean
|
Promise.<void>
# setIsLanguageDetectionEnabled(enable) → {Promise.<void>}
Sets a value indicating whether language detection is active or not.
Parameters:
| Name | Type | Description |
|---|---|---|
enable |
boolean
|
Promise.<void>
# setIsSpellCheckingEnabled(enable) → {Promise.<void>}
Sets a value indicating whether spell checking is active or not.
Parameters:
| Name | Type | Description |
|---|---|---|
enable |
boolean
|
Promise.<void>
# setIsTrackChangesEnabled(value) → {Promise.<void>}
Sets a value indicating whether track changes is active or not.
Parameters:
| Name | Type | Description |
|---|---|---|
value |
boolean
|
Promise.<void>
# setLandscape(isLandscape) → {Promise.<void>}
Sets a value indicating whether the page orientation is landscape.
Parameters:
| Name | Type | Description |
|---|---|---|
isLandscape |
boolean
|
Promise.<void>
# setPageUnit(pageUnit) → {Promise.<void>}
Sets the measure used for page sizes and page margins.
Parameters:
| Name | Type | Description |
|---|---|---|
pageUnit |
TXTextControlTypeDefinition.MeasuringUnit
|
Promise.<void>
# setPermanentControlChars(permanentControlChars) → {Promise.<void>}
Sets a value indicating which control characters are shown permanently on the screen.
Parameters:
| Name | Type | Description |
|---|---|---|
permanentControlChars |
TXTextControlTypeDefinition.PermanentControlChar
|
Promise.<void>
# setRenderMode(value) → {Promise.<void>}
Sets the component render mode.
Parameters:
| Name | Type | Description |
|---|---|---|
value |
TXTextControlTypeDefinition.ComponentRenderMode
|
Promise.<void>
# setSelectObjects(selectObjects) → {Promise.<void>}
Sets a value controlling the selection of objects which are inserted behind the text.
Parameters:
| Name | Type | Description |
|---|---|---|
selectObjects |
boolean
|
Promise.<void>
# setStatusBarColor(hexColor) → {Promise.<void>}
Sets the background color of the status bar.
Parameters:
| Name | Type | Description |
|---|---|---|
hexColor |
string
|
Promise.<void>
# setText(text) → {Promise.<void>}
Sets the control's text.
Parameters:
| Name | Type | Description |
|---|---|---|
text |
string
|
Promise.<void>
# setTextBackColor(color) → {Promise.<void>}
Sets the background color for the text.
Parameters:
| Name | Type | Description |
|---|---|---|
color |
string
|
Promise.<void>
# setTextFrameMarkerLines(textFrameMarkerLines) → {Promise.<void>}
Sets whether text frames that have no border line are shown with marker lines.
Parameters:
| Name | Type | Description |
|---|---|---|
textFrameMarkerLines |
boolean
|
Promise.<void>
# setViewMode(viewMode) → {Promise.<void>}
Sets the mode how Text Control displays a document.
Parameters:
| Name | Type | Description |
|---|---|---|
viewMode |
TXTextControlTypeDefinition.ViewMode
|
Promise.<void>
# showDialog(dialogBoxKind, selectedTabopt)
Shows a built -in dialog box.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
dialogBoxKind |
TXTextControlTypeDefinition.DialogBoxKind
|
The dialog box kind. | |
selectedTab |
number
|
<optional> |
Optional. The 0-based selected dialog tab. |
# showHorizontalRuler(showopt)
Shows or hides the web editor's horizontal ruler bar.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
show |
boolean
|
<optional> |
# showHtmlDialog(dialogBoxKind)
Shows one of the a built -in HTML dialog boxes.
Parameters:
| Name | Type | Description |
|---|---|---|
dialogBoxKind |
TXTextControlTypeDefinition.HtmlDialogBoxKind
|
# showMergeFieldDialog(fieldType)
Opens a field dialog either for changing properties of an existing merge field or for creating a new merge field.
Parameters:
| Name | Type | Description |
|---|---|---|
fieldType |
TXTextControlTypeDefinition.FieldType
|
# showRibbonBar(showopt)
Shows or hides the ribbon bar.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
show |
boolean
|
<optional> |
# showSideBar(sideBarType, showopt)
Shows or hides a specified side bar.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
sideBarType |
TXTextControlTypeDefinition.SideBarType
|
||
show |
boolean
|
<optional> |
# showStatusBar(showopt)
Shows or hides the web editor's status bar.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
show |
boolean
|
<optional> |
# showVerticalRuler(showopt)
Shows or hides the web editor's vertical ruler bar.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
show |
boolean
|
<optional> |
# async untilTextControlLoaded() → {Promise.<void>}
waits until TXTextControlLoaded true
Promise.<void>
# zoom(zoomFactor) → {Promise.<void>}
Zooms the contents of the TextControl.
Parameters:
| Name | Type | Description |
|---|---|---|
zoomFactor |
number
|
TXTextControlTypeDefinition.SpecialZoomFactor
|
Specifies the zoom factor, in percent. This can also be one of the values of the TXTextControl.SpecialZoomFactor enumeration. |
Promise.<void>