DS Server

LoadSettings Object

Object|Introduced in 28.0

Description

The LoadSettings object provides properties for advanced settings and information during load operations.

Syntax

TXTextControl.LoadSettings

Examples

The following example demonstrates TXTextControl.LoadSettings in a practical document-editing workflow. The LoadSettings object provides properties for advanced settings and information during load operations.

function inspectLoadSettings(loadSettings) {
    console.log("TXTextControl.LoadSettings object:", loadSettings);
}

Members

Properties

PropertyDescription
addParagraphSpecifies whether or not a new paragraph is created before text is loaded.
applicationFieldFormatSpecifies the format of text fields which are imported.
applicationFieldTypeNamesSpecifies an array of strings containing the type names of fields which are to be imported.
documentAccessPermissionsSpecifies how a document can be accessed after it has been loaded.
documentBasePathSets a file path that is used to search for resources like images or hypertext links.
documentPartNameSpreadsheetML only. Gets or sets the name of the part of the document to be loaded.
imageSearchPathSets a file path that is used to search for resources like images or hypertext links.
loadDocumentBackColorSpecifies whether or not the document background color is loaded.
loadHypertextLinksSpecifies whether or not hypertext links are loaded.
loadImagesSpecifies whether or not images are loaded.
loadSubTextPartsDOCX Format only: Specifies whether or not bookmarks which extend over several characters are converted to SubTextParts.
masterPasswordSpecifies the password when the document is restricted with access permissions.
PDFImportSettingsSpecifies how the document structure is generated when a PDF document is imported.
reportingMergeBlockFormatSpecifies how reporting merge blocks are handled when a document is loaded.
userPasswordSpecifies the password for the user to open a password protected document.

Enumerations

EnumerationDescription
PDFImportSettingsSpecifies how the document structure is generated when a PDF document is imported.