com.aspose.words

Constructor Detail

• PsSaveOptions

  public PsSaveOptions()

Property Getters/Setters Detail

• getColorMode/setColorMode

  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.

  Example:

  Shows how change image color with save options property

  // Open document with color image
  Document doc = new Document(getMyDir() + "Rendering.doc");
  
  // Set grayscale mode for document
  PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
  pdfSaveOptions.setColorMode(ColorMode.GRAYSCALE);
  
  // Assert that color image in document was grey
  doc.save(getArtifactsDir() + "ColorMode.PdfGrayscaleMode.pdf", pdfSaveOptions);

• getDefaultTemplate/setDefaultTemplate

  public java.lang.String getDefaultTemplate() / public void setDefaultTemplate(java.lang.String value)
  

  Gets or sets path to default template (including filename). Default value for this property is empty string.

  If specified, this path is used to load template when Document.AutomaticallyUpdateSyles is true, but Document.AttachedTemplate is empty.

• getDmlEffectsRenderingMode/setDmlEffectsRenderingMode

  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

  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.

  Example:

  Shows how to define rendering for DML shapes

  Document doc = DocumentHelper.createDocumentFillWithDummyText();
  
  PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
  pdfSaveOptions.setDmlRenderingMode(DmlRenderingMode.DRAWING_ML);
  
  doc.save(getArtifactsDir() + "DrawingMl.pdf", pdfSaveOptions);

• getJpegQuality/setJpegQuality

  public int getJpegQuality() / public void setJpegQuality(int value)
  

  Gets or sets a value determining the quality of the JPEG images inside Html 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 fixed page 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.

• getMemoryOptimization/setMemoryOptimization

  public boolean getMemoryOptimization() / public void setMemoryOptimization(boolean value)
  

  Gets or sets value determining if memory optimization should be performed before saving the document. Default value for this property is false.

  Setting this option to true can significantly decrease memory consumption while saving large documents at the cost of slower saving time.

  Example:

  Shows an option to optimize memory consumption when you work with large documents.

  Document doc = new Document(getMyDir() + "SaveOptions.MemoryOptimization.doc");
  
  // When set to true it will improve document memory footprint but will add extra time to processing. 
  // This optimization is only applied during save operation.
  SaveOptions saveOptions = SaveOptions.createSaveOptions(SaveFormat.PDF);
  saveOptions.setMemoryOptimization(true);
  
  doc.save(getArtifactsDir() + "SaveOptions.MemoryOptimization.pdf", saveOptions);

• getMetafileRenderingOptions/setMetafileRenderingOptions

  public MetafileRenderingOptions getMetafileRenderingOptions() / public void setMetafileRenderingOptions(MetafileRenderingOptions value)
  

  Allows to specify metafile rendering options.

  Example:

  Shows added fallback to bitmap rendering and changing type of warnings about unsupported metafile records

  Document doc = new Document(getMyDir() + "PdfSaveOptions.HandleRasterWarnings.doc");
  
      MetafileRenderingOptions metafileRenderingOptions = new MetafileRenderingOptions();
      metafileRenderingOptions.setEmulateRasterOperations(false);
  
      // If Aspose.Words cannot correctly render some of the metafile records to vector graphics then Aspose.Words renders this metafile to a bitmap.
      metafileRenderingOptions.setRenderingMode(MetafileRenderingMode.VECTOR_WITH_FALLBACK);
  
      HandleDocumentWarnings callback = new HandleDocumentWarnings();
      doc.setWarningCallback(callback);
  
      PdfSaveOptions saveOptions = new PdfSaveOptions();
      saveOptions.setMetafileRenderingOptions(metafileRenderingOptions);
  
      doc.save(getArtifactsDir() + "PdfSaveOptions.HandleRasterWarnings.pdf", saveOptions);
  
      Assert.assertEquals(callback.mWarnings.getCount(), 1);
      Assert.assertTrue(callback.mWarnings.get(0).getDescription().contains("R2_XORPEN"));
  }
  
  public static 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 processing. The callback can be set to listen for warnings generated during document
       * load and/or document save.
       */
      public void warning(final WarningInfo info) {
          //For now type of warnings about unsupported metafile records changed from DataLoss/UnexpectedContent to MinorFormattingLoss.
          if (info.getWarningType() == WarningType.MINOR_FORMATTING_LOSS) {
              System.out.println("Unsupported operation: " + info.getDescription());
              this.mWarnings.warning(info);
          }
      }
  
      public WarningInfoCollection mWarnings = new WarningInfoCollection();
  }

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

  If the value of this property is changed and page layout is already built then Document.updatePageLayout() is invoked automatically to update any changes.

  Example:

  Demonstrates how to set the numeral format used when saving to PDF.

  PdfSaveOptions options = new PdfSaveOptions();
  options.setNumeralFormat(NumeralFormat.CONTEXT);

• getOptimizeOutput/setOptimizeOutput

  public boolean getOptimizeOutput() / public void setOptimizeOutput(boolean value)
  

  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 formating are concatenated. Note: The accuracy of the content display may be affected if this property is set to true. Default is false.

  Example:

  Shows how to optimize document objects while saving to xps.

  Document doc = new Document(getMyDir() + "XPSOutputOptimize.docx");
  
  XpsSaveOptions saveOptions = new XpsSaveOptions();
  saveOptions.setOptimizeOutput(true);
  
  doc.save(getArtifactsDir() + "XPSOutputOptimize.xps", saveOptions);

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

  Example:

  Converts just one page (third page in this example) of the document to PDF.

  Document doc = new Document(getMyDir() + "Rendering.doc");
  
  OutputStream stream = new FileOutputStream(getArtifactsDir() + "Rendering.SaveToPdfStreamOnePage.pdf");
  try {
      PdfSaveOptions options = new PdfSaveOptions();
      options.setPageIndex(2);
      options.setPageCount(1);
      doc.save(stream, options);
  } finally {
      if (stream != null) {
          stream.close();
      }
  }

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

  Example:

  Converts just one page (third page in this example) of the document to PDF.

  Document doc = new Document(getMyDir() + "Rendering.doc");
  
  OutputStream stream = new FileOutputStream(getArtifactsDir() + "Rendering.SaveToPdfStreamOnePage.pdf");
  try {
      PdfSaveOptions options = new PdfSaveOptions();
      options.setPageIndex(2);
      options.setPageCount(1);
      doc.save(stream, options);
  } finally {
      if (stream != null) {
          stream.close();
      }
  }

• getPageSavingCallback/setPageSavingCallback

  public IPageSavingCallback getPageSavingCallback() / public void setPageSavingCallback(IPageSavingCallback value)
  

  Allows to control how separate pages are saved when a document is exported to fixed page format.

  Example:

  Shows how separate pages are saved when a document is exported to fixed page format.

  Document doc = new Document(getMyDir() + "Rendering.doc");
  
      HtmlFixedSaveOptions htmlFixedSaveOptions = new HtmlFixedSaveOptions();
      htmlFixedSaveOptions.setPageIndex(0);
      htmlFixedSaveOptions.setPageCount(doc.getPageCount());
      htmlFixedSaveOptions.setPageSavingCallback(new CustomPageFileNamePageSavingCallback());
  
      doc.save(getArtifactsDir() + "Rendering.html", htmlFixedSaveOptions);
  
      String[] filePaths = getFiles(getArtifactsDir() + "", "Page_*.html");
  
      for (int i = 0; i < doc.getPageCount(); i++) {
          String file = MessageFormat.format(getArtifactsDir() + "Page_{0}.html", i);
      }
  }
  
  private static String[] getFiles(final String path, final String searchPattern) {
      final Pattern re = Pattern.compile(searchPattern.replace("*", ".*").replace("?", ".?"));
      String[] filenames = new File(path).list(new FilenameFilter() {
          @Override
          public boolean accept(final File dir, final String name) {
              return new File(dir, name).isFile() && re.matcher(name).matches();
          }
      });
      for (int i = 0; i < filenames.length; i++) {
          filenames[i] = path + filenames[i];
      }
      return filenames;
  }
  
  /**
   * Custom PageFileName is specified.
   */
  private static class CustomPageFileNamePageSavingCallback implements IPageSavingCallback {
      public void pageSaving(final PageSavingArgs args) {
          // Specify name of the output file for the current page.
          args.setPageFileName(MessageFormat.format(getArtifactsDir() + "Page_{0}.html", args.getPageIndex()));
      }
  }

• getPrettyFormat/setPrettyFormat

  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(getArtifactsDir() + "Document.PrettyFormat.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.PS. The value of the property is SaveFormat integer constant.

• getTempFolder/setTempFolder

  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.

• getUpdateFields/setUpdateFields

  public boolean getUpdateFields() / public void setUpdateFields(boolean value)
  

  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.

  Allows to specify whether to mimic or not MS Word behaviour.

  Example:

  Shows how to update fields before saving into a PDF document.

  Document doc = DocumentHelper.createDocumentFillWithDummyText();
  
  PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
  pdfSaveOptions.setUpdateFields(false);
  
  doc.save(getArtifactsDir() + "UpdateFields_False.pdf", pdfSaveOptions);

• getUpdateLastSavedTimeProperty/setUpdateLastSavedTimeProperty

  public boolean getUpdateLastSavedTimeProperty() / public void setUpdateLastSavedTimeProperty(boolean value)
  

  Gets or sets a value determining whether the BuiltInDocumentProperties.LastSavedTime property is updated before saving.

  Example:

  Shows how to update a document time property when you want to save it

  Document doc = new Document(getMyDir() + "Document.doc");
  
  //Get last saved time
  Date documentTimeBeforeSave = doc.getBuiltInDocumentProperties().getLastSavedTime();
  
  OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
  saveOptions.setUpdateLastSavedTimeProperty(true);

• getUpdateSdtContent/setUpdateSdtContent

  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

  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, SaveFormat.EMF. 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 PageSetup.MultiplePages.

  If this option is specified, page range set via PageIndex and 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

  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, SaveFormat.EMF.

Method Detail

• equals

  public boolean equals(java.lang.Object obj)