LoadOptions

LoadOptions class

Allows to specify additional options (such as password or base URI) when loading a document into a Document object.

To learn more, visit the Specify Load Options documentation article.

public class LoadOptions

Constructors

Name Description
LoadOptions() Initializes a new instance of this class with default values.
LoadOptions(string) A shortcut to initialize a new instance of this class with the specified password to load an encrypted document.
LoadOptions(LoadFormat, string, string) A shortcut to initialize a new instance of this class with properties set to the specified values.

Properties

Name Description
BaseUri { get; set; } Gets or sets the string that will be used to resolve relative URIs found in the document into absolute URIs when required. Can be null or empty string. Default is null.
ConvertMetafilesToPng { get; set; } Gets or sets whether to convert metafile (Wmf or Emf) images to Png image format.
ConvertShapeToOfficeMath { get; set; } Gets or sets whether to convert shapes with EquationXML to Office Math objects.
Encoding { get; set; } Gets 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 null. Default is null.
FontSettings { get; set; } Allows to specify document font settings.
LanguagePreferences { get; } Gets language preferences that will be used when document is loading.
LoadFormat { get; set; } Specifies the format of the document to be loaded. Default is Auto.
MswVersion { get; set; } Allows to specify that the document loading process should match a specific MS Word version. Default value is Word2019
Password { get; set; } Gets or sets the password for opening an encrypted document. Can be null or empty string. Default is null.
PreserveIncludePictureField { get; set; } Gets or sets whether to preserve the INCLUDEPICTURE field when reading Microsoft Word formats. The default value is false.
ProgressCallback { get; set; } Called during loading a document and accepts data about loading progress.
ResourceLoadingCallback { get; set; } Allows to control how external resources (images, style sheets) are loaded when a document is imported from HTML, MHTML.
TempFolder { get; set; } Allows to use temporary files when reading document. By default this property is null and no temporary files are used.
UpdateDirtyFields { get; set; } Specifies whether to update the fields with the dirty attribute.
WarningCallback { get; set; } Called during a load operation, when an issue is detected that might result in data or formatting fidelity loss.

Examples

Shows how to load an encrypted Microsoft Word document.

Document doc;

// Aspose.Words throw an exception if we try to open an encrypted document without its password.
Assert.Throws<IncorrectPasswordException>(() => doc = new Document(MyDir + "Encrypted.docx"));

// When loading such a document, the password is passed to the document's constructor using a LoadOptions object.
LoadOptions options = new LoadOptions("docPassword");

// There are two ways of loading an encrypted document with a LoadOptions object.
// 1 -  Load the document from the local file system by filename:
doc = new Document(MyDir + "Encrypted.docx", options);
// 2 -  Load the document from a stream:
using (Stream stream = File.OpenRead(MyDir + "Encrypted.docx"))
{
    doc = new Document(stream, options);

See Also