XpsSaveOptions Class

Can be used to specify additional options when saving a document into the Xps format.
Inheritance Hierarchy

Namespace:  Aspose.Words.Saving
Assembly:  Aspose.Words (in Aspose.Words.dll) Version: 20.3
Syntax
public class XpsSaveOptions : FixedPageSaveOptions

The XpsSaveOptions type exposes the following members.

Constructors
  NameDescription
Public methodCode exampleXpsSaveOptions
Initializes a new instance of this class that can be used to save a document in the Xps format.
Public methodCode exampleXpsSaveOptions(SaveFormat)
Initializes a new instance of this class that can be used to save a document in the Xps or OpenXps format.
Properties
  NameDescription
Public propertyCode exampleColorMode
Gets or sets a value determining how colors are rendered.
(Inherited from FixedPageSaveOptions.)
Public propertyCode exampleDefaultTemplate
Gets or sets path to default template (including filename). Default value for this property is empty string (Empty).
(Inherited from SaveOptions.)
Public propertyCode exampleDmlEffectsRenderingMode
Gets or sets a value determining how DrawingML effects are rendered.
(Inherited from SaveOptions.)
Public propertyCode exampleDmlRenderingMode
Gets or sets a value determining how DrawingML shapes are rendered.
(Inherited from SaveOptions.)
Public propertyCode exampleJpegQuality
Gets or sets a value determining the quality of the JPEG images inside Html document.
(Inherited from FixedPageSaveOptions.)
Public propertyCode exampleMemoryOptimization
Gets or sets value determining if memory optimization should be performed before saving the document. Default value for this property is false.
(Inherited from SaveOptions.)
Public propertyCode exampleMetafileRenderingOptions
Allows to specify metafile rendering options.
(Inherited from FixedPageSaveOptions.)
Public propertyCode exampleNumeralFormat
Gets or sets NumeralFormat used for rendering of numerals. European numerals are used by default.
(Inherited from FixedPageSaveOptions.)
Public propertyCode exampleOptimizeOutput
Flag indicates whether it is required to optimize output. If this flag is set redundant nested canvases and empty canvases are removed, also neighbor glyphs with the same formatting are concatenated. Note: The accuracy of the content display may be affected if this property is set to true. Default is false.
(Inherited from FixedPageSaveOptions.)
Public propertyCode exampleOutlineOptions
Allows to specify outline options.
Public propertyCode examplePageCount
Gets or sets the number of pages to save. Default is MaxValue which means all pages of the document will be rendered.
(Inherited from FixedPageSaveOptions.)
Public propertyCode examplePageIndex
Gets or sets the 0-based index of the first page to save. Default is 0.
(Inherited from FixedPageSaveOptions.)
Public propertyCode examplePageSavingCallback
Allows to control how separate pages are saved when a document is exported to fixed page format.
(Inherited from FixedPageSaveOptions.)
Public propertyCode examplePrettyFormat
When true, pretty formats output where applicable. Default value is false.
(Inherited from SaveOptions.)
Public propertyCode exampleSaveFormat
Specifies the format in which the document will be saved if this save options object is used. Can only be Xps.
(Overrides SaveOptionsSaveFormat.)
Public propertyCode exampleTempFolder
Specifies the folder for temporary files used when saving to a DOC or DOCX file. By default this property is null and no temporary files are used.
(Inherited from SaveOptions.)
Public propertyCode exampleUpdateFields
Gets or sets a value determining if fields of certain types should be updated before saving the document to a fixed page format. Default value for this property is true.
(Inherited from SaveOptions.)
Public propertyUpdateLastPrintedProperty
Gets or sets a value determining whether the LastPrinted property is updated before saving.
(Inherited from SaveOptions.)
Public propertyCode exampleUpdateLastSavedTimeProperty
Gets or sets a value determining whether the LastSavedTime property is updated before saving.
(Inherited from SaveOptions.)
Public propertyCode exampleUpdateSdtContent
Gets or sets value determining whether content of StructuredDocumentTag is updated before saving.
(Inherited from SaveOptions.)
Public propertyCode exampleUseAntiAliasing
Gets or sets a value determining whether or not to use anti-aliasing for rendering.
(Inherited from SaveOptions.)
Public propertyCode exampleUseBookFoldPrintingSettings
Gets or sets a boolean value indicating whether the document should be saved using a booklet printing layout, if it is specified via MultiplePages.
Public propertyCode exampleUseHighQualityRendering
Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms.
(Inherited from SaveOptions.)
Methods
  NameDescription
Public methodEquals (Inherited from FixedPageSaveOptions.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodToString (Inherited from Object.)
Examples
Shows how to save a document to the XPS format in different ways.
// Open the document
Document doc = new Document(MyDir + "Rendering.docx");

// Save document to file in the XPS format with default options
doc.Save(ArtifactsDir + "Rendering.SaveAsXps.DefaultOptions.xps");

// Save document to stream in the XPS format with default options
FileStream docStream = new FileStream(ArtifactsDir + "Rendering.SaveAsXps.FromStream.xps", FileMode.Create);
doc.Save(docStream, SaveFormat.Xps);
docStream.Close();

// Save document to file in the XPS format with specified options
// Render 3 pages starting from page 2; pages 2, 3 and 4
XpsSaveOptions xpsOptions = new XpsSaveOptions();
xpsOptions.SaveFormat = SaveFormat.Xps;
xpsOptions.PageIndex = 1;
xpsOptions.PageCount = 3;

// All paragraphs in the "Heading 1" style will be included in the outline but "Heading 2" and onwards won't
xpsOptions.OutlineOptions.HeadingsOutlineLevels = 1;

doc.Save(ArtifactsDir + "Rendering.SaveAsXps.PartialDocument.xps", xpsOptions);
See Also