Save Method
- Namespace
TXTextControl
- Package
TXTextControl.asTextControl. WPF. SDK TXTextControl.from the private NuGet feed or Text Control Offline Packagesdll
Description
Saves the commented text with the specified format.
Syntax
Save(out byte[], BinaryStreamType)
Saves the commented 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 commented 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 commented 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 commented 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 commented 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 commented 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 commented 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 commented 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 attaches a reviewer comment to selected contract text by using CommentedText.Save.
textControl.Text = "Payment is due within 30 days.";
textControl.Select(0, textControl.Text.Length);
CommentedText commentedText = new("Verify the payment term.");
textControl.Comments.Add(commentedText);
string stringData = @"{\rtf1\ansi Sample document}";
commentedText.Save(out stringData, StringStreamType.RichTextFormat);textControl.Text = "Payment is due within 30 days."
textControl.Select(0, textControl.Text.Length)
Dim commentedText As New CommentedText("Verify the payment term.")
textControl.Comments.Add(commentedText)
Dim stringData As String = "{\rtf1\ansi Sample document}"
commentedText.Save(stringData, StringStreamType.RichTextFormat)