XpsSaveOptions class
XpsSaveOptions class
Can be used to specify additional options when saving a document into the SaveFormat.XPS format. To learn more, visit the Specify Save Options documentation article.
Inheritance: XpsSaveOptions → FixedPageSaveOptions → SaveOptions
Constructors
| Name | Description |
|---|---|
| XpsSaveOptions() | Initializes a new instance of this class that can be used to save a document in the SaveFormat.XPS format. |
| XpsSaveOptions(save_format) | Initializes a new instance of this class that can be used to save a document in the SaveFormat.XPS or SaveFormat.OPEN_XPS format. |
Properties
| Name | Description |
|---|---|
| allow_embedding_post_script_fonts | Gets or sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved. The default value is False.(Inherited from SaveOptions) |
| color_mode | Gets or sets a value determining how colors are rendered. (Inherited from FixedPageSaveOptions) |
| default_template | Gets or sets path to default template (including filename). Default value for this property is empty string (). (Inherited from SaveOptions) |
| digital_signature_details | Gets or sets DigitalSignatureDetails object used to sign a document. |
| dml_3d_effects_rendering_mode | Gets or sets a value determining how 3D effects are rendered. (Inherited from SaveOptions) |
| dml_effects_rendering_mode | Gets or sets a value determining how DrawingML effects are rendered. (Inherited from SaveOptions) |
| dml_rendering_mode | Gets or sets a value determining how DrawingML shapes are rendered. (Inherited from SaveOptions) |
| export_generator_name | When True, causes the name and version of Aspose.Words to be embedded into produced files. Default value is True.(Inherited from SaveOptions) |
| iml_rendering_mode | Gets or sets a value determining how ink (InkML) objects are rendered. (Inherited from SaveOptions) |
| jpeg_quality | Gets or sets a value determining the quality of the JPEG images inside Html document. (Inherited from FixedPageSaveOptions) |
| memory_optimization | 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) |
| metafile_rendering_options | Allows to specify metafile rendering options. (Inherited from FixedPageSaveOptions) |
| numeral_format | Gets or sets NumeralFormat used for rendering of numerals. European numerals are used by default. (Inherited from FixedPageSaveOptions) |
| optimize_output | 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.(Inherited from FixedPageSaveOptions) |
| outline_options | Allows to specify outline options. |
| page_saving_callback | Allows to control how separate pages are saved when a document is exported to fixed page format. (Inherited from FixedPageSaveOptions) |
| page_set | Gets or sets the pages to render. Default is all the pages in the document. (Inherited from FixedPageSaveOptions) |
| pretty_format | When True, pretty formats output where applicable. Default value is False.(Inherited from SaveOptions) |
| progress_callback | Called during saving a document and accepts data about saving progress. (Inherited from SaveOptions) |
| save_format | Specifies the format in which the document will be saved if this save options object is used. Can only be SaveFormat.XPS. |
| temp_folder | Specifies the folder for temporary files used when saving to a DOC or DOCX file. By default this property is None and no temporary files are used.(Inherited from SaveOptions) |
| update_created_time_property | Gets or sets a value determining whether the BuiltInDocumentProperties.created_time property is updated before saving. Default value is False;(Inherited from SaveOptions) |
| update_fields | 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) |
| update_last_printed_property | Gets or sets a value determining whether the BuiltInDocumentProperties.last_printed property is updated before saving. (Inherited from SaveOptions) |
| update_last_saved_time_property | Gets or sets a value determining whether the BuiltInDocumentProperties.last_saved_time property is updated before saving. (Inherited from SaveOptions) |
| use_anti_aliasing | Gets or sets a value determining whether or not to use anti-aliasing for rendering. (Inherited from SaveOptions) |
| use_book_fold_printing_settings | Gets or sets a boolean value indicating whether the document should be saved using a booklet printing layout, if it is specified via PageSetup.multiple_pages. |
| use_high_quality_rendering | Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms. (Inherited from SaveOptions) |
Methods
| Name | Description |
|---|---|
| create_save_options(save_format) | Creates a save options object of a class suitable for the specified save format. (Inherited from SaveOptions) |
| create_save_options(file_name) | Creates a save options object of a class suitable for the file extension specified in the given file name. (Inherited from SaveOptions) |
Examples
Shows how to limit the headings’ level that will appear in the outline of a saved XPS document.
doc = aw.Document()
builder = aw.DocumentBuilder(doc=doc)
# Insert headings that can serve as TOC entries of levels 1, 2, and then 3.
builder.paragraph_format.style_identifier = aw.StyleIdentifier.HEADING1
self.assertTrue(builder.paragraph_format.is_heading)
builder.writeln('Heading 1')
builder.paragraph_format.style_identifier = aw.StyleIdentifier.HEADING2
builder.writeln('Heading 1.1')
builder.writeln('Heading 1.2')
builder.paragraph_format.style_identifier = aw.StyleIdentifier.HEADING3
builder.writeln('Heading 1.2.1')
builder.writeln('Heading 1.2.2')
# Create an "XpsSaveOptions" object that we can pass to the document's "Save" method
# to modify how that method converts the document to .XPS.
save_options = aw.saving.XpsSaveOptions()
self.assertEqual(aw.SaveFormat.XPS, save_options.save_format)
# The output XPS document will contain an outline, a table of contents that lists headings in the document body.
# Clicking on an entry in this outline will take us to the location of its respective heading.
# Set the "HeadingsOutlineLevels" property to "2" to exclude all headings whose levels are above 2 from the outline.
# The last two headings we have inserted above will not appear.
save_options.outline_options.headings_outline_levels = 2
doc.save(file_name=ARTIFACTS_DIR + 'XpsSaveOptions.OutlineLevels.xps', save_options=save_options)
See Also
- module aspose.words.saving
- class FixedPageSaveOptions