Javascript: TextFrame Object - TX Text Control DS Server

TX Text Control DS ServerReference GuideJavaScript APITextFrame Object

The TextFrame object represents a rectangle that can be filled with text by an end-user and can be edited like the main text.

Syntax

JavaScript

TextFrame

Introduced: X18.

Methods

Method	Description
activate	Activates the text frame.
changeZOrder	Changes the frame's z-order.
find	Finds a text string. (Inherited from FormattedText)
getAlignment	Gets the frame's horizontal alignment when it is anchored to a paragraph.
getBackColor	Gets the background color of the text frame.
getBorderColor	Gets the border color of the text frame.
getBorderStyle	Gets the style of a text frame's border line.
getBorderWidth	Gets the width, in twips, of a text frame's border line.
getBounds	Gets the frame's bounding rectangle relative to the upper left corner of the document.
getID	Gets an identifier for the frame.
getInsertionMode	Gets a value determining whether the frame is treated as a single character or the document's text either flows around or overwrites the frame.
getInternalMargins	Sets the distances, in twips, between the text frame's border line and the text.
getLocation	Gets, in twips, the frame's current location.
getMoveable	Gets whether a frame can be moved in the document at run time with the built-in mouse interface.
getName	Gets the name for the frame.
getSize	Gets the frame's size in twips.
getSizeable	Gets whether the frame can be resized at run time with the built-in mouse interface.
getTextDistances	Gets the distances, in twips, between the frame and the document's text.
getTextFieldsByType	Returns an array of static text field information objects. (Inherited from FormattedText)
getTextPosition	Gets the frame's character position in the document's text (one-based).
getTransparency	Gets the text frame's transparency.
setAlignment	Sets the frame's horizontal alignment when it is anchored to a paragraph.
setBackColor	Sets the background color for the text frame.
setBorderColor	Sets the border color for the text frame.
setBorderStyle	Sets the style of a text frame's border line.
setBorderWidth	Sets the width, in twips, of a text frame's border line.
setID	Sets an identifier for the frame.
setInsertionMode	Sets a value determining whether the frame is treated as a single character or the document's text either flows around or overwrites the frame.
setInternalMargins	Sets the distances, in twips, between the text frame's border line and the text.
setLocation	Sets, in twips, the frame's current location.
setMoveable	Sets whether a frame can be moved in the document at run time with the built-in mouse interface.
setName	Sets a name for the frame.
setSize	Sets the frame's size in twips.
setSizeable	Sets whether the frame can be resized at run time with the built-in mouse interface.
setTextDistances	Sets the distances, in twips, between the frame and the document's text.
setTransparency	Sets the text frame's transparency.

Properties

Property	Description
applicationFields	Gets a collection of all Microsoft Word fields that have been created or imported from a Microsoft Word or RTF document. (Inherited from FormattedText)
comments	Gets a collection of all comments in this text part. (Inherited from FormattedText)
documentLinks	Gets a collection of all links which point to targets in the same document. (Inherited from FormattedText)
documentTargets	Gets a collection of all document targets. (Inherited from FormattedText)
editableRegions	Gets a collection of all editable regions. (Inherited from FormattedText)
formFields	Gets a collection of all form fields in the text part. (Inherited from FormattedText)
frames	Gets a collection of all frames in the document. (Inherited from FormattedText)
hypertextLinks	Gets a collection of all hypertext links. (Inherited from FormattedText)
lines	Gets a collection of all text lines. (Inherited from FormattedText)
misspelledWords	Gets a collection of all misspelled words. (Inherited from FormattedText)
paragraphs	Gets a collection of all paragraphs. (Inherited from FormattedText)
selection	Gets the current selection. (Inherited from FormattedText)
subTextParts	Gets the current subtextparts. (Inherited from FormattedText)
tables	Gets a collection of all tables. (Inherited from FormattedText)
tablesOfContents	Gets the current tables of contents. (Inherited from FormattedText)
textChars	Gets a collection of all text characters. (Inherited from FormattedText)
textFields	Gets a collection of all standard text fields. (Inherited from FormattedText)
textPartType	Gets the Text part type. (Inherited from FormattedText)
trackedChanges	Gets a collection of all tracked changes. (Inherited from FormattedText)