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.FrameBase The FrameBase class is the base class of the Image, TextFrame, ChartFrame, BarcodeFrame and DrawingFrame classes.
TXTextControl.FrameBaseCollection The FrameBaseCollection class is the base class of the ImageCollection and TextFrameCollection classes.
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.

Properties

Property Description
TXTextControl.ServerTextControl.TextFrames Gets a collection of all text frames the current document contains.
TXTextControl.TextControl.TextFrameMarkerLines Specifies whether text frames that have no border line are shown with marker lines.
TXTextControl.TextControl.TextFrames Gets a collection of all text frames contained in the text part with the input focus.
TXTextControl.WPF.TextControl.TextFrameMarkerLines Specifies whether text frames that have no border line are shown with marker lines.
TXTextControl.WPF.TextControl.TextFrames Gets a collection of all text frames contained in the text part with the input focus.

Methods

Method Description
TXTextControl.ServerTextControl.OnTextFrameCreated Raises the TextFrameCreated event.
TXTextControl.ServerTextControl.OnTextFrameDeleted Raises the TextFrameDeleted event.
TXTextControl.TextControl.OnTextFrameActivated Raises the TextFrameActivated event.
TXTextControl.TextControl.OnTextFrameClicked Raises the TextFrameClicked event.
TXTextControl.TextControl.OnTextFrameCreated Raises the TextFrameCreated event.
TXTextControl.TextControl.OnTextFrameDeactivated Raises the TextFrameDeactivated event.
TXTextControl.TextControl.OnTextFrameDeleted Raises the TextFrameDeleted event.
TXTextControl.TextControl.OnTextFrameDeselected Raises the TextFrameDeselected event.
TXTextControl.TextControl.OnTextFrameDoubleClicked Raises the TextFrameDoubleClicked event.
TXTextControl.TextControl.OnTextFrameMoved Raises the TextFrameMoved event.
TXTextControl.TextControl.OnTextFrameRightClicked Raises the TextFrameRightClicked event.
TXTextControl.TextControl.OnTextFrameSelected Raises the TextFrameSelected event.
TXTextControl.TextControl.OnTextFrameSized Raises the TextFrameSized event.
TXTextControl.TextControl.TextFrameAttributesDialog Invokes the built-in dialog box for setting attributes of text frames.
TXTextControl.WPF.TextControl.OnTextFrameActivated Raises the TextFrameActivated event.
TXTextControl.WPF.TextControl.OnTextFrameClicked Raises the TextFrameClicked event.
TXTextControl.WPF.TextControl.OnTextFrameCreated Raises the TextFrameCreated event.
TXTextControl.WPF.TextControl.OnTextFrameDeactivated Raises the TextFrameDeactivated event.
TXTextControl.WPF.TextControl.OnTextFrameDeleted Raises the TextFrameDeleted event.
TXTextControl.WPF.TextControl.OnTextFrameDeselected Raises the TextFrameDeselected event.
TXTextControl.WPF.TextControl.OnTextFrameDoubleClicked Raises the TextFrameDoubleClicked event.
TXTextControl.WPF.TextControl.OnTextFrameMoved Raises the TextFrameMoved event.
TXTextControl.WPF.TextControl.OnTextFrameRightClicked Raises the TextFrameRightClicked event.
TXTextControl.WPF.TextControl.OnTextFrameSelected Raises the TextFrameSelected event.
TXTextControl.WPF.TextControl.OnTextFrameSized Raises the TextFrameSized event.
TXTextControl.WPF.TextControl.TextFrameAttributesDialog Invokes the built-in dialog box for setting attributes of text frames.

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.
TXTextControl.TextControl.TextFrameActivated Occurs when a text frame has been activated.
TXTextControl.TextControl.TextFrameAppearanceChanged Occurs when the appearance of a text frame (background color, transparency, border, inner margins) has been changed.
TXTextControl.TextControl.TextFrameClicked Occurs when a text frame has been clicked on.
TXTextControl.TextControl.TextFrameCreated Occurs when a new text frame has been created.
TXTextControl.TextControl.TextFrameDeactivated Occurs when a text frame has been deactivated.
TXTextControl.TextControl.TextFrameDeleted Occurs when a text frame has been deleted.
TXTextControl.TextControl.TextFrameDeselected Occurs when a text frame has been deselected.
TXTextControl.TextControl.TextFrameDoubleClicked Occurs when a text frame has been doubleclicked on.
TXTextControl.TextControl.TextFrameMoved Occurs when a text frame has been moved.
TXTextControl.TextControl.TextFrameRightClicked Occurs when a text frame has been clicked on with the right mouse button.
TXTextControl.TextControl.TextFrameSelected Occurs when a text frame has been selected.
TXTextControl.TextControl.TextFrameSized Occurs when a text frame has been sized.
TXTextControl.WPF.TextControl.TextFrameActivated Occurs when a text frame has been activated.
TXTextControl.WPF.TextControl.TextFrameAppearanceChanged Occurs when the appearance of a text frame (background color, transparency, border, inner margins) has been changed.
TXTextControl.WPF.TextControl.TextFrameClicked Occurs when a text frame has been clicked on.
TXTextControl.WPF.TextControl.TextFrameCreated Occurs when a new text frame has been created.
TXTextControl.WPF.TextControl.TextFrameDeactivated Occurs when a text frame has been deactivated.
TXTextControl.WPF.TextControl.TextFrameDeleted Occurs when a text frame has been deleted.
TXTextControl.WPF.TextControl.TextFrameDeselected Occurs when a text frame has been deselected.
TXTextControl.WPF.TextControl.TextFrameDoubleClicked Occurs when a text frame has been doubleclicked on.
TXTextControl.WPF.TextControl.TextFrameMoved Occurs when a text frame has been moved.
TXTextControl.WPF.TextControl.TextFrameRightClicked Occurs when a text frame has been clicked on with the right mouse button.
TXTextControl.WPF.TextControl.TextFrameSelected Occurs when a text frame has been selected.
TXTextControl.WPF.TextControl.TextFrameSized Occurs when a text frame has been sized.