TX Text Control .NET Server

LoadSaveSettingsBase Class

Class
Namespace
TXTextControl
Package
TXTextControl.TextControl.Core.SDK from the private NuGet feed or Text Control Offline Packages
Assembly
TXTextControl.Core.dll
Install
dotnet add package TXTextControl.TextControl.Core.SDK .NET 8 and later. For .NET Framework, reference TXTextControl.dll from the setup.
Also in
TXTextControl.TextControl.ASP.SDK as TXTextControl.dll
Derived
LoadSettings, SaveSettings

Description

The LoadSaveSettingsBase class is the base class of the LoadSettings and SaveSettings classes.

Syntax

public abstract class LoadSaveSettingsBase

Examples

The following example includes the default stream type value from a Load Save Settings Base object in application diagnostics. The created object is then available to the surrounding document workflow.

Console.WriteLine($"Default Stream Type: {loadSaveSettingsBase.DefaultStreamType}");
Console.WriteLine("Load Save Settings Base is ready for use.");

Members

Properties

PropertyDescription
DefaultStreamTypeDetermines the default StreamType used in the file Open... and file Save As... dialogboxes.
DocumentBasePathSets a base path saved in the document that is used to resolve relative file paths.
EmbeddedFilesSpecifies an array of EmbeddedFile objects which will be embedded in the saved document. Each file must be specified through a name and its data.
MasterPasswordSpecifies a password for the document's access permissions. If the password is an empty string, accessing the document is not restricted. If a password is specified, the access permissions are given through the SaveSettings.DocumentAccessPermissions property.
ReportingMergeBlockFormatSpecifies how reporting merge blocks are handled when a document is saved. Reporting merge blocks can be saved in a document either through special document targets represented through DocumentTarget objects or through special subtextparts represented through SubTextPart objects. When a merge block is marked with document targets, the name of the starting marker begins with blockstart_ and the name of the ending marker begins with blockend_. When a merge block is marked through a subtextpart, its name begins with txmb_.
UserPasswordSpecifies the password for the user when the document is reopened. If the password is an empty string the document can be reopened by every user.