com.aspose.words
Class PsSaveOptions

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

public class PsSaveOptions 
extends SaveOptions

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

Constructor Summary
PsSaveOptions()
           Initializes a new instance of this class that can be used to save a document in the SaveFormat.PS format.
 
Property Getters/Setters Summary
intgetJpegQuality()
voidsetJpegQuality(int value)
           Gets or sets a value determining the quality of the JPEG images inside PS document.
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.
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.
booleangetRenderDmlShapeEffects()→ inherited from SaveOptions
voidsetRenderDmlShapeEffects(boolean value)
           Gets or sets a value determining whether or not to render Dml shape effects. Rendering of effects might take time and make rendering process slower.
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.PS. 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.
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

PsSaveOptions

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

Property Getters/Setters Detail

getJpegQuality/setJpegQuality

public int getJpegQuality() / public void setJpegQuality(int value)
Gets or sets a value determining the quality of the JPEG images inside PS document.

Has effect only when a document contains JPEG images.

Use this property to get or set the quality of the images inside a document when saving in PS format. The value may vary from 0 to 100 where 0 means worst quality but maximum compression and 100 means best quality but minimum compression.

The default value is 95.


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.

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);

getRenderDmlShapeEffects/setRenderDmlShapeEffects

→ inherited from SaveOptions
public boolean getRenderDmlShapeEffects() / public void setRenderDmlShapeEffects(boolean value)
Gets or sets a value determining whether or not to render Dml shape effects. Rendering of effects might take time and make rendering process slower. The default value is true.

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


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.PS. 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.


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.


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.

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.