TxtLoadOptions class

TxtLoadOptions class

Allows to specify additional options when loading LoadFormat.TEXT document into a Document object. To learn more, visit the Specify Load Options documentation article.

Inheritance: TxtLoadOptionsLoadOptions

Constructors

NameDescription
TxtLoadOptions()Initializes a new instance of this class with default values.

Properties

NameDescription
auto_numbering_detectionGets or sets a boolean value indicating either automatic numbering detection will be performed while loading a document. The default value is True.
base_uriGets or sets the string that will be used to resolve relative URIs found in the document into absolute URIs when required. Can be None or empty string. Default is None.
(Inherited from LoadOptions)
convert_metafiles_to_pngGets or sets whether to convert metafile(Wmf or Emf) images to Png image format.
(Inherited from LoadOptions)
convert_shape_to_office_mathGets or sets whether to convert shapes with EquationXML to Office Math objects.
(Inherited from LoadOptions)
detect_hyperlinksSpecifies either to detect hyperlinks in text. The default value is False.
detect_numbering_with_whitespacesAllows to specify how numbered list items are recognized when document is imported from plain text format. The default value is True.
document_directionGets or sets a document direction. The default value is DocumentDirection.LEFT_TO_RIGHT.
encodingGets or sets the encoding that will be used to load an HTML, TXT, or CHM document if the encoding is not specified inside the document. Can be None. Default is None.
(Inherited from LoadOptions)
font_settingsAllows to specify document font settings.
(Inherited from LoadOptions)
ignore_ole_dataSpecifies whether to ignore the OLE data.
(Inherited from LoadOptions)
language_preferencesGets language preferences that will be used when document is loading.
(Inherited from LoadOptions)
leading_spaces_optionsGets or sets preferred option of a leading space handling. Default value is TxtLeadingSpacesOptions.CONVERT_TO_INDENT.
load_formatSpecifies the format of the document to be loaded. Default is LoadFormat.AUTO.
(Inherited from LoadOptions)
msw_versionAllows to specify that the document loading process should match a specific MS Word version. Default value is MsWordVersion.WORD2019
(Inherited from LoadOptions)
passwordGets or sets the password for opening an encrypted document. Can be None or empty string. Default is None.
(Inherited from LoadOptions)
preserve_include_picture_fieldGets or sets whether to preserve the INCLUDEPICTURE field when reading Microsoft Word formats. The default value is False.
(Inherited from LoadOptions)
progress_callbackCalled during loading a document and accepts data about loading progress.
(Inherited from LoadOptions)
resource_loading_callbackAllows to control how external resources (images, style sheets) are loaded when a document is imported from HTML, MHTML.
(Inherited from LoadOptions)
temp_folderAllows to use temporary files when reading document. By default this property is None and no temporary files are used.
(Inherited from LoadOptions)
trailing_spaces_optionsGets or sets preferred option of a trailing space handling. Default value is TxtTrailingSpacesOptions.TRIM.
update_dirty_fieldsSpecifies whether to update the fields with the dirty attribute.
(Inherited from LoadOptions)
use_system_lcidGets or sets whether to use LCID value obtained from Windows registry to determine page setup default margins.
(Inherited from LoadOptions)
warning_callbackCalled during a load operation, when an issue is detected that might result in data or formatting fidelity loss.
(Inherited from LoadOptions)

See Also