XpsSaveOptions constructor

XpsSaveOptions()

Initializes a new instance of this class that can be used to save a document in the SaveFormat.XPS format.

def __init__(self):
    ...

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.

def __init__(self, save_format: aspose.words.SaveFormat):
    ...
ParameterTypeDescription
save_formatSaveFormat

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)

# 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 "headings_outline_levels" 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(ARTIFACTS_DIR + "XpsSaveOptions.outline_levels.xps", save_options)

Shows how to save a document to the XPS format in the form of a book fold.

doc = aw.Document(MY_DIR + "Paragraphs.docx")

# Create an "XpsSaveOptions" object that we can pass to the document's "save" method
# to modify how that method converts the document to .XPS.
xps_options = aw.saving.XpsSaveOptions(aw.SaveFormat.XPS)

# Set the "use_book_fold_printing_settings" property to "True" to arrange the contents
# in the output XPS in a way that helps us use it to make a booklet.
# Set the "use_book_fold_printing_settings" property to "False" to render the XPS normally.
xps_options.use_book_fold_printing_settings = render_text_as_book_fold

# If we are rendering the document as a booklet, we must set the "multiple_pages"
# properties of the page setup objects of all sections to "MultiplePagesType.BOOK_FOLD_PRINTING".
if render_text_as_book_fold:
    for section in doc.sections:
        section = section.as_section()
        section.page_setup.multiple_pages = aw.settings.MultiplePagesType.BOOK_FOLD_PRINTING

# Once we print this document, we can turn it into a booklet by stacking the pages
# to come out of the printer and folding down the middle.
doc.save(ARTIFACTS_DIR + "XpsSaveOptions.book_fold.xps", xps_options)

See Also

XpsSaveOptions.outline_options property