TXTextControl.TextFrameCollection.Add Method

Inserts a new text frame in a Text Control document.

Add(TextFrame, Int32)

Inserts a text frame inline, which means that it is treated in the text like a single character. The frame is inserted at the specified text position.

[C#]
public bool Add(TextFrame textFrame, int textPosition);
[Visual Basic]
Public Function Add(ByVal textFrame As TextFrame, ByVal textPosition As Integer) As Boolean
Parameter Description
textFrame

Specifies the text frame to add.

textPosition

Specifies the text position at which the text frame is to be inserted. If -1 is specified, the text frame is inserted at the current input position.

Add(TextFrame, HorizontalAlignment, Int32, TextFrameInsertionMode)

Inserts a text frame which is anchored to the paragraph containing the specified text position. The frame has the specified horizontal alignment. TextFrameInsertionMode.FixedOnPage and TextFrameInsertionMode.AsCharacter cannot be specified with this overload.

[C#]
public bool Add(TextFrame textFrame, HorizontalAlignment alignment, int textPosition, TextFrameInsertionMode insertionMode);
[Visual Basic]
Public Function Add(ByVal textFrame As TextFrame, ByVal alignment As HorizontalAlignment, _
  ByVal textPosition As Integer, ByVal insertionMode As TextFrameInsertionMode) As Boolean
Parameter Description
textFrame

Specifies the text frame to add.

alignment

Specifies the text frame's horizontal alignment. It can be one of the HorizontalAlignment values:


Value Meaning
Left The text frame is left aligned relative to the paragraph to which it is anchored.
Right The text frame is right aligned relative to the paragraph to which it is anchored.
Centered The text frame is centered relative to the paragraph to which it is anchored.
Justify This value is not possible for the alignment of text frames.
textPosition

Specifies the text position at which the text frame is to be inserted. If -1 is specified, the text frame is inserted at the current input position.

insertionMode

Specifies how the text flow is handled. It can be one of the values of the TextFrameInsertionMode enumeration.

Add(TextFrame, Point, Int32, TextFrameInsertionMode)

Inserts a text frame which is anchored to the paragraph containing the specified text position. The frame has the specified position relative to the paragraph containing its anchor position. TextFrameInsertionMode.FixedOnPage and TextFrameInsertionMode.AsCharacter cannot be specified with this overload.

[C#]
public bool Add(TextFrame textFrame, System.Drawing.Point location, int textPosition, TextFrameInsertionMode insertionMode);
[Visual Basic]
Public Function Add(ByVal textFrame As TextFrame, ByVal location As System.Drawing.Point, ByVal textPosition As Integer, _
  ByVal insertionMode As TextFrameInsertionMode) As Boolean
Parameter Description
textFrame

Specifies the text frame to add.

location

Specifies the location, in twips, at which the text frame is to be inserted. This is a location relative to the top left corner either of a page or of a paragraph.

textPosition

Specifies the text position at which the text frame is to be inserted. If -1 is specified, the text frame is inserted at the current input position.

insertionMode

Specifies how the text flow is handled. It can be one of the values of the TextFrameInsertionMode enumeration.

Add(TextFrame, Int32, Point, TextFrameInsertionMode)

Inserts a text frame that has a fixed geometrical position in the document. This position is specified through a page number and a location on this page. TextFrameInsertionMode.MoveWithText and TextFrameInsertionMode.AsCharacter cannot be specified with this overload.

[C#]
public bool Add(TextFrame textFrame, int page, System.Drawing.Point location, TextFrameInsertionMode insertionMode);
[Visual Basic]
Public Function Add(ByVal textFrame As TextFrame, ByVal page As Integer, ByVal location As System.Drawing.Point, _
  ByVal insertionMode As TextFrameInsertionMode) As Boolean
Parameter Description
textFrame

Specifies the text frame to add.

page

Specifies the number of a page beginning with 1 where the text frame is located.

location

Specifies the location, in twips, at which the text frame is to be inserted. This is a location relative to the top left corner either of a page or of a paragraph.

insertionMode

Specifies how the text flow is handled. It can be one of the values of the TextFrameInsertionMode enumeration.

Add(TextFrame, Point, TextFrameInsertionMode)

Inserts a text frame that has a fixed geometrical position in the document. This location is specified through a document position relative to the top left corner of the complete document. TextFrameInsertionMode.MoveWithText and TextFrameInsertionMode.AsCharacter cannot be specified with this overload.

[C#]
public bool Add(TextFrame textFrame, System.Drawing.Point location, TextFrameInsertionMode insertionMode);
[Visual Basic]
Public Function Add(ByVal textFrame As TextFrame, ByVal location As System.Drawing.Point, _
  ByVal insertionMode As TextFrameInsertionMode) As Boolean
Parameter Description
textFrame

Specifies the text frame to add.

location

Specifies the location, in twips, at which the text frame is to be inserted. This is a location relative to the top left corner either of a page or of a paragraph.

insertionMode

Specifies how the text flow is handled. It can be one of the values of the TextFrameInsertionMode enumeration.

Add(TextFrame, TextFrameInsertionMode)

Inserts a text frame with the built-in mouse interface. The text frame's size is determined through the end-user. A cross cursor indicates where the text frame can be inserted. Changing the document or pressing the ESC key aborts the insertion process.

[C#]
public bool Add(TextFrame textFrame, TextFrameInsertionMode insertionMode);
[Visual Basic]
Public Function Add(ByVal textFrame As TextFrame, ByVal insertionMode As TextFrameInsertionMode) As Boolean
Parameter Description
textFrame

Specifies the text frame to add.

insertionMode

Specifies how the text flow is handled. It can be one of the values of the TextFrameInsertionMode enumeration.

Return Value

The return value is true, if the text frame could be added. Otherwise, it is false.

See Also