TX Text Control .NET for Windows Forms

DocumentSettings Class

Class|Introduced in 29.0
Namespace
TXTextControl
Package
TXTextControl.TextControl.WinForms.SDK from the private NuGet feed or Text Control Offline Packages
Assembly
TXTextControl.dll
Install
dotnet add package TXTextControl.TextControl.WinForms.SDK .NET 8 and later. For .NET Framework, reference TXTextControl.dll from the setup.

Description

The DocumentSettings class provides properties which inform about general document settings, such as author and title, contained in the document the user is currently working on. A DocumentSettings object is provided through the TextControl.DocumentSettings or WPF.TextControl.DocumentSettings property. The object's values can be changed during a user is working on the document. When such a document is saved with one of the Save methods all settings are automatically stored but can be overwritten through the corresponding property of the SaveSettings class.

Syntax

public class DocumentSettings

Examples

The following example configures document settings for the current document.

DocumentSettings documentSettings = textControl.DocumentSettings;
documentSettings.DocumentTitle = "Quarterly results";
documentSettings.Author = "Finance team";

Members

Constructors

ConstructorDescription
DocumentSettingsNot described in the reference. public DocumentSettings();

Properties

PropertyDescription
AuthorGets or sets the author of the current document. It is an empty string, if there is no author contained in the current document.
CreationDateGets or sets the document's creation date. It is January 1, 0001 in the Gregorian calendar, if there is no creation date contained in the current document.
CreatorApplicationGets or sets the application, which has created the current document. It is an empty string, if a creator application is not contained in the current document.
DocumentBasePathGets or sets a file path that is used to search for resources like images or hypertext links. This path is added to all relative file paths used in the document.
DocumentKeywordsGets or sets the current document's keywords. The property value is null, if there are no keywords contained in the document.
DocumentSubjectGets or sets the subject string of the current document. It is an empty string, if there is no subject string contained in the document.
DocumentTitleGets or sets the current document's title. It is an empty string, if there is no title contained in the current document.
EmbeddedFilesGets or sets an array of EmbeddedFile objects providing the name, data and additional optional properties of files, which are embedded in the current document. The property value is null, if there are no embedded files contained in the document.
UserDefinedDocumentPropertiesGets or sets a dictionary with all user-defined document properties contained in the current document. The property's value is an object of the type UserDefinedPropertyDictionary or null, if the current document does not contain any user-defined property.