TXTextControl.LoadSettings Class - TX Text Control .NET Server for ASP.NET

TX Text Control .NET Server for ASP.NETReference GuideTXTextControl NamespaceLoadSettings Class

The LoadSettings class provides properties for advanced settings and information during load operations. See the TextControl.Load method for more information.

Syntax

C#
VB.NET

public sealed class LoadSettings : LoadSaveSettingsBase

Public NotInheritable Class LoadSettings
  Inherits LoadSaveSettingsBase

Examples

The following example shows how to use the LoadSettings to get the filename and the read bytes of a loaded document.

C#
VB.NET

TXTextControl.LoadSettings ls = new TXTextControl.LoadSettings();

if (textControl1.Load(TXTextControl.StreamType.All, ls) == System.Windows.Forms.DialogResult.OK)
{
    System.Windows.Forms.MessageBox.Show(ls.LoadedFile + " has been loaded. " + ls.BytesRead.ToString() + " bytes read.");
}

Dim ls As TXTextControl.LoadSettings = New TXTextControl.LoadSettings()

If TextControl1.Load(TXTextControl.StreamType.All, ls) = System.Windows.Forms.DialogResult.OK Then
    System.Windows.Forms.MessageBox.Show(ls.LoadedFile + " has been loaded. " + ls.BytesRead.ToString() + " bytes read.")
End If

Methods

Method	Description
GetDocumentPartNames	SpreadsheetML only.

Properties

Property	Description
AddParagraph	Specifies whether or not a new paragraph is created before text is loaded.
ApplicationFieldFormat	Specifies the format of text fields which are imported.
ApplicationFieldTypeNames	Specifies an array of strings containing the type names of fields which are to be imported.
Author	Gets the document's author.
BytesRead	Gets the number of bytes read during the load operation.
CreationDate	Gets the document's creation date.
CreatorApplication	Gets the application, which has created the document.
CssFileName	Gets the path and filename of the CSS file belonging to a HTML or XML document.
DefaultStreamType	Determines the default StreamType used in the file Open... (Inherited from LoadSaveSettingsBase)
DocumentAccessPermissions	Specifies how a document can be accessed after it has been loaded.
DocumentBasePath	Sets a base path saved in the document that is used to resolve relative file paths. (Inherited from LoadSaveSettingsBase)
DocumentKeywords	Gets the document's keywords.
DocumentPartName	SpreadsheetML only.
DocumentSubject	Gets the document's subject string.
DocumentTitle	Gets the document's title.
EmbeddedData	Gets a System.Collections.Generic.Dictionary containing additional embedded data contained in a PDF document.
EmbeddedFiles	Specifies an array of EmbeddedFile objects which will be embedded in the saved document. (Inherited from LoadSaveSettingsBase)
ImageSearchPath	Sets a file path that is used to search for resources like images or hypertext links.
LastModificationDate	Gets the date the document is last modified.
LoadDocumentBackColor	Specifies whether or not the document background color is loaded.
LoadHypertextLinks	Specifies whether or not hypertext links are loaded.
LoadImages	Specifies whether or not images are loaded.
LoadSubTextParts	DOCX, DOC and RTF Formats only: Specifies whether or not bookmarks which extend over several characters are converted to SubTextParts.
LoadedFile	Gets the name and path of the file that has been loaded.
LoadedStreamType	Gets the StreamType of the file that has been loaded.
MasterPassword	Specifies a password for the document's access permissions. (Inherited from LoadSaveSettingsBase)
PDFImportSettings	Specifies how the document structure is generated when a PDF document is imported.
PageMargins	Gets the margins of the loaded document's pages.
PageSize	Gets the width and height of the loaded document's pages.
ReportingMergeBlockFormat	Specifies how reporting merge blocks are handled when a document is saved. (Inherited from LoadSaveSettingsBase)
UserDefinedDocumentProperties	Gets a dictionary with all user-defined document properties contained in the loaded document.
UserPassword	Specifies the password for the user when the document is reopened. (Inherited from LoadSaveSettingsBase)

Further Reading

Learn more about the TXTextControl.LoadSettings Class in the Text Control Blog: