[]
        
(Showing Draft Content)

GrapeCity.Documents.Text.TextLayout.Append

Append Method

Append(string)

Adds a text run with default formatting to the end of the Inlines collection.

Declaration
public TextRun Append(string text)
Public Function Append(text As String) As TextRun
Parameters
Type Name Description
string text

The text to append.

Returns
Type Description
TextRun

The created text run.

Append(int[])

Adds a text run with default formatting to the end of the Inlines collection.

Declaration
public TextRun Append(int[] codePoints)
Public Function Append(codePoints As Integer()) As TextRun
Parameters
Type Name Description
int[] codePoints

An array of UTF-32 characters (code points).

Returns
Type Description
TextRun

The created text run.

Append(int[], int, int)

Adds a text run with default formatting to the end of the Inlines collection.

Declaration
public TextRun Append(int[] codePoints, int startIndex, int count)
Public Function Append(codePoints As Integer(), startIndex As Integer, count As Integer) As TextRun
Parameters
Type Name Description
int[] codePoints

An array of UTF-32 characters (code points).

int startIndex

Index of the first code point in the subrange.

int count

Number of code points in the subrange.

Returns
Type Description
TextRun

The created text run.

Append(string, TextFormat)

Adds a text run with the specified format to the end of the Inlines collection.

Declaration
public TextRun Append(string text, TextFormat format)
Public Function Append(text As String, format As TextFormat) As TextRun
Parameters
Type Name Description
string text

The text to append.

TextFormat format

The text format to use.

Returns
Type Description
TextRun

The created text run.

Append(int[], TextFormat)

Adds a text run with the specified format to the end of the Inlines collection.

Declaration
public TextRun Append(int[] codePoints, TextFormat format)
Public Function Append(codePoints As Integer(), format As TextFormat) As TextRun
Parameters
Type Name Description
int[] codePoints

An array of UTF-32 characters (code points).

TextFormat format

The text format to use.

Returns
Type Description
TextRun

The created text run.

Append(int[], TextFormat, IGcTag)

Adds a text run with the specified format to the end of the Inlines collection.

Declaration
public TextRun Append(int[] codePoints, TextFormat format, IGcTag gcTag)
Public Function Append(codePoints As Integer(), format As TextFormat, gcTag As IGcTag) As TextRun
Parameters
Type Name Description
int[] codePoints

An array of UTF-32 characters (code points).

TextFormat format

The text format to use.

IGcTag gcTag

The tag associated with the text.

Returns
Type Description
TextRun

The created text run.

Append(int[], int, int, TextFormat)

Adds a text run with the specified format to the end of the Inlines collection.

Declaration
public TextRun Append(int[] codePoints, int startIndex, int count, TextFormat format)
Public Function Append(codePoints As Integer(), startIndex As Integer, count As Integer, format As TextFormat) As TextRun
Parameters
Type Name Description
int[] codePoints

An array of UTF-32 characters (code points).

int startIndex

Index of the first code point in the subrange.

int count

Number of code points in the subrange.

TextFormat format

The text format to use.

Returns
Type Description
TextRun

The created text run.

Append(int[], int, int, TextFormat, IGcTag)

Adds a text run with the specified format to the end of the Inlines collection.

Declaration
public TextRun Append(int[] codePoints, int startIndex, int count, TextFormat format, IGcTag gcTag)
Public Function Append(codePoints As Integer(), startIndex As Integer, count As Integer, format As TextFormat, gcTag As IGcTag) As TextRun
Parameters
Type Name Description
int[] codePoints

An array of UTF-32 characters (code points).

int startIndex

Index of the first code point in the subrange.

int count

Number of code points in the subrange.

TextFormat format

The text format to use.

IGcTag gcTag

The tag associated with the text.

Returns
Type Description
TextRun

The created text run.

Append(InlineObject, bool)

Adds an inline object, or a copy of it, to the end of the Inlines collection.

If adding the same inline object multiple times, make sure to pass true as the addCopy parameter.

Declaration
public InlineObject Append(InlineObject inlineObject, bool addCopy = true)
Public Function Append(inlineObject As InlineObject, Optional addCopy As Boolean = True) As InlineObject
Parameters
Type Name Description
InlineObject inlineObject

The inline object to add or copy.

bool addCopy

If true, a copy of the inlineObject will be created and added. Otherwise, the passed object itself will be added.

Returns
Type Description
InlineObject

The appended inline object.

Append(AnchoredObject, bool)

Adds an anchored object, or a copy of it, to the end of the Inlines collection.

If adding the same anchored object multiple times, make sure to pass true as the addCopy parameter.

Declaration
public AnchoredObject Append(AnchoredObject anchoredObject, bool addCopy = true)
Public Function Append(anchoredObject As AnchoredObject, Optional addCopy As Boolean = True) As AnchoredObject
Parameters
Type Name Description
AnchoredObject anchoredObject

The anchored object to add or copy.

bool addCopy

If true, a copy of the anchoredObject will be created and added. Otherwise, the passed object itself will be added.

Returns
Type Description
AnchoredObject

The appended anchored object.