DocxLoadOptions Class

Namespace:
GemBox.Document
Assembly:
GemBox.Document.dll

Represents a class that stores loading options for Microsoft Word (DOCX) format.

public sealed class DocxLoadOptions : LoadOptions
Public NotInheritable Class DocxLoadOptions
    Inherits LoadOptions
Inheritance:
System.Object
DocxLoadOptions

Constructors

DocxLoadOptions()

Initializes a new instance of the DocxLoadOptions class.

public DocxLoadOptions()
Public Sub New

Properties

Password

Gets or sets the password to open protected / encrypted document.

public string Password { get; set; }
Public Property Password As String
Property Value
System.String

The password to open protected / encrypted document.

Methods

IsEncrypted(Stream)

Determines whether the file is an encrypted DOCX.

public static bool IsEncrypted(Stream stream)
Public Shared Function IsEncrypted(stream As Stream) As Boolean
Parameters
stream
System.IO.Stream

The stream from which to read a file.

Returns
System.Boolean

true if file is an encrypted DOCX; otherwise, false.

IsEncrypted(String)

Determines whether the file is an encrypted DOCX.

public static bool IsEncrypted(string path)
Public Shared Function IsEncrypted(path As String) As Boolean
Parameters
path
System.String

The path from which to read a file.

Returns
System.Boolean

true if file is an encrypted DOCX; otherwise, false.

Events

ProgressChanged

Occurs when the loading progress of a document has changed.

public event EventHandler<OperationProgressChangedEventArgs> ProgressChanged
Public Event ProgressChanged As EventHandler(Of OperationProgressChangedEventArgs)
Event Type
System.EventHandler<OperationProgressChangedEventArgs>
Remarks

The file path or stream that was provided as a document source is used as a System.ComponentModel.ProgressChangedEventArgs.UserState.

Inherited Properties

DocDefault

Gets the default loading options for Microsoft Word 97-2003 (DOC) format.

(Inherited from LoadOptions)

DocxDefault

Gets the default loading options for Microsoft Word (DOCX) format.

(Inherited from LoadOptions)

HtmlDefault

Gets the default loading options for HyperText Markup Language (HTML) format.

(Inherited from LoadOptions)

OdtDefault

Gets the default loading options for Open Document (ODT) format.

(Inherited from LoadOptions)

PdfDefault

Gets the default loading options for Portable Document Format (PDF).

(Inherited from LoadOptions)

PreserveUnsupportedFeatures

Gets or sets a value indicating whether to preserve file format features that are not directly supported through GemBox.Document object model.

(Inherited from LoadOptions)

RtfDefault

Gets the default loading options for Rich Text (RTF) format.

(Inherited from LoadOptions)

TxtDefault

Gets the default loading options for Plain Text (TXT) format.

(Inherited from LoadOptions)

XmlDefault

Gets the default loading options for XML file format.

(Inherited from LoadOptions)

Examples

See Also