com.aspose.words
Class XpsSaveOptions

java.lang.Object
  extended by SaveOptions
      extended by com.aspose.words.XpsSaveOptions

public class XpsSaveOptions 
extends SaveOptions

Can be used to specify additional options when saving a document into the SaveFormat.XPS format.

Example:

Shows how to save a document to the Xps format using the Save method and the XpsSaveOptions class.
// Open the document
Document doc = new Document(getMyDir() + "Rendering.doc");
// Save document to file in the Xps format with default options
doc.save(getMyDir() + "Rendering.XpsDefaultOptions Out.xps");

// Save document to stream in the Xps format with default options
ByteArrayOutputStream docStream = new ByteArrayOutputStream();
doc.save(docStream, SaveFormat.XPS);

// Save document to file in the Xps format with specified options
// Render the first page only
XpsSaveOptions xpsOptions = new XpsSaveOptions();
xpsOptions.setPageIndex(0);
xpsOptions.setPageCount(1);
doc.save(getMyDir() + "Rendering.XpsCustomOptions Out.xps", xpsOptions);

Constructor Summary
XpsSaveOptions()
           Initializes a new instance of this class that can be used to save a document in the SaveFormat.XPS format.
XpsSaveOptions(int saveFormat)
           Initializes a new instance of this class that can be used to save a document in the SaveFormat.XPS or SaveFormat.OPEN_XPS format.
 
Property Getters/Setters Summary
intgetBookmarksOutlineLevel()
voidsetBookmarksOutlineLevel(int value)
           Specifies the level in the XPS document outline at which to display Word bookmarks.
intgetColorMode()→ inherited from SaveOptions
voidsetColorMode(int value)
           Gets or sets a value determining how colors are rendered. The value of the property is ColorMode integer constant.
intgetDmlEffectsRenderingMode()→ inherited from SaveOptions
voidsetDmlEffectsRenderingMode(int value)
           Gets or sets a value determining how DrawingML effects are rendered. The value of the property is DmlEffectsRenderingMode integer constant.
intgetDmlRenderingMode()→ inherited from SaveOptions
voidsetDmlRenderingMode(int value)
           Gets or sets a value determining how DrawingML shapes are rendered. The value of the property is DmlRenderingMode integer constant.
intgetHeadingsOutlineLevels()
voidsetHeadingsOutlineLevels(int value)
           Specifies how many levels of headings (paragraphs formatted with the Heading styles) to include in the XPS document outline.
MetafileRenderingOptionsgetMetafileRenderingOptions()
           Allows to specify metafile rendering options.
intgetNumeralFormat()
voidsetNumeralFormat(int value)
           Gets or sets NumeralFormat used for rendering of numerals. European numerals are used by default. The value of the property is NumeralFormat integer constant.
OutlineOptionsgetOutlineOptions()
           Allows to specify outline options.
intgetPageCount()
voidsetPageCount(int value)
           Gets or sets the number of pages to save. Default is java.lang.Integer.MAX_VALUE which means all pages of the document will be rendered.
intgetPageIndex()
voidsetPageIndex(int value)
           Gets or sets the 0-based index of the first page to save. Default is 0.
booleangetPrettyFormat()→ inherited from SaveOptions
voidsetPrettyFormat(boolean value)
           When true, pretty formats output where applicable. Default value is false.
intgetSaveFormat()
voidsetSaveFormat(int value)
           Specifies the format in which the document will be saved if this save options object is used. Can only be SaveFormat.XPS. The value of the property is SaveFormat integer constant.
java.lang.StringgetTempFolder()→ inherited from SaveOptions
voidsetTempFolder(java.lang.String value)
           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.
booleangetUpdateSdtContent()→ inherited from SaveOptions
voidsetUpdateSdtContent(boolean value)
           Gets or sets value determining whether content of StructuredDocumentTag is updated before saving.
booleangetUseAntiAliasing()→ inherited from SaveOptions
voidsetUseAntiAliasing(boolean value)
           Gets or sets a value determining whether or not to use anti-aliasing for rendering.
booleangetUseBookFoldPrintingSettings()
voidsetUseBookFoldPrintingSettings(boolean value)
           Gets or sets a boolean value indicating whether the document should be saved using a booklet printing layout, if it is specified via #Error Cref: PageSetup.MultiplePages.
booleangetUseHighQualityRendering()→ inherited from SaveOptions
voidsetUseHighQualityRendering(boolean value)
           Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms.
IWarningCallbackgetWarningCallback()→ inherited from SaveOptions
voidsetWarningCallback(IWarningCallback value)
           Called during a save operation, when an issue is detected that might result in data or formatting fidelity loss.
 

Constructor Detail

XpsSaveOptions

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

Example:

Shows how to save a document to the Xps format using the Save method and the XpsSaveOptions class.
// Open the document
Document doc = new Document(getMyDir() + "Rendering.doc");
// Save document to file in the Xps format with default options
doc.save(getMyDir() + "Rendering.XpsDefaultOptions Out.xps");

// Save document to stream in the Xps format with default options
ByteArrayOutputStream docStream = new ByteArrayOutputStream();
doc.save(docStream, SaveFormat.XPS);

// Save document to file in the Xps format with specified options
// Render the first page only
XpsSaveOptions xpsOptions = new XpsSaveOptions();
xpsOptions.setPageIndex(0);
xpsOptions.setPageCount(1);
doc.save(getMyDir() + "Rendering.XpsCustomOptions Out.xps", xpsOptions);

XpsSaveOptions

public XpsSaveOptions(int saveFormat)
Initializes a new instance of this class that can be used to save a document in the SaveFormat.XPS or SaveFormat.OPEN_XPS format.
Parameters:
saveFormat - A SaveFormat value.

Property Getters/Setters Detail

getBookmarksOutlineLevel/setBookmarksOutlineLevel

public int getBookmarksOutlineLevel() / public void setBookmarksOutlineLevel(int value)
Specifies the level in the XPS document outline at which to display Word bookmarks.

Specify 0 and Word bookmarks will not be displayed in the SWF document outline. Specify 1 and Word bookmarks will be displayed in the PDF document outline at level 1; 2 for level 2 and so on.

Default is 0. Valid range is 0 to 9.


getColorMode/setColorMode

→ inherited from SaveOptions
public int getColorMode() / public void setColorMode(int value)
Gets or sets a value determining how colors are rendered. The value of the property is ColorMode integer constant.The default value is ColorMode.NORMAL

This property is used when the document is exported to fixed page formats.


getDmlEffectsRenderingMode/setDmlEffectsRenderingMode

→ inherited from SaveOptions
public int getDmlEffectsRenderingMode() / public void setDmlEffectsRenderingMode(int value)
Gets or sets a value determining how DrawingML effects are rendered. The value of the property is DmlEffectsRenderingMode integer constant. The default value is DmlEffectsRenderingMode.SIMPLIFIED.

This property is used when the document is exported to fixed page formats.


getDmlRenderingMode/setDmlRenderingMode

→ inherited from SaveOptions
public int getDmlRenderingMode() / public void setDmlRenderingMode(int value)
Gets or sets a value determining how DrawingML shapes are rendered. The value of the property is DmlRenderingMode integer constant. The default value is DmlRenderingMode.FALLBACK.

This property is used when the document is exported to fixed page formats.


getHeadingsOutlineLevels/setHeadingsOutlineLevels

public int getHeadingsOutlineLevels() / public void setHeadingsOutlineLevels(int value)
Specifies how many levels of headings (paragraphs formatted with the Heading styles) to include in the XPS document outline.

Specify 0 for no headings in the outline; specify 1 for one level of headings in the outline and so on.

Default is 0. Valid range is 0 to 9.


getMetafileRenderingOptions

public MetafileRenderingOptions getMetafileRenderingOptions()
Allows to specify metafile rendering options.

getNumeralFormat/setNumeralFormat

public int getNumeralFormat() / public void setNumeralFormat(int value)
Gets or sets NumeralFormat used for rendering of numerals. European numerals are used by default. The value of the property is NumeralFormat integer constant.

getOutlineOptions

public OutlineOptions getOutlineOptions()
Allows to specify outline options.

Note that ExpandedOutlineLevels option will not work when saving to XPS.


getPageCount/setPageCount

public int getPageCount() / public void setPageCount(int value)
Gets or sets the number of pages to save. Default is java.lang.Integer.MAX_VALUE which means all pages of the document will be rendered.

getPageIndex/setPageIndex

public int getPageIndex() / public void setPageIndex(int value)
Gets or sets the 0-based index of the first page to save. Default is 0.

getPrettyFormat/setPrettyFormat

→ inherited from SaveOptions
public boolean getPrettyFormat() / public void setPrettyFormat(boolean value)
When true, pretty formats output where applicable. Default value is false.

Set to true to make HTML, MHTML, EPUB, WordML, RTF, DOCX and ODT output human readable. Useful for testing or debugging.

Example:

Shows how to pass an option to export HTML tags in a well spaced, human readable format.
Document doc = new Document(getMyDir() + "Document.doc");

HtmlSaveOptions htmlOptions = new HtmlSaveOptions(SaveFormat.HTML);
// Enabling the PrettyFormat setting will export HTML in an indented format that is easy to read.
// If this is setting is false (by default) then the HTML tags will be exported in condensed form with no indentation.
htmlOptions.setPrettyFormat(true);

doc.save(getMyDir() + "Document.PrettyFormat Out.html", htmlOptions);

getSaveFormat/setSaveFormat

public int getSaveFormat() / public void setSaveFormat(int value)
Specifies the format in which the document will be saved if this save options object is used. Can only be SaveFormat.XPS. The value of the property is SaveFormat integer constant.

getTempFolder/setTempFolder

→ inherited from SaveOptions
public java.lang.String getTempFolder() / public void setTempFolder(java.lang.String value)
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.

When Aspose.Words saves a document, it needs to create temporary internal structures. By default, these internal structures are created in memory and the memory usage spikes for a short period while the document is being saved. When saving is complete, the memory is freed and reclaimed by the garbage collector.

If you are saving a very large document (thousands of pages) and/or processing many documents at the same time, then the memory spike during saving can be significant enough to cause the system to throw System.OutOfMemoryException. Specifying a temporary folder using TempFolder will cause Aspose.Words to keep the internal structures in temporary files instead of memory. It reduces the memory usage during saving, but will decrease the save performance.

The folder must exist and be writable, otherwise an exception will be thrown.

Aspose.Words automatically deletes all temporary files when saving is complete.


getUpdateSdtContent/setUpdateSdtContent

→ inherited from SaveOptions
public boolean getUpdateSdtContent() / public void setUpdateSdtContent(boolean value)
Gets or sets value determining whether content of StructuredDocumentTag is updated before saving. The default value is true.

getUseAntiAliasing/setUseAntiAliasing

→ inherited from SaveOptions
public boolean getUseAntiAliasing() / public void setUseAntiAliasing(boolean value)
Gets or sets a value determining whether or not to use anti-aliasing for rendering.

The default value is false. When this value is set to true anti-aliasing is used for rendering.

This property is used when the document is exported to the following formats: SaveFormat.TIFF, SaveFormat.PNG, SaveFormat.BMP, SaveFormat.JPEG. When the document is exported to the SaveFormat.HTML, SaveFormat.MHTML and SaveFormat.EPUB formats this option is used for raster images.


getUseBookFoldPrintingSettings/setUseBookFoldPrintingSettings

public boolean getUseBookFoldPrintingSettings() / public void setUseBookFoldPrintingSettings(boolean value)
Gets or sets a boolean value indicating whether the document should be saved using a booklet printing layout, if it is specified via #Error Cref: PageSetup.MultiplePages. If this option is specified, page range set via #Error Cref: PageIndex and #Error Cref: PageCount is ignored when saving. This behavior matches MS Word. If book fold printing settings are not specified in page setup, this option will have no effect.

getUseHighQualityRendering/setUseHighQualityRendering

→ inherited from SaveOptions
public boolean getUseHighQualityRendering() / public void setUseHighQualityRendering(boolean value)
Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms. The default value is false.

This property is used when the document is exported to image formats: SaveFormat.TIFF, SaveFormat.PNG, SaveFormat.BMP, SaveFormat.JPEG.


getWarningCallback/setWarningCallback

→ inherited from SaveOptions
public IWarningCallback getWarningCallback() / public void setWarningCallback(IWarningCallback value)
Called during a save operation, when an issue is detected that might result in data or formatting fidelity loss.

This property is obsolete. Please use DocumentBase.WarningCallback instead.

Example:

Demonstrates how to implement the IWarningCallback to be notified of any font substitution during document save.
public class HandleDocumentWarnings implements IWarningCallback
{
    /**
     * Our callback only needs to implement the "Warning" method. This method is called whenever there is a
     * potential issue during document procssing. The callback can be set to listen for warnings generated during document
     * load and/or document save.
     */
    public void warning(WarningInfo info)
    {
        // We are only interested in fonts being substituted.
        if (info.getWarningType() == WarningType.FONT_SUBSTITUTION)
        {
            System.out.println("Font substitution: " + info.getDescription());
        }
    }

}

Example:

Demonstrates how to recieve notifications of font substitutions by using IWarningCallback.
// Load the document to render.
Document doc = new Document(getMyDir() + "Document.doc");

// We can choose the default font to use in the case of any missing fonts.
FontSettings.setDefaultFontName("Arial");

// For testing we will set Aspose.Words to look for fonts only in a folder which doesn't exist. Since Aspose.Words won't
// find any fonts in the specified directory, then during rendering the fonts in the document will be subsuited with the default
// font specified under FontSettings.DefaultFontName. We can pick up on this subsuition using our callback.
FontSettings.setFontsFolder("", false);

// Create a new class implementing IWarningCallback which collect any warnings produced during document save.
HandleDocumentWarnings callback = new HandleDocumentWarnings();

// We assign the callback to the appropriate save options class. In this case, we are going to save to PDF
// so we create a PdfSaveOptions class and assign the callback there.
PdfSaveOptions saveOptions = new PdfSaveOptions();
saveOptions.setWarningCallback(callback);

// Pass the save options along with the save path to the save method.
doc.save(getMyDir() + "Rendering.MissingFontNotification Out.pdf", saveOptions);

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.