SaveOptions Class

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

Represents a base class for saving options of various file formats.

public abstract class SaveOptions
Public MustInherit Class SaveOptions
Inheritance:
System.Object
SaveOptions
Derived
DocxSaveOptions
HtmlSaveOptions
ImageSaveOptions
OdtSaveOptions
PdfSaveOptions
RtfSaveOptions
TxtSaveOptions
XmlSaveOptions
XpsSaveOptions

Properties

ContentType

Gets the content-type for this specific file format as defined in the RFC 2616.

public abstract string ContentType { get; }
Public MustOverride ReadOnly Property ContentType As String
Property Value
System.String

The content-type for this specific file format.

See Also

DocxDefault

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

public static DocxSaveOptions DocxDefault { get; }
Public Shared ReadOnly Property DocxDefault As DocxSaveOptions
Property Value
DocxSaveOptions

The default saving options for Microsoft Word file format.

Remarks

This property always returns a new instance of DocxSaveOptions class initialized with default constructor.

HtmlDefault

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

public static HtmlSaveOptions HtmlDefault { get; }
Public Shared ReadOnly Property HtmlDefault As HtmlSaveOptions
Property Value
HtmlSaveOptions

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

Remarks

This property always returns a new instance of HtmlSaveOptions class initialized with default constructor.

ImageDefault

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

public static ImageSaveOptions ImageDefault { get; }
Public Shared ReadOnly Property ImageDefault As ImageSaveOptions
Property Value
ImageSaveOptions

The default saving options for image file format.

Remarks

This property always returns a new instance of ImageSaveOptions class initialized with default constructor.

OdtDefault

Gets the default saving options for Open Document file format.

public static OdtSaveOptions OdtDefault { get; }
Public Shared ReadOnly Property OdtDefault As OdtSaveOptions
Property Value
OdtSaveOptions

The default saving options for Open Document file format.

Remarks

This property always returns a new instance of OdtSaveOptions class initialized with default constructor.

PageCount

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

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

The number of pages which should be saved.

Remarks

When saving to image, only formats that support multiple frames (Tagged Image File Format (TIFF) and Graphics Interchange Format (GIF)) are supported.

If image format doesn't support multiple frames, this property is ignored.

When saving to image, default value is 1; otherwise default value is System.Int32.MaxValue (all pages).

PageNumber

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

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

The zero-based page number of the document's page which should be saved.

PdfDefault

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

public static PdfSaveOptions PdfDefault { get; }
Public Shared ReadOnly Property PdfDefault As PdfSaveOptions
Property Value
PdfSaveOptions

The default saving options for Portable Document Format (PDF).

Remarks

This property always returns a new instance of PdfSaveOptions class initialized with default constructor.

RtfDefault

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

public static RtfSaveOptions RtfDefault { get; }
Public Shared ReadOnly Property RtfDefault As RtfSaveOptions
Property Value
RtfSaveOptions

The default saving options for Rich Text (RTF) format.

Remarks

This property always returns a new instance of RtfSaveOptions class initialized with default constructor.

TxtDefault

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

public static TxtSaveOptions TxtDefault { get; }
Public Shared ReadOnly Property TxtDefault As TxtSaveOptions
Property Value
TxtSaveOptions

The default saving options for Plain Text (TXT) format.

Remarks

This property always returns a new instance of TxtSaveOptions class initialized with default constructor.

XmlDefault

Gets the default saving options for XML file format.

public static XmlSaveOptions XmlDefault { get; }
Public Shared ReadOnly Property XmlDefault As XmlSaveOptions
Property Value
XmlSaveOptions

The default saving options for XML file format.

Remarks

This property always returns a new instance of XmlSaveOptions class initialized with default constructor.

XpsDefault

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

public static XpsSaveOptions XpsDefault { get; }
Public Shared ReadOnly Property XpsDefault As XpsSaveOptions
Property Value
XpsSaveOptions

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

Remarks

This property always returns a new instance of XpsSaveOptions class initialized with default constructor.

Examples

See Also