com.aspose.words

Constructor Detail

• SvgSaveOptions

  public SvgSaveOptions()

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.

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

• getExportEmbeddedImages/setExportEmbeddedImages

  public boolean getExportEmbeddedImages() / public void setExportEmbeddedImages(boolean value)
  

  Specified whether images should be embedded into SVG document as base64. Note setting this flag can significantly increase size of output SVG file.

  Example:

  Shows how to manipulate and print the URIs of linked resources created during conversion of a document to .svg.

  public void svgResourceFolder() throws Exception {
      // Open a document which contains images
      Document doc = new Document(getMyDir() + "Rendering.docx");
  
      SvgSaveOptions options = new SvgSaveOptions();
      {
          options.setSaveFormat(SaveFormat.SVG);
          options.setExportEmbeddedImages(false);
          options.setResourcesFolder(getArtifactsDir() + "SvgResourceFolder");
          options.setResourcesFolderAlias(getArtifactsDir() + "SvgResourceFolderAlias");
          options.setShowPageBorder(false);
  
          options.setResourceSavingCallback(new ResourceUriPrinter());
      }
  
      new File(options.getResourcesFolderAlias()).mkdir();
  
      doc.save(getArtifactsDir() + "SvgSaveOptions.SvgResourceFolder.svg", options);
  }
  
  /// <summary>
  /// Counts and prints URIs of resources contained by as they are converted to .svg.
  /// </summary>
  private static class ResourceUriPrinter implements IResourceSavingCallback {
      public void resourceSaving(ResourceSavingArgs args) {
          // If we set a folder alias in the SaveOptions object, it will be printed here
          System.out.println(MessageFormat.format("Resource #{0} \"{1}\"", ++mSavedResourceCount, args.getResourceFileName()));
          System.out.println("\t" + args.getResourceFileUri());
      }
  
      private int mSavedResourceCount;
  }

• getFitToViewPort/setFitToViewPort

  public boolean getFitToViewPort() / public void setFitToViewPort(boolean value)
  

  Specifies if the output SVG should fill the available viewport area (browser window or container). When set to true width and height of output SVG are set to 100%.

  The default value is false.

  Example:

  Shows how to mimic the properties of images when converting a .docx document to .svg.

  Document doc = new Document(getMyDir() + "Document.docx");
  
  // Configure the SvgSaveOptions object to save with no page borders or selectable text
  SvgSaveOptions options = new SvgSaveOptions();
  {
      options.setFitToViewPort(true);
      options.setShowPageBorder(false);
      options.setTextOutputMode(SvgTextOutputMode.USE_PLACED_GLYPHS);
  }
  
  doc.save(getArtifactsDir() + "SvgSaveOptions.SaveLikeImage.svg", options);

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

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

  public void handleBinaryRasterWarnings() throws Exception {
      Document doc = new Document(getMyDir() + "WMF with image.docx");
  
      MetafileRenderingOptions metafileRenderingOptions = new MetafileRenderingOptions();
      metafileRenderingOptions.setEmulateRasterOperations(false);
      metafileRenderingOptions.setRenderingMode(MetafileRenderingMode.VECTOR_WITH_FALLBACK);
  
      // If Aspose.Words cannot correctly render some of the metafile records to vector graphics then Aspose.Words renders this metafile to a bitmap
      HandleDocumentWarnings callback = new HandleDocumentWarnings();
      doc.setWarningCallback(callback);
  
      PdfSaveOptions saveOptions = new PdfSaveOptions();
      saveOptions.setMetafileRenderingOptions(metafileRenderingOptions);
  
      doc.save(getArtifactsDir() + "PdfSaveOptions.HandleBinaryRasterWarnings.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.

  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 save. Default is java.lang.Integer.MAX_VALUE which means all pages of the document will be rendered.

  Overrides PageSet when set.

  Example:

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

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  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

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

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

  Overrides PageSet when set.

  Example:

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

  Document doc = new Document(getMyDir() + "Rendering.docx");
  
  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.

  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.

  Overrides PageIndex and PageCount when set.

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

• getResourceSavingCallback/setResourceSavingCallback

  public IResourceSavingCallback getResourceSavingCallback() / public void setResourceSavingCallback(IResourceSavingCallback value)
  

  Allows to control how resources (images) are saved when a document is exported to SVG format.

  Example:

  Shows how to manipulate and print the URIs of linked resources created during conversion of a document to .svg.

  public void svgResourceFolder() throws Exception {
      // Open a document which contains images
      Document doc = new Document(getMyDir() + "Rendering.docx");
  
      SvgSaveOptions options = new SvgSaveOptions();
      {
          options.setSaveFormat(SaveFormat.SVG);
          options.setExportEmbeddedImages(false);
          options.setResourcesFolder(getArtifactsDir() + "SvgResourceFolder");
          options.setResourcesFolderAlias(getArtifactsDir() + "SvgResourceFolderAlias");
          options.setShowPageBorder(false);
  
          options.setResourceSavingCallback(new ResourceUriPrinter());
      }
  
      new File(options.getResourcesFolderAlias()).mkdir();
  
      doc.save(getArtifactsDir() + "SvgSaveOptions.SvgResourceFolder.svg", options);
  }
  
  /// <summary>
  /// Counts and prints URIs of resources contained by as they are converted to .svg.
  /// </summary>
  private static class ResourceUriPrinter implements IResourceSavingCallback {
      public void resourceSaving(ResourceSavingArgs args) {
          // If we set a folder alias in the SaveOptions object, it will be printed here
          System.out.println(MessageFormat.format("Resource #{0} \"{1}\"", ++mSavedResourceCount, args.getResourceFileName()));
          System.out.println("\t" + args.getResourceFileUri());
      }
  
      private int mSavedResourceCount;
  }

• getResourcesFolder/setResourcesFolder

  public java.lang.String getResourcesFolder() / public void setResourcesFolder(java.lang.String value)
  

  Specifies the physical folder where resources (images) are saved when exporting a document to Svg format. Default is null.

  Has effect only if ExportEmbeddedImages property is false.

  When you save a Document in SVG format, Aspose.Words needs to save all images embedded in the document as standalone files. ResourcesFolder allows you to specify where the images will be saved and ResourcesFolderAlias allows to specify how the image URIs will be constructed.

  If you save a document into a file and provide a file name, Aspose.Words, by default, saves the images in the same folder where the document file is saved. Use ResourcesFolder to override this behavior.

  If you save a document into a stream, Aspose.Words does not have a folder where to save the images, but still needs to save the images somewhere. In this case, you need to specify an accessible folder in the ResourcesFolder property

  Example:

  Shows how to manipulate and print the URIs of linked resources created during conversion of a document to .svg.

  public void svgResourceFolder() throws Exception {
      // Open a document which contains images
      Document doc = new Document(getMyDir() + "Rendering.docx");
  
      SvgSaveOptions options = new SvgSaveOptions();
      {
          options.setSaveFormat(SaveFormat.SVG);
          options.setExportEmbeddedImages(false);
          options.setResourcesFolder(getArtifactsDir() + "SvgResourceFolder");
          options.setResourcesFolderAlias(getArtifactsDir() + "SvgResourceFolderAlias");
          options.setShowPageBorder(false);
  
          options.setResourceSavingCallback(new ResourceUriPrinter());
      }
  
      new File(options.getResourcesFolderAlias()).mkdir();
  
      doc.save(getArtifactsDir() + "SvgSaveOptions.SvgResourceFolder.svg", options);
  }
  
  /// <summary>
  /// Counts and prints URIs of resources contained by as they are converted to .svg.
  /// </summary>
  private static class ResourceUriPrinter implements IResourceSavingCallback {
      public void resourceSaving(ResourceSavingArgs args) {
          // If we set a folder alias in the SaveOptions object, it will be printed here
          System.out.println(MessageFormat.format("Resource #{0} \"{1}\"", ++mSavedResourceCount, args.getResourceFileName()));
          System.out.println("\t" + args.getResourceFileUri());
      }
  
      private int mSavedResourceCount;
  }

  See Also:

  ResourcesFolderAlias

• getResourcesFolderAlias/setResourcesFolderAlias

  public java.lang.String getResourcesFolderAlias() / public void setResourcesFolderAlias(java.lang.String value)
  

  Specifies the name of the folder used to construct image URIs written into an SVG document. Default is null.

  When you save a Document in SVG format, Aspose.Words needs to save all images embedded in the document as standalone files. ResourcesFolder allows you to specify where the images will be saved and ResourcesFolderAlias allows to specify how the image URIs will be constructed.

  Example:

  Shows how to manipulate and print the URIs of linked resources created during conversion of a document to .svg.

  public void svgResourceFolder() throws Exception {
      // Open a document which contains images
      Document doc = new Document(getMyDir() + "Rendering.docx");
  
      SvgSaveOptions options = new SvgSaveOptions();
      {
          options.setSaveFormat(SaveFormat.SVG);
          options.setExportEmbeddedImages(false);
          options.setResourcesFolder(getArtifactsDir() + "SvgResourceFolder");
          options.setResourcesFolderAlias(getArtifactsDir() + "SvgResourceFolderAlias");
          options.setShowPageBorder(false);
  
          options.setResourceSavingCallback(new ResourceUriPrinter());
      }
  
      new File(options.getResourcesFolderAlias()).mkdir();
  
      doc.save(getArtifactsDir() + "SvgSaveOptions.SvgResourceFolder.svg", options);
  }
  
  /// <summary>
  /// Counts and prints URIs of resources contained by as they are converted to .svg.
  /// </summary>
  private static class ResourceUriPrinter implements IResourceSavingCallback {
      public void resourceSaving(ResourceSavingArgs args) {
          // If we set a folder alias in the SaveOptions object, it will be printed here
          System.out.println(MessageFormat.format("Resource #{0} \"{1}\"", ++mSavedResourceCount, args.getResourceFileName()));
          System.out.println("\t" + args.getResourceFileUri());
      }
  
      private int mSavedResourceCount;
  }

  See Also:

  ResourcesFolder

• 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.SVG. The value of the property is SaveFormat integer constant.

  Example:

  Shows how to manipulate and print the URIs of linked resources created during conversion of a document to .svg.

  public void svgResourceFolder() throws Exception {
      // Open a document which contains images
      Document doc = new Document(getMyDir() + "Rendering.docx");
  
      SvgSaveOptions options = new SvgSaveOptions();
      {
          options.setSaveFormat(SaveFormat.SVG);
          options.setExportEmbeddedImages(false);
          options.setResourcesFolder(getArtifactsDir() + "SvgResourceFolder");
          options.setResourcesFolderAlias(getArtifactsDir() + "SvgResourceFolderAlias");
          options.setShowPageBorder(false);
  
          options.setResourceSavingCallback(new ResourceUriPrinter());
      }
  
      new File(options.getResourcesFolderAlias()).mkdir();
  
      doc.save(getArtifactsDir() + "SvgSaveOptions.SvgResourceFolder.svg", options);
  }
  
  /// <summary>
  /// Counts and prints URIs of resources contained by as they are converted to .svg.
  /// </summary>
  private static class ResourceUriPrinter implements IResourceSavingCallback {
      public void resourceSaving(ResourceSavingArgs args) {
          // If we set a folder alias in the SaveOptions object, it will be printed here
          System.out.println(MessageFormat.format("Resource #{0} \"{1}\"", ++mSavedResourceCount, args.getResourceFileName()));
          System.out.println("\t" + args.getResourceFileUri());
      }
  
      private int mSavedResourceCount;
  }

• getShowPageBorder/setShowPageBorder

  public boolean getShowPageBorder() / public void setShowPageBorder(boolean value)
  

  Controls whether a border is added to the outline of the page. Default is true.

  Example:

  Shows how to mimic the properties of images when converting a .docx document to .svg.

  Document doc = new Document(getMyDir() + "Document.docx");
  
  // Configure the SvgSaveOptions object to save with no page borders or selectable text
  SvgSaveOptions options = new SvgSaveOptions();
  {
      options.setFitToViewPort(true);
      options.setShowPageBorder(false);
      options.setTextOutputMode(SvgTextOutputMode.USE_PLACED_GLYPHS);
  }
  
  doc.save(getArtifactsDir() + "SvgSaveOptions.SaveLikeImage.svg", 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);

• getTextOutputMode/setTextOutputMode

  public int getTextOutputMode() / public void setTextOutputMode(int value)
  

  Gets or sets a value determining how text should be rendered in SVG. The value of the property is SvgTextOutputMode integer constant.

  Use this property to get or set the mode of how text inside a document should be rendered when saving in SVG format.

  The default value is SvgTextOutputMode.USE_TARGET_MACHINE_FONTS.

  Example:

  Shows how to mimic the properties of images when converting a .docx document to .svg.

  Document doc = new Document(getMyDir() + "Document.docx");
  
  // Configure the SvgSaveOptions object to save with no page borders or selectable text
  SvgSaveOptions options = new SvgSaveOptions();
  {
      options.setFitToViewPort(true);
      options.setShowPageBorder(false);
      options.setTextOutputMode(SvgTextOutputMode.USE_PLACED_GLYPHS);
  }
  
  doc.save(getArtifactsDir() + "SvgSaveOptions.SaveLikeImage.svg", 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);

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

Method Detail

• equals

  public boolean equals(java.lang.Object obj)

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