DocxSaveOptions Class

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

Represents a class that stores saving options for Microsoft Word file.

public sealed class DocxSaveOptions : SaveOptions
Public NotInheritable Class DocxSaveOptions
    Inherits SaveOptions
Inheritance:
System.Object
DocxSaveOptions
Remarks

To save a document as a macro-enabled document, template document or macro-enabled template document, set Format property to appropriate value.

Constructors

DocxSaveOptions()

Initializes a new instance of the DocxSaveOptions class.

public DocxSaveOptions()
Public Sub New

Properties

ContentType

Gets the content-type for DOCX file format: application/vnd.openxmlformats.

public override string ContentType { get; }
Public Overrides ReadOnly Property ContentType As String
Property Value
System.String

The content-type for DOCX file format.

Overrides

DigitalSignatures

Gets the digital signature options.

public IList<DocxDigitalSignatureSaveOptions> DigitalSignatures { get; }
Public ReadOnly Property DigitalSignatures As IList(Of DocxDigitalSignatureSaveOptions)
Property Value
System.Collections.Generic.IList<DocxDigitalSignatureSaveOptions>

The digital signature options.

Format

Gets or sets the Word file format into which to save the DocumentModel instance.

public DocxFormat Format { get; set; }
Public Property Format As DocxFormat
Property Value
DocxFormat

The Word file format into which to save the DocumentModel instance.

ImageDpi

Gets or sets the saved images DPI.

public int ImageDpi { get; set; }
Public Property ImageDpi As Integer
Property Value
System.Int32

The saved images DPI.

Remarks

This property controls the image quality for all images in the file. Larger value results in better-quality images but increases the file size. Setting this property to 0 will disable image optimization. Standard DPI values are:

  • 330 - Good quality for HD displays
  • 220 - Good quality for most printers and displays
  • 150 - Good quality for web pages and projectors
  • 96 - Good quality for smaller file sizes

Password

Gets or sets the password used to protect / encrypt the document.

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

The password used to protect / encrypt the document.

Events

ProgressChanged

Occurs when the saving 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 destination is used as a System.ComponentModel.ProgressChangedEventArgs.UserState.

Inherited Properties

DocxDefault

Gets the default saving options for Microsoft Word file format. Word file will be saved in Docx format.

(Inherited from SaveOptions)

HtmlDefault

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

(Inherited from SaveOptions)

ImageDefault

Gets the default saving options for image file format. Image will be saved in Bmp format.

(Inherited from SaveOptions)

OdtDefault

Gets the default saving options for Open Document file format.

(Inherited from SaveOptions)

PageCount

Gets or sets the number of pages which should be saved.

(Inherited from SaveOptions)

PageNumber

Gets or sets the zero-based page number of the document's page which should be saved.

(Inherited from SaveOptions)

PdfDefault

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

(Inherited from SaveOptions)

RtfDefault

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

(Inherited from SaveOptions)

TxtDefault

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

(Inherited from SaveOptions)

XmlDefault

Gets the default saving options for XML file format.

(Inherited from SaveOptions)

XpsDefault

Gets the default saving options for XML Paper Specification (XPS) format.

(Inherited from SaveOptions)

Examples

See Also