Text Frames

A text frame is a rectangle that can be filled with text by an end-user and that can be edited like the main text. A text frame can be positioned like an image, either geometrically or as a single character. Geometrically its position can either be relative to a paragraph to which it is anchored or relative to a document's page. Text frames can be inserted, deleted and manipulated through the TextFrameCollection class that can be obtained through the TextControl.TextFrames Property. A text frame is fully programable from program code. The TextFrame class provides properties and methods that enable a programmer to manipulate a text frame's text in the same way as the document's main text. Further properties set text frame attributes, such as the width of the border line, internal margins and the background color.

Classes

Class Description
TXTextControl.TextFrame An instance of the TextFrame class represents a text frame in a Text Control document.
TXTextControl.TextFrameCollection An instance of the TextFrameCollection class contains all text frames in a Text Control document or part of the document represented through objects of the type TextFrame.
TXTextControl.TextFrameEventArgs The TextFrameEventArgs class provides data for all events that occur with text frames.

Constructors

Constructor Description
TXTextControl.TextFrame Initializes a new instance of the TextFrame class.

Events

Event Description
TXTextControl.ServerTextControl.TextFrameCreated Occurs when a new text frame has been created.
TXTextControl.ServerTextControl.TextFrameDeleted Occurs when a text frame has been deleted.

Methods

Method Description
TXTextControl.ServerTextControl.OnTextFrameCreated Raises the TextFrameCreated event.
TXTextControl.ServerTextControl.OnTextFrameDeleted Raises the TextFrameDeleted event.
TXTextControl.TextFrame.Activate Activates the text frame.
TXTextControl.TextFrame.Find Finds a text string in a text frame.
TXTextControl.TextFrame.GetTextFields Returns a collection containing text fields of the specified types.
TXTextControl.TextFrameCollection.Add Inserts a new text frame in a Text Control document.
TXTextControl.TextFrameCollection.CopyTo Copies the elements of the collection to an array, starting at a particular index.
TXTextControl.TextFrameCollection.DeactivateItem Deactivates the activated text frame and sets the input focus back to the text part that contains the text frame.
TXTextControl.TextFrameCollection.GetActivatedItem Returns the currently activated text frame.
TXTextControl.TextFrameCollection.GetItem Gets a particular text frame from the collection.
TXTextControl.TextFrameCollection.Remove Removes a text frame from a Text Control document.

Properties

Property Description
TXTextControl.ServerTextControl.TextFrames Gets a collection of all text frames the current document contains.
TXTextControl.TextFrame.ApplicationFields Gets a collection of all Microsoft Word or Heiler HighEdit fields that have been created or imported from a Microsoft Word or RTF document.
TXTextControl.TextFrame.BackColor Gets or sets the background color of a text frame.
TXTextControl.TextFrame.Barcodes Gets a collection of all barcodes contained in a text frame.
TXTextControl.TextFrame.BorderWidth Gets or sets the width, in twips, of a text frame's border line.
TXTextControl.TextFrame.Charts Gets a collection of all charts contained in a text frame.
TXTextControl.TextFrame.DocumentLinks Gets a collection of all links in a text frame which point to targets in the same document.
TXTextControl.TextFrame.DocumentTargets Gets a collection of all targets in a text frame.
TXTextControl.TextFrame.Drawings Gets a collection of all drawings contained in a text frame.
TXTextControl.TextFrame.EditableRegions Gets a collection of all editable regions in the text frame.
TXTextControl.TextFrame.FormFields Gets a collection of all form fields contained in a text frame.
TXTextControl.TextFrame.Frames Gets a collection of all images, textframes, charts, barcodes and drawings in a text frame.
TXTextControl.TextFrame.HypertextLinks Gets a collection of all hypertext links in a text frame.
TXTextControl.TextFrame.Images Gets a collection of all images contained in a text frame.
TXTextControl.TextFrame.InsertionMode (Only for compatibility) Gets or sets a value determining whether a text frame is treated as a single character or the document's text either flows around or overwrites the text frame.
TXTextControl.TextFrame.InternalMargins Gets or sets the distances, in twips, between the text frame's border line and the text.
TXTextControl.TextFrame.Lines Gets a collection of all text lines contained in a text frame.
TXTextControl.TextFrame.MisspelledWords Gets a collection of all misspelled words the text frame contains.
TXTextControl.TextFrame.Paragraphs Gets a collection of all paragraphs contained in a text frame.
TXTextControl.TextFrame.Selection Gets or sets the current selection in a text frame.
TXTextControl.TextFrame.SubTextParts Gets a collection of all subtextparts in a text frame.
TXTextControl.TextFrame.Tables Gets a collection of all tables in a text frame.
TXTextControl.TextFrame.TextChars Gets a collection of all characters contained in a text frame.
TXTextControl.TextFrame.TextFields Gets a collection of all standard text fields in a text frame.
TXTextControl.TextFrame.TrackedChanges Gets a collection of all changes made in a text frame.
TXTextControl.TextFrame.Transparency Gets or sets the text frame's transparency.
TXTextControl.TextFrameEventArgs.TextFrame Gets an object that represents the text frame which causes the event.