Description

Saves the footnote's text with the specified format including the footnote mark in front of the text.

Syntax

Save(out byte[], BinaryStreamType)

Saves the footnote's text 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 footnote's 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 footnote's text 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 footnote's 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 footnote's text 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 footnote's 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 footnote's text 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 footnote's 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 adds and configures a source note at the current input position by using Footnote.Save.

Footnote footnote = new("Source: FY 2026 annual report");
textControl.Footnotes.Add(footnote, false);

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

Dim footnote As New Footnote("Source: FY 2026 annual report")
textControl.Footnotes.Add(footnote, False)

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

Save Method