TX Text Control .NET for Windows Forms Documentation

TextControl.Append Method

Loads text in a certain format from a file, a byte array or a string and appends it to the existing document. If neither a file path nor a byte array or string is specified, a TextControl opens a file open dialog box to select a file.

Introduced: 14.0.

Syntax

[C#] public DialogResult Append(AppendSettings appendSettings); public DialogResult Append(StreamType streamType, AppendSettings appendSettings); public void Append(string path, StreamType streamType, AppendSettings appendSettings); public void Append(FileStream fileStream, StreamType streamType, AppendSettings appendSettings); public void Append(byte[] binaryData, BinaryStreamType binaryStreamType, AppendSettings appendSettings); public void Append(string stringData, StringStreamType stringStreamType, AppendSettings appendSettings); public DialogResult Append(StreamType streamType, LoadSettings loadSettings, AppendSettings appendSettings); public void Append(string path, StreamType streamType, LoadSettings loadSettings, AppendSettings appendSettings); public void Append(FileStream fileStream, StreamType streamType, LoadSettings loadSettings, AppendSettings appendSettings); public void Append(byte[] binaryData, BinaryStreamType binaryStreamType, LoadSettings loadSettings); public void Append(string stringData, StringStreamType stringStreamType, LoadSettings loadSettings, AppendSettings appendSettings);
[Visual Basic] Public Function Append(ByVal appendSettings As AppendSettings) As DialogResult Public Function Append(ByVal streamType As StreamType, ByVal appendSettings As AppendSettings) As DialogResult Public Sub Append(ByVal path As String, ByVal streamType As StreamType, ByVal appendSettings As AppendSettings) Public Sub Append(ByVal fileStream As FileStream, ByVal streamType As StreamType, ByVal appendSettings As AppendSettings) Public Sub Append(ByVal binaryData As Byte(), ByVal binaryStreamType As BinaryStreamType, ByVal appendSettings As AppendSettings) Public Sub Append(ByVal stringData As String, ByVal stringStreamType As StringStreamType, ByVal appendSettings As AppendSettings) Public Function Append(ByVal streamType As StreamType, ByVal loadSettings As LoadSettings, ByVal appendSettings As AppendSettings) As DialogResult Public Sub Append(ByVal path As String, ByVal streamType As StreamType, ByVal loadSettings As LoadSettings, ByVal appendSettings As AppendSettings) Public Sub Append(ByVal fileStream As FileStream, ByVal streamType As StreamType, ByVal loadSettings As LoadSettings, ByVal appendSettings As AppendSettings) Public Sub Append(ByVal binaryData As Byte(), ByVal binaryStreamType As BinaryStreamType, ByVal loadSettings As LoadSettings) public void Append(string stringData, StringStreamType stringStreamType, LoadSettings loadSettings, AppendSettings appendSettings);
MemberDescription
appendSettings

Specifies settings on how the document is appended. It can be one of the following values:


ValueMeaning
NoneThe loaded text is inserted at the end of last paragraph of the existing document.
StartWithNewParagraphA new paragraph is created at the end of the document and the text is inserted in this paragraph.
StartWithNewSectionA new section is created at the end of the document and the text is inserted in this section.
streamType

Specifies one of the StreamType values.

path

Specifies a file from which the data is loaded.

fileStream

Specifies a file from which the data is loaded. The data is loaded from the stream's current position.

binaryData

Specifies a byte array from which the data is loaded.

stringData

Specifies a string from which the data is loaded.

binaryStreamType

Specifies one of the BinaryStreamType values.

stringStreamType

Specifies one of the StringStreamType values.

loadSettings

Specifies a LoadSettings object with additional information and settings for the load operation.

Return Value

The implementations that open a dialog box return the dialog's result value.

See Also

 
 
 

Products

Support

Downloads

Corporate

Buy Now