Load Method
- Namespace
TXTextControl
- Package
TXTextControl.asTextControl. Core. SDK TXTextControl.from the private NuGet feed or Text Control Offline PackagesServer. Core. dll
- Also in
TXTextControl.asTextControl. ASP. SDK TXTextControl.Server. dll
Description
Loads text in a certain format. The complete contents of a Text Control are replaced.
Syntax
Load(string, StreamType)
Loads text formatted with the specified format. The new text is read from the specified file.
public void Load(string path, StreamType streamType);Public Sub Load(path As String, streamType As StreamType)| Parameter | Description |
|---|---|
| path | Specifies a file from which the data is loaded. |
| streamType | Specifies one of the StreamType values. |
Load(FileStream, StreamType)
Loads text formatted with the specified format. The new text is read from the specified file stream.
public void Load(FileStream fileStream, StreamType streamType);Public Sub Load(fileStream As FileStream, streamType As StreamType)| Parameter | Description |
|---|---|
| fileStream | Specifies a file from which the data is loaded. The data is loaded from the stream's current position. |
| streamType | Specifies one of the StreamType values. |
Load(byte[], BinaryStreamType)
Loads text formatted with the specified format. The new text is read from the specified byte array.
public void Load(byte[] binaryData, BinaryStreamType binaryStreamType);Public Sub Load(binaryData As Byte(), binaryStreamType As BinaryStreamType)| Parameter | Description |
|---|---|
| binaryData | Specifies a byte array from which the data is loaded. |
| binaryStreamType | Specifies one of the BinaryStreamType values. |
Load(string, StringStreamType)
Loads text formatted with the specified format. The new text is read from the specified string.
public void Load(string stringData, StringStreamType stringStreamType);Public Sub Load(stringData As String, stringStreamType As StringStreamType)| Parameter | Description |
|---|---|
| stringData | Specifies a string from which the data is loaded. |
| stringStreamType | Specifies one of the StringStreamType values. |
Load(string, StreamType, LoadSettings)
Loads text formatted with the specified format. The new text is read from the specified file and loaded using the given special settings.
public void Load(string path, StreamType streamType, LoadSettings loadSettings);Public Sub Load(path As String, streamType As StreamType, loadSettings As LoadSettings)| Parameter | Description |
|---|---|
| path | Specifies a file from which the data is loaded. |
| streamType | Specifies one of the StreamType values. |
| loadSettings | Specifies a LoadSettings object with additional information and settings for the load operation. |
Load(FileStream, StreamType, LoadSettings)
Loads text formatted with the specified format. The new text is read from the specified file stream and loaded using the given special settings.
public void Load(FileStream fileStream, StreamType streamType, LoadSettings loadSettings);Public Sub Load(fileStream As FileStream, streamType As StreamType, loadSettings As LoadSettings)| Parameter | Description |
|---|---|
| fileStream | Specifies a file from which the data is loaded. The data is loaded from the stream's current position. |
| streamType | Specifies one of the StreamType values. |
| loadSettings | Specifies a LoadSettings object with additional information and settings for the load operation. |
Load(byte[], BinaryStreamType, LoadSettings)
Loads text formatted with the specified format. The new text is read from the specified byte array and loaded using the given special settings.
public void Load(byte[] binaryData, BinaryStreamType binaryStreamType, LoadSettings loadSettings);Public Sub Load(binaryData As Byte(), binaryStreamType As BinaryStreamType, loadSettings As LoadSettings)| Parameter | Description |
|---|---|
| binaryData | Specifies a byte array from which the data is loaded. |
| binaryStreamType | Specifies one of the BinaryStreamType values. |
| loadSettings | Specifies a LoadSettings object with additional information and settings for the load operation. |
Load(string, StringStreamType, LoadSettings)
Loads text formatted with the specified format. The new text is read from the specified string and loaded using the given special settings.
public void Load(string stringData, StringStreamType stringStreamType, LoadSettings loadSettings);Public Sub Load(stringData As String, stringStreamType As StringStreamType, loadSettings As LoadSettings)| Parameter | Description |
|---|---|
| stringData | Specifies a string from which the data is loaded. |
| stringStreamType | Specifies one of the StringStreamType values. |
| loadSettings | Specifies a LoadSettings object with additional information and settings for the load operation. |
Load(string, StreamType, ref LoadSettings, out byte[])
public void Load(string path, StreamType streamType, ref LoadSettings loadSettings, out byte[] internalFormat);Public Sub Load(path As String, streamType As StreamType, ByRef loadSettings As LoadSettings, ByRef internalFormat As Byte())Examples
The following example loads a small RTF document directly from an in-memory string.
string rtf = @"{\rtf1\ansi\b Quarterly results\b0\par Revenue increased by 12%.}";
textControl.Load(rtf, StringStreamType.RichTextFormat);Dim rtf As String = "{\rtf1\ansi\b Quarterly results\b0\par Revenue increased by 12%.}"
textControl.Load(rtf, StringStreamType.RichTextFormat)