com.aspose.words

Constructor Detail

• ImageSaveOptions

  public ImageSaveOptions(int saveFormat)

  Initializes a new instance of this class that can be used to save rendered images in the SaveFormat.TIFF, SaveFormat.PNG, SaveFormat.BMP, SaveFormat.EMF, SaveFormat.JPEG or SaveFormat.SVG format. SaveFormat.PNG, SaveFormat.BMP, SaveFormat.JPEG or SaveFormat.SVG format.

  Parameters:

  saveFormat - A SaveFormat value. Can be SaveFormat.TIFF, SaveFormat.PNG, SaveFormat.BMP, SaveFormat.EMF, SaveFormat.JPEG or SaveFormat.SVG. SaveFormat.PNG, SaveFormat.BMP, SaveFormat.JPEG or SaveFormat.SVG.

  Example:

  Shows how to save a document to the JPEG format using the Save method and the ImageSaveOptions class.

  // Open the document
  Document doc = new Document(getMyDir() + "Rendering.docx");
  // Save as a JPEG image file with default options
  doc.save(getArtifactsDir() + "Rendering.SaveAsImage.DefaultJpgOptions.jpg");
  
  // Save document to an ByteArrayOutputStream as a JPEG with default options
  ByteArrayOutputStream docStream = new ByteArrayOutputStream();
  doc.save(docStream, SaveFormat.JPEG);
  
  // Save document to a JPEG image with specified options
  // Render the third page only and set the JPEG quality to 80%
  // In this case we need to pass the desired SaveFormat to the ImageSaveOptions constructor 
  // to signal what type of image to save as
  ImageSaveOptions imageOptions = new ImageSaveOptions(SaveFormat.JPEG);
  imageOptions.setPageIndex(2);
  imageOptions.setPageCount(1);
  imageOptions.setJpegQuality(80);
  doc.save(getArtifactsDir() + "Rendering.SaveAsImage.CustomJpgOptions.jpg", imageOptions);

Property Getters/Setters Detail

• getAllowEmbeddingPostScriptFonts/setAllowEmbeddingPostScriptFonts

  public boolean getAllowEmbeddingPostScriptFonts() / public void setAllowEmbeddingPostScriptFonts(boolean value)
  

  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.

  Note, Word does not embed PostScript fonts, but can open documents with embedded fonts of this type.

  This option only works when FontInfoCollection.EmbedTrueTypeFonts of the DocumentBase.FontInfos property is set to true.

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

  Example:

  Shows how change image color with save options property.

  Document doc = new Document(getMyDir() + "Images.docx");
  
  // Configure PdfSaveOptions to save every image in the input document in greyscale during conversion
  PdfSaveOptions pdfSaveOptions = new PdfSaveOptions();
  {
      pdfSaveOptions.setColorMode(ColorMode.GRAYSCALE);
  }
  
  doc.save(getArtifactsDir() + "PdfSaveOptions.ColorRendering.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.AutomaticallyUpdateStyles is true, but Document.AttachedTemplate is empty.

  Example:

  Shows how to set a default template for documents that do not have attached templates.

  Document doc = new Document();
  
  // Enable automatic style updating, but do not attach a template document.
  doc.setAutomaticallyUpdateStyles(true);
  
  Assert.assertEquals("", doc.getAttachedTemplate());
  
  // Since there is no template document, the document had nowhere to track style changes.
  // Use a SaveOptions object to automatically set a template
  // if a document that we are saving does not have one.
  SaveOptions options = SaveOptions.createSaveOptions("Document.DefaultTemplate.docx");
  options.setDefaultTemplate(getMyDir() + "Business brochure.dotx");
  
  doc.save(getArtifactsDir() + "Document.DefaultTemplate.docx", options);

• getDml3DEffectsRenderingMode/setDml3DEffectsRenderingMode

  public int getDml3DEffectsRenderingMode() / public void setDml3DEffectsRenderingMode(int value)
  

  Gets or sets a value determining how 3D effects are rendered. The value of the property is Dml3DEffectsRenderingMode integer constant.

  The default value is Dml3DEffectsRenderingMode.BASIC.

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

  Example:

  Shows how to configure DrawingML rendering quality with PdfSaveOptions.

  Document doc = new Document(getMyDir() + "DrawingML shape effects.docx");
  
  PdfSaveOptions options = new PdfSaveOptions();
  options.setDmlEffectsRenderingMode(effectsRenderingMode);
  
  Assert.assertEquals(DmlRenderingMode.DRAWING_ML, options.getDmlRenderingMode());
  
  doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingMLEffects.pdf", options);

• 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 render fallback shapes when saving to Pdf.

  Document doc = new Document(getMyDir() + "DrawingML shape fallbacks.docx");
  
  PdfSaveOptions options = new PdfSaveOptions();
  options.setDmlRenderingMode(dmlRenderingMode);
  
  doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingMLFallback.pdf", options);

  Example:

  Shows how to configure DrawingML rendering quality with PdfSaveOptions.

  Document doc = new Document(getMyDir() + "DrawingML shape effects.docx");
  
  PdfSaveOptions options = new PdfSaveOptions();
  options.setDmlEffectsRenderingMode(effectsRenderingMode);
  
  Assert.assertEquals(DmlRenderingMode.DRAWING_ML, options.getDmlRenderingMode());
  
  doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingMLEffects.pdf", options);

• getGraphicsQualityOptions/setGraphicsQualityOptions

  public GraphicsQualityOptions getGraphicsQualityOptions() / public void setGraphicsQualityOptions(GraphicsQualityOptions value)
  

  Allows to specify rendering mode and quality for the System.Drawing.Graphics object.

  Use this property to override the Graphics settings provided by Aspose.Words engine by default.

  It will take effect only when a document is being saved to an image-like format.

  Example:

  Shows how to set render quality options when converting documents to image formats.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  GraphicsQualityOptions qualityOptions = new GraphicsQualityOptions();
  qualityOptions.getRenderingHints().put(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON); // SmoothingMode
  qualityOptions.getRenderingHints().put(RenderingHints.KEY_TEXT_ANTIALIASING, RenderingHints.VALUE_TEXT_ANTIALIAS_ON); // TextRenderingHint
  qualityOptions.getRenderingHints().put(RenderingHints.KEY_COLOR_RENDERING, RenderingHints.VALUE_COLOR_RENDER_QUALITY); // CompositingMode
  qualityOptions.getRenderingHints().put(RenderingHints.KEY_RENDERING, RenderingHints.VALUE_RENDER_QUALITY); // CompositingQuality
  qualityOptions.getRenderingHints().put(RenderingHints.KEY_INTERPOLATION, RenderingHints.VALUE_INTERPOLATION_BILINEAR); // InterpolationMode
  qualityOptions.getRenderingHints().put(RenderingHints.KEY_FRACTIONALMETRICS, RenderingHints.VALUE_FRACTIONALMETRICS_ON); // StringFormat
  
  ImageSaveOptions saveOptions = new ImageSaveOptions(SaveFormat.JPEG);
  saveOptions.setGraphicsQualityOptions(qualityOptions);
  
  doc.save(getArtifactsDir() + "ImageSaveOptions.GraphicsQuality.jpg", saveOptions);

• getHorizontalResolution/setHorizontalResolution

  public float getHorizontalResolution() / public void setHorizontalResolution(float value)
  

  Gets or sets the horizontal resolution for the generated images, in dots per inch.

  This property has effect only when saving to raster image formats and affects the output size in pixels.

  The default value is 96.

  Example:

  Shows how to edit image.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  // When saving the document as an image, we can use an ImageSaveOptions object to edit various aspects of it
  ImageSaveOptions options = new ImageSaveOptions(SaveFormat.PNG);
  {
      options.setImageBrightness(0.3f);     // 0 - 1 scale, default at 0.5
      options.setImageContrast(0.7f);       // 0 - 1 scale, default at 0.5
      options.setHorizontalResolution(72f); // Default at 96.0 meaning 96dpi, image dimensions will be affected if we change resolution
      options.setVerticalResolution(72f);   // Default at 96.0 meaning 96dpi
      options.setScale(96f / 72f);           // Default at 1.0 for normal scale, can be used to negate resolution impact in image size
  }
  
  doc.save(getArtifactsDir() + "ImageSaveOptions.EditImage.png", options);

• getImageBrightness/setImageBrightness

  public float getImageBrightness() / public void setImageBrightness(float value)
  

  Gets or sets the brightness for the generated images.

  This property has effect only when saving to raster image formats.

  The default value is 0.5. The value must be in the range between 0 and 1.

  Example:

  Shows how to edit image.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  // When saving the document as an image, we can use an ImageSaveOptions object to edit various aspects of it
  ImageSaveOptions options = new ImageSaveOptions(SaveFormat.PNG);
  {
      options.setImageBrightness(0.3f);     // 0 - 1 scale, default at 0.5
      options.setImageContrast(0.7f);       // 0 - 1 scale, default at 0.5
      options.setHorizontalResolution(72f); // Default at 96.0 meaning 96dpi, image dimensions will be affected if we change resolution
      options.setVerticalResolution(72f);   // Default at 96.0 meaning 96dpi
      options.setScale(96f / 72f);           // Default at 1.0 for normal scale, can be used to negate resolution impact in image size
  }
  
  doc.save(getArtifactsDir() + "ImageSaveOptions.EditImage.png", options);

• getImageColorMode/setImageColorMode

  public int getImageColorMode() / public void setImageColorMode(int value)
  

  Gets or sets the color mode for the generated images. The value of the property is ImageColorMode integer constant.

  This property has effect only when saving to raster image formats.

  The default value is ImageColorMode.NONE.

  Example:

  Show how to convert document images to black and white with 1 bit per pixel

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  ImageSaveOptions imageSaveOptions = new ImageSaveOptions(SaveFormat.PNG);
  imageSaveOptions.setImageColorMode(ImageColorMode.BLACK_AND_WHITE);
  imageSaveOptions.setPixelFormat(ImagePixelFormat.FORMAT_1_BPP_INDEXED);
  
  // ImageSaveOptions instances can be cloned
  Assert.assertNotEquals(imageSaveOptions.deepClone(), imageSaveOptions);
  
  doc.save(getArtifactsDir() + "ImageSaveOptions.BlackAndWhite.png", imageSaveOptions);

• getImageContrast/setImageContrast

  public float getImageContrast() / public void setImageContrast(float value)
  

  Gets or sets the contrast for the generated images.

  This property has effect only when saving to raster image formats.

  The default value is 0.5. The value must be in the range between 0 and 1.

  Example:

  Shows how to edit image.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  // When saving the document as an image, we can use an ImageSaveOptions object to edit various aspects of it
  ImageSaveOptions options = new ImageSaveOptions(SaveFormat.PNG);
  {
      options.setImageBrightness(0.3f);     // 0 - 1 scale, default at 0.5
      options.setImageContrast(0.7f);       // 0 - 1 scale, default at 0.5
      options.setHorizontalResolution(72f); // Default at 96.0 meaning 96dpi, image dimensions will be affected if we change resolution
      options.setVerticalResolution(72f);   // Default at 96.0 meaning 96dpi
      options.setScale(96f / 72f);           // Default at 1.0 for normal scale, can be used to negate resolution impact in image size
  }
  
  doc.save(getArtifactsDir() + "ImageSaveOptions.EditImage.png", options);

• getJpegQuality/setJpegQuality

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

  Gets or sets a value determining the quality of the generated JPEG images.

  Has effect only when saving to JPEG.

  Use this property to get or set the quality of generated images when saving in JPEG 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.

  Example:

  Converts a page of a Word document into JPEG images of different qualities.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  ImageSaveOptions saveOptions = new ImageSaveOptions(SaveFormat.JPEG);
  
  // Try worst quality
  saveOptions.setJpegQuality(0);
  doc.save(getArtifactsDir() + "Rendering.SaveToImageJpegQuality.0.jpeg", saveOptions);
  
  // Try best quality
  saveOptions.setJpegQuality(100);
  doc.save(getArtifactsDir() + "Rendering.SaveToImageJpegQuality.100.jpeg", saveOptions);

• 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() + "Rendering.docx");
  
  // When set to true it will improve document memory footprint but will add extra time to processing
  SaveOptions saveOptions = SaveOptions.createSaveOptions(SaveFormat.PDF);
  saveOptions.setMemoryOptimization(true);
  
  doc.save(getArtifactsDir() + "PdfSaveOptions.MemoryOptimization.pdf", saveOptions);

• getMetafileRenderingOptions

  public MetafileRenderingOptions getMetafileRenderingOptions()
  

  Allows to specify how metafiles are treated in the rendered output.

  When MetafileRenderingMode.VECTOR is specified, Aspose.Words renders metafile to vector graphics using its own metafile rendering engine first and then renders vector graphics to the image.

  When MetafileRenderingMode.BITMAP is specified, Aspose.Words renders metafile directly to the image using the GDI+ metafile rendering engine.

  GDI+ metafile rendering engine works faster, supports almost all metafile features but on low resolutions may produce inconsistent result when compared to the rest of vector graphics (especially for text) on the page. Aspose.Words metafile rendering engine will produce more consistent result even on low resolutions but works slower and may inaccurately render complex metafiles.

  The default value for MetafileRenderingMode is MetafileRenderingMode.BITMAP.

  Example:

  Shows how to set the rendering mode for Windows Metafiles.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Use a DocumentBuilder to insert a .wmf image into the document
  builder.insertImage(getImageDir() + "Windows MetaFile.wmf");
  
  // Save the document as an image while setting different metafile rendering modes,
  // which will be applied to the image we inserted
  ImageSaveOptions options = new ImageSaveOptions(SaveFormat.PNG);
  options.getMetafileRenderingOptions().setRenderingMode(MetafileRenderingMode.VECTOR);
  
  doc.save(getArtifactsDir() + "ImageSaveOptions.WindowsMetaFile.png", 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.

  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.

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  builder.writeln("1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 50, 100");
  
  PdfSaveOptions options = new PdfSaveOptions();
  options.setNumeralFormat(NumeralFormat.EASTERN_ARABIC_INDIC);
  
  doc.save(getArtifactsDir() + "Rendering.SetNumeralFormat.pdf", options);

• 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 formatting 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() + "Unoptimized document.docx");
  
  // When saving to .xps, we can use SaveOptions to optimize the output in some cases
  XpsSaveOptions saveOptions = new XpsSaveOptions(); { saveOptions.setOptimizeOutput(optimizeOutput); }
  
  doc.save(getArtifactsDir() + "XpsSaveOptions.OptimizeOutput.xps", saveOptions);

  Example:

  Shows how to optimize document objects while saving to html.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  HtmlFixedSaveOptions saveOptions = new HtmlFixedSaveOptions();
  {
      saveOptions.setOptimizeOutput(false);
  }
  
  doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.OptimizeGraphicsOutput.Unoptimized.html", saveOptions);
  
  saveOptions.setOptimizeOutput(true);
  
  doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.OptimizeGraphicsOutput.Optimized.html", saveOptions);
  
  Assert.assertTrue(new File(getArtifactsDir() + "HtmlFixedSaveOptions.OptimizeGraphicsOutput.Unoptimized.html").length() >
          new File(getArtifactsDir() + "HtmlFixedSaveOptions.OptimizeGraphicsOutput.Optimized.html").length());

• getPageCount/setPageCount

  @Deprecated
  public int getPageCount() / public void setPageCount(int value)
  

  Deprecated. Gets or sets the number of pages to render when saving to a multipage TIFF or SVG file (for other formats only the first page of the range is saved).

  Default is java.lang.Integer.MAX_VALUE which means all pages of the document will be rendered.

  This property has effect only when rendering document pages. This property is ignored when rendering shapes to images.

  OverridesPageSet when set.

  Example:

  Converts a page of a Word document into a TIFF image and uses the CCITT compression.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  ImageSaveOptions options = new ImageSaveOptions(SaveFormat.TIFF);
  options.setTiffCompression(TiffCompression.CCITT_3);
  options.setPageIndex(0);
  options.setPageCount(1);
  
  doc.save(getArtifactsDir() + "Rendering.SaveToTiffCompression.tiff", options);

• getPageIndex/setPageIndex

  @Deprecated
  public int getPageIndex() / public void setPageIndex(int value)
  

  Deprecated. Gets or sets the 0-based index of the first page to render. Default is 0.

  This property has effect only when rendering document pages. This property is ignored when rendering shapes to images.

  OverridesPageSet when set.

  Example:

  Converts a page of a Word document into a TIFF image and uses the CCITT compression.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  ImageSaveOptions options = new ImageSaveOptions(SaveFormat.TIFF);
  options.setTiffCompression(TiffCompression.CCITT_3);
  options.setPageIndex(0);
  options.setPageCount(1);
  
  doc.save(getArtifactsDir() + "Rendering.SaveToTiffCompression.tiff", options);

  Example:

  Shows how to save specific document page as image file.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  // For formats that can only save one page at a time,
  // the SaveOptions object can determine which page gets saved
  ImageSaveOptions saveOptions = new ImageSaveOptions(SaveFormat.GIF);
  saveOptions.setPageIndex(1);
  
  doc.save(getArtifactsDir() + "ImageSaveOptions.SaveSinglePage.gif", saveOptions);

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

  public void pageFileName() throws Exception {
      Document doc = new Document(getMyDir() + "Rendering.docx");
  
      HtmlFixedSaveOptions htmlFixedSaveOptions =
              new HtmlFixedSaveOptions();
      {
          htmlFixedSaveOptions.setPageIndex(0);
          htmlFixedSaveOptions.setPageCount(doc.getPageCount());
      }
      htmlFixedSaveOptions.setPageSavingCallback(new CustomPageFileNamePageSavingCallback());
  
      doc.save(getArtifactsDir() + "SavingCallback.PageFileName.html", htmlFixedSaveOptions);
  
      ArrayList<String> filePaths = DocumentHelper.directoryGetFiles(getArtifactsDir(), "SavingCallback.PageFileName.Page_*.html");
  
      for (int i = 0; i < doc.getPageCount(); i++) {
          String file = getArtifactsDir() + MessageFormat.format("SavingCallback.PageFileName.Page_{0}.html", i);
      }
  }
  
  /// <summary>
  /// Custom PageFileName is specified.
  /// </summary>
  private static class CustomPageFileNamePageSavingCallback implements IPageSavingCallback {
      public void pageSaving(PageSavingArgs args) throws Exception {
          String outFileName = getArtifactsDir() + MessageFormat.format("SavingCallback.PageFileName.Page_{0}.html", args.getPageIndex());
  
          // Specify name of the output file for the current page either in this 
          args.setPageFileName(outFileName);
  
          // ..or by setting up a custom stream
          args.setPageStream(new FileOutputStream(outFileName));
          Assert.assertFalse(args.getKeepPageStreamOpen());
      }
  }

• getPageSet/setPageSet

  public PageSet getPageSet() / public void setPageSet(PageSet value)
  

  Gets or sets the pages to render. Default is all the pages in the document.

  This property has effect only when rendering document pages. This property is ignored when rendering shapes to images.

  OverridesPageIndex andPageCount when set.

• getPaperColor/setPaperColor

  public java.awt.Color getPaperColor() / public void setPaperColor(java.awt.Color value)
  

  Gets or sets the background (paper) color for the generated images.

  The default value is java.awt.Color.WHITE.

  When rendering pages of a document that specifies its own background color, then the document background color will override the color specified by this property.

  Example:

  Renders a page of a Word document into an image with transparent or colored background.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  ImageSaveOptions imgOptions = new ImageSaveOptions(SaveFormat.PNG);
  
  imgOptions.setPaperColor(new Color(0, 0, 0, 0));
  doc.save(getArtifactsDir() + "Rendering.SaveToImagePaperColor.Transparent.png", imgOptions);
  
  imgOptions.setPaperColor(new Color(0x80, 0x80, 0x70));
  doc.save(getArtifactsDir() + "Rendering.SaveToImagePaperColor.Coral.png", imgOptions);

• getPixelFormat/setPixelFormat

  public int getPixelFormat() / public void setPixelFormat(int value)
  

  Gets or sets the pixel format for the generated images. The value of the property is ImagePixelFormat integer constant.

  This property has effect only when saving to raster image formats.

  The default value is ImagePixelFormat.FORMAT_32_BPP_ARGB.

  Pixel format of the output image may differ from the set value because of work of GDI+.

  Example:

  Show how to convert document images to black and white with 1 bit per pixel

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  ImageSaveOptions imageSaveOptions = new ImageSaveOptions(SaveFormat.PNG);
  imageSaveOptions.setImageColorMode(ImageColorMode.BLACK_AND_WHITE);
  imageSaveOptions.setPixelFormat(ImagePixelFormat.FORMAT_1_BPP_INDEXED);
  
  // ImageSaveOptions instances can be cloned
  Assert.assertNotEquals(imageSaveOptions.deepClone(), imageSaveOptions);
  
  doc.save(getArtifactsDir() + "ImageSaveOptions.BlackAndWhite.png", imageSaveOptions);

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

• setResolution

  public void setResolution(float value)
  

  Sets both horizontal and vertical resolution for the generated images, in dots per inch.

  This property has effect only when saving to raster image formats.

  Example:

  Renders a page of a Word document into a PNG image at a specific resolution.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  ImageSaveOptions options = new ImageSaveOptions(SaveFormat.PNG);
  options.setResolution(300);
  options.setPageCount(1);
  
  doc.save(getArtifactsDir() + "Rendering.SaveToImageResolution.png", options);

• getSaveFormat/setSaveFormat

  public int getSaveFormat() / public void setSaveFormat(int value)
  

  Specifies the format in which the rendered document pages or shapes will be saved if this save options object is used. Can be a raster SaveFormat.PNG, SaveFormat.BMP, SaveFormat.JPEG or vector SaveFormat.SVG. The value of the property is SaveFormat integer constant.

  On different platforms, the supported formats may be different. The number of other options depends on the selected format.

  Also, it is possible to save to SVG both via ImageSaveOptions and via SvgSaveOptions.

  Example:

  Shows how to edit image.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  // When saving the document as an image, we can use an ImageSaveOptions object to edit various aspects of it
  ImageSaveOptions options = new ImageSaveOptions(SaveFormat.PNG);
  {
      options.setImageBrightness(0.3f);     // 0 - 1 scale, default at 0.5
      options.setImageContrast(0.7f);       // 0 - 1 scale, default at 0.5
      options.setHorizontalResolution(72f); // Default at 96.0 meaning 96dpi, image dimensions will be affected if we change resolution
      options.setVerticalResolution(72f);   // Default at 96.0 meaning 96dpi
      options.setScale(96f / 72f);           // Default at 1.0 for normal scale, can be used to negate resolution impact in image size
  }
  
  doc.save(getArtifactsDir() + "ImageSaveOptions.EditImage.png", options);

• getScale/setScale

  public float getScale() / public void setScale(float value)
  

  Gets or sets the zoom factor for the generated images.

  The default value is 1.0. The value must be greater than 0.

  Example:

  Shows how to edit image.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  // When saving the document as an image, we can use an ImageSaveOptions object to edit various aspects of it
  ImageSaveOptions options = new ImageSaveOptions(SaveFormat.PNG);
  {
      options.setImageBrightness(0.3f);     // 0 - 1 scale, default at 0.5
      options.setImageContrast(0.7f);       // 0 - 1 scale, default at 0.5
      options.setHorizontalResolution(72f); // Default at 96.0 meaning 96dpi, image dimensions will be affected if we change resolution
      options.setVerticalResolution(72f);   // Default at 96.0 meaning 96dpi
      options.setScale(96f / 72f);           // Default at 1.0 for normal scale, can be used to negate resolution impact in image size
  }
  
  doc.save(getArtifactsDir() + "ImageSaveOptions.EditImage.png", options);

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

  Example:

  Shows how to use the hard drive instead of memory when saving a document.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  // When we save a document, various elements are temporarily stored in memory as the save operation is taking place.
  // We can use this option to use a temporary folder in the local file system instead,
  // which will reduce our application's memory overhead.
  DocSaveOptions options = new DocSaveOptions();
  options.setTempFolder(getArtifactsDir() + "TempFiles");
  
  // The specified temporary folder must exist in the local file system before the save operation.
  new File(options.getTempFolder()).mkdir();
  
  doc.save(getArtifactsDir() + "DocSaveOptions.TempFolder.doc", options);
  
  // The folder will persist with no residual contents from the load operation.
  Assert.assertEquals(new File(options.getTempFolder()).listFiles().length, 0);

• getThresholdForFloydSteinbergDithering/setThresholdForFloydSteinbergDithering

  public byte getThresholdForFloydSteinbergDithering() / public void setThresholdForFloydSteinbergDithering(byte value)
  

  Gets or sets the threshold that determines the value of the binarization error in the Floyd-Steinberg method. when ImageBinarizationMethod is ImageBinarizationMethod.FloydSteinbergDithering.

  The default value is 128.

  Example:

  Shows how to control the threshold for TIFF binarization in the Floyd-Steinberg method.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  ImageSaveOptions options = new ImageSaveOptions(SaveFormat.TIFF);
  options.setTiffCompression(TiffCompression.CCITT_3);
  options.setImageColorMode(ImageColorMode.GRAYSCALE);
  options.setTiffBinarizationMethod(ImageBinarizationMethod.FLOYD_STEINBERG_DITHERING);
  // The default value of this property is 128. The higher value, the darker image
  options.setThresholdForFloydSteinbergDithering((byte) 254);
  
  doc.save(getArtifactsDir() + "ImageSaveOptions.FloydSteinbergDithering.tiff", options);

• getTiffBinarizationMethod/setTiffBinarizationMethod

  public int getTiffBinarizationMethod() / public void setTiffBinarizationMethod(int value)
  

  Gets or sets method used while converting images to 1 bpp format when SaveFormat is SaveFormat.Tiff and TiffCompression is equal to TiffCompression.Ccitt3 or TiffCompression.Ccitt4. The value of the property is ImageBinarizationMethod integer constant.

  The default value is ImageBinarizationMethod.Threshold.

  Example:

  Shows how to control the threshold for TIFF binarization in the Floyd-Steinberg method.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  ImageSaveOptions options = new ImageSaveOptions(SaveFormat.TIFF);
  options.setTiffCompression(TiffCompression.CCITT_3);
  options.setImageColorMode(ImageColorMode.GRAYSCALE);
  options.setTiffBinarizationMethod(ImageBinarizationMethod.FLOYD_STEINBERG_DITHERING);
  // The default value of this property is 128. The higher value, the darker image
  options.setThresholdForFloydSteinbergDithering((byte) 254);
  
  doc.save(getArtifactsDir() + "ImageSaveOptions.FloydSteinbergDithering.tiff", options);

• getTiffCompression/setTiffCompression

  public int getTiffCompression() / public void setTiffCompression(int value)
  

  Gets or sets the type of compression to apply when saving generated images to the TIFF format. The value of the property is TiffCompression integer constant.

  Has effect only when saving to TIFF.

  The default value is TiffCompression.CCITT_4.

  Example:

  Converts a page of a Word document into a TIFF image and uses the CCITT compression.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  ImageSaveOptions options = new ImageSaveOptions(SaveFormat.TIFF);
  options.setTiffCompression(TiffCompression.CCITT_3);
  options.setPageIndex(0);
  options.setPageCount(1);
  
  doc.save(getArtifactsDir() + "Rendering.SaveToTiffCompression.tiff", options);

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

  Example:

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

  Document doc = new Document();
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  // Insert two pages of text, including two fields that will need to be updated to display an accurate value
  builder.write("Page ");
  builder.insertField("PAGE", "");
  builder.write(" of ");
  builder.insertField("NUMPAGES", "");
  builder.insertBreak(BreakType.PAGE_BREAK);
  builder.writeln("Hello World!");
  
  PdfSaveOptions options = new PdfSaveOptions();
  options.setUpdateFields(doUpdateFields);
  
  // PdfSaveOptions objects can be cloned
  Assert.assertNotSame(options, options.deepClone());
  
  doc.save(getArtifactsDir() + "PdfSaveOptions.UpdateFields.pdf", options);

• getUpdateLastPrintedProperty/setUpdateLastPrintedProperty

  public boolean getUpdateLastPrintedProperty() / public void setUpdateLastPrintedProperty(boolean value)
  

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

  Example:

  Shows how to update a document's "Last printed" property when saving.

  Document doc = new Document();
  
  // This flag determines whether the last printed date, which is a built-in property, is updated.
  // If so, then the date of the document's most recent save operation
  // with this SaveOptions object passed as a parameter is used as the print date.
  DocSaveOptions saveOptions = new DocSaveOptions();
  saveOptions.setUpdateLastPrintedProperty(isUpdateLastPrintedProperty);
  
  // In Microsoft Word 2003, this property can be found via File -> Properties -> Statistics -> Printed.
  // It can also be displayed in the document's body by using a PRINTDATE field.
  doc.save(getArtifactsDir() + "DocSaveOptions.UpdateLastPrintedProperty.doc", saveOptions);
  
  // Open the saved document, then verify the value of the property.
  doc = new Document(getArtifactsDir() + "DocSaveOptions.UpdateLastPrintedProperty.doc");
  
  Assert.assertNotEquals(Calendar.getInstance().getTime(), doc.getBuiltInDocumentProperties().getLastPrinted());

• 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.docx");
  
  // Get last saved time
  Date documentTimeBeforeSave = doc.getBuiltInDocumentProperties().getLastSavedTime();
  
  OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
  saveOptions.setUpdateLastSavedTimeProperty(true);
  
  doc.save(getArtifactsDir() + "OoxmlSaveOptions.UpdatingLastSavedTimeDocument.docx", saveOptions);

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

  Example:

  Shows how structured document tags can be updated while saving to .pdf.

  Document doc = new Document();
  
  // Insert two StructuredDocumentTags; a date and a drop down list
  StructuredDocumentTag tag = new StructuredDocumentTag(doc, SdtType.DATE, MarkupLevel.BLOCK);
  tag.setFullDate(new Date());
  
  doc.getFirstSection().getBody().appendChild(tag);
  
  tag = new StructuredDocumentTag(doc, SdtType.DROP_DOWN_LIST, MarkupLevel.BLOCK);
  tag.getListItems().add(new SdtListItem("Value 1"));
  tag.getListItems().add(new SdtListItem("Value 2"));
  tag.getListItems().add(new SdtListItem("Value 3"));
  tag.getListItems().setSelectedValue(tag.getListItems().get(1));
  
  doc.getFirstSection().getBody().appendChild(tag);
  
  // We've selected default values for both tags
  // We can save those values in the document without immediately updating the tags, leaving them in their default state
  // by using a SaveOptions object with this flag set
  PdfSaveOptions options = new PdfSaveOptions();
  options.setUpdateSdtContent(updateSdtContent);
  
  doc.save(getArtifactsDir() + "StructuredDocumentTag.UpdateSdtContent.pdf", options);

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

  Example:

  Shows how to improve the quality of a rendered document with SaveOptions.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  builder.getFont().setSize(60.0);
  builder.writeln("Some text.");
  
  SaveOptions options = new ImageSaveOptions(SaveFormat.JPEG);
  
  doc.save(getArtifactsDir() + "Document.ImageSaveOptions.Default.jpg", options);
  
  options.setUseAntiAliasing(true);
  options.setUseHighQualityRendering(true);
  
  doc.save(getArtifactsDir() + "Document.ImageSaveOptions.HighQuality.jpg", options);

• getUseGdiEmfRenderer/setUseGdiEmfRenderer

  public boolean getUseGdiEmfRenderer() / public void setUseGdiEmfRenderer(boolean value)
  

  Gets or sets a value determining whether to use GDI+ or Aspose.Words metafile renderer when saving to EMF.

  If set to true GDI+ metafile renderer is used. I.e. content is written to GDI+ graphics object and saved to metafile.

  If set to false Aspose.Words metafile renderer is used. I.e. content is written directly to the metafile format with Aspose.Words.

  Has effect only when saving to EMF.

  GDI+ saving works only on .NET.

  The default value is true.

  Example:

  Shows how to save metafiles directly without using GDI+ to EMF.

  Document doc = new Document(getMyDir() + "Images.docx");
  
  ImageSaveOptions saveOptions = new ImageSaveOptions(SaveFormat.EMF);
  saveOptions.setUseGdiEmfRenderer(true);
  
  doc.save(getArtifactsDir() + "ImageSaveOptions.Renderer.emf", saveOptions);

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

  Example:

  Shows how to improve the quality of a rendered document with SaveOptions.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  DocumentBuilder builder = new DocumentBuilder(doc);
  
  builder.getFont().setSize(60.0);
  builder.writeln("Some text.");
  
  SaveOptions options = new ImageSaveOptions(SaveFormat.JPEG);
  
  doc.save(getArtifactsDir() + "Document.ImageSaveOptions.Default.jpg", options);
  
  options.setUseAntiAliasing(true);
  options.setUseHighQualityRendering(true);
  
  doc.save(getArtifactsDir() + "Document.ImageSaveOptions.HighQuality.jpg", options);

• getVerticalResolution/setVerticalResolution

  public float getVerticalResolution() / public void setVerticalResolution(float value)
  

  Gets or sets the vertical resolution for the generated images, in dots per inch.

  This property has effect only when saving to raster image formats and affects the output size in pixels.

  The default value is 96.

  Example:

  Shows how to edit image.

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  // When saving the document as an image, we can use an ImageSaveOptions object to edit various aspects of it
  ImageSaveOptions options = new ImageSaveOptions(SaveFormat.PNG);
  {
      options.setImageBrightness(0.3f);     // 0 - 1 scale, default at 0.5
      options.setImageContrast(0.7f);       // 0 - 1 scale, default at 0.5
      options.setHorizontalResolution(72f); // Default at 96.0 meaning 96dpi, image dimensions will be affected if we change resolution
      options.setVerticalResolution(72f);   // Default at 96.0 meaning 96dpi
      options.setScale(96f / 72f);           // Default at 1.0 for normal scale, can be used to negate resolution impact in image size
  }
  
  doc.save(getArtifactsDir() + "ImageSaveOptions.EditImage.png", options);

Method Detail

• deepClone

  public ImageSaveOptions deepClone()

  Creates a deep clone of this object.

  Example:

  Show how to convert document images to black and white with 1 bit per pixel

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  ImageSaveOptions imageSaveOptions = new ImageSaveOptions(SaveFormat.PNG);
  imageSaveOptions.setImageColorMode(ImageColorMode.BLACK_AND_WHITE);
  imageSaveOptions.setPixelFormat(ImagePixelFormat.FORMAT_1_BPP_INDEXED);
  
  // ImageSaveOptions instances can be cloned
  Assert.assertNotEquals(imageSaveOptions.deepClone(), imageSaveOptions);
  
  doc.save(getArtifactsDir() + "ImageSaveOptions.BlackAndWhite.png", imageSaveOptions);

• equals

  public boolean equals(java.lang.Object obj)

  Determines whether the specified object is equal in value to the current object.