Add Method
- Namespace
TXTextControl
- Package
TXTextControl.asTextControl. WinForms. SDK TXTextControl.from the private NuGet feed or Text Control Offline Packagesdll
Description
Inserts a new text frame in a Text Control document.
Syntax
Add(TextFrame, int)
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.
public bool Add(TextFrame textFrame, int textPosition);Public Function Add(textFrame As TextFrame, 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, int, 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.
public bool Add(TextFrame textFrame, HorizontalAlignment alignment, int textPosition, TextFrameInsertionMode insertionMode);Public Function Add(textFrame As TextFrame, alignment As HorizontalAlignment, textPosition As Integer, 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:
| ||||||||||
| 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, int, 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.
public bool Add(TextFrame textFrame, Point location, int textPosition, TextFrameInsertionMode insertionMode);Public Function Add(textFrame As TextFrame, location As Point, textPosition As Integer, 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, int, 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.
public bool Add(TextFrame textFrame, int pageNumber, Point location, TextFrameInsertionMode insertionMode);Public Function Add(textFrame As TextFrame, pageNumber As Integer, location As Point, insertionMode As TextFrameInsertionMode) As Boolean| Parameter | Description |
|---|---|
| textFrame | Specifies the text frame to add. |
| pageNumber | 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.
public bool Add(TextFrame textFrame, Point location, TextFrameInsertionMode insertionMode);Public Function Add(textFrame As TextFrame, location As Point, 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.
public bool Add(TextFrame textFrame, TextFrameInsertionMode insertionMode);Public Function Add(textFrame As TextFrame, 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.
Examples
The following example works with text frames in the current document by using TextFrameCollection.Add.
TextFrameCollection textFrameCollection = textControl.TextFrames;
if (!textFrameCollection.Add(new TextFrame(new System.Drawing.Size(600, 400)), -1))
{
throw new InvalidOperationException("The item could not be inserted.");
}Dim textFrameCollection As TextFrameCollection = textControl.TextFrames
If Not textFrameCollection.Add(New TextFrame(New System.Drawing.Size(600, 400)), -1) Then
Throw New InvalidOperationException("The item could not be inserted.")
End If