TableOfContents.Save Method — TX Text Control .NET Server

Description

Saves the text of the table of contents with the specified format.

Syntax

Save(out byte[], BinaryStreamType)

Saves the text of the table of contents in a byte array with the specified format.

public void Save(out byte[] binaryData, BinaryStreamType binaryStreamType);

Public Sub Save(ByRef binaryData As Byte(), binaryStreamType As BinaryStreamType)

Parameter	Description
binaryData	Specifies a byte array into which the text is saved. No memory needs to be allocated through the caller.
binaryStreamType	Specifies one of the BinaryStreamType values.

Save(out string, StringStreamType)

Saves the text of the table of contents as a string with the specified format.

public void Save(out string stringData, StringStreamType stringStreamType);

Public Sub Save(ByRef stringData As String, stringStreamType As StringStreamType)

Parameter	Description
stringData	Specifies a string into which the text is saved. No memory needs to be allocated through the caller.
stringStreamType	Specifies one of the StringStreamType values.

Save(out byte[], BinaryStreamType, SaveSettings)

Saves the text of the table of contents in a byte array with the specified format and special settings.

public void Save(out byte[] binaryData, BinaryStreamType binaryStreamType, SaveSettings saveSettings);

Public Sub Save(ByRef binaryData As Byte(), binaryStreamType As BinaryStreamType, saveSettings As SaveSettings)

Parameter	Description
binaryData	Specifies a byte array into which the text is saved. No memory needs to be allocated through the caller.
binaryStreamType	Specifies one of the BinaryStreamType values.
saveSettings	Specifies a SaveSettings object with additional information and settings for the save operation.

Save(out string, StringStreamType, SaveSettings)

Saves the text of the table of contents as a string with the specified format and special settings.

public void Save(out string stringData, StringStreamType stringStreamType, SaveSettings saveSettings);

Public Sub Save(ByRef stringData As String, stringStreamType As StringStreamType, saveSettings As SaveSettings)

Parameter	Description
stringData	Specifies a string into which the text is saved. No memory needs to be allocated through the caller.
stringStreamType	Specifies one of the StringStreamType values.
saveSettings	Specifies a SaveSettings object with additional information and settings for the save operation.

Examples

The following example creates a table of contents for the document's heading styles by using TableOfContents.Save.

TableOfContents tableOfContents = new(1, 3) { Name = "Contents", ID = 10 };
textControl.TablesOfContents.Add(tableOfContents);

string stringData = @"{\rtf1\ansi Sample document}";
tableOfContents.Save(out stringData, StringStreamType.RichTextFormat);

Dim tableOfContents As New TableOfContents(1, 3) With { .Name = "Contents", .ID = 10 }
textControl.TablesOfContents.Add(tableOfContents)

Dim stringData As String = "{\rtf1\ansi Sample document}"
tableOfContents.Save(stringData, StringStreamType.RichTextFormat)