com.aspose.words

Class XamlFlowSaveOptions

  • java.lang.Object
public class XamlFlowSaveOptions 
extends SaveOptions

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

Example:

Shows how to print the filenames of linked images created while converting a document to flow-form .xaml.
public void imageFolder() throws Exception {
    Document doc = new Document(getMyDir() + "Rendering.docx");

    ImageUriPrinter callback = new ImageUriPrinter(getArtifactsDir() + "XamlFlowImageFolderAlias");

    // Create a "XamlFlowSaveOptions" object, which we can pass to the document's "Save" method
    // to modify how we save the document to the XAML save format.
    XamlFlowSaveOptions options = new XamlFlowSaveOptions();

    Assert.assertEquals(SaveFormat.XAML_FLOW, options.getSaveFormat());

    // Use the "ImagesFolder" property to assign a folder in the local file system into which
    // Aspose.Words will save all the document's linked images.
    options.setImagesFolder(getArtifactsDir() + "XamlFlowImageFolder");

    // Use the "ImagesFolderAlias" property to use this folder
    // when constructing image URIs instead of the images folder's name.
    options.setImagesFolderAlias(getArtifactsDir() + "XamlFlowImageFolderAlias");

    options.setImageSavingCallback(callback);

    // A folder specified by "ImagesFolderAlias" will need to contain the resources instead of "ImagesFolder".
    // We must ensure the folder exists before the callback's streams can put their resources into it.
    new File(options.getImagesFolderAlias()).mkdir();

    doc.save(getArtifactsDir() + "XamlFlowSaveOptions.ImageFolder.xaml", options);

    for (String resource : callback.getResources())
        System.out.println("{callback.ImagesFolderAlias}/{resource}");
}

/// <summary>
/// Counts and prints filenames of images while their parent document is converted to flow-form .xaml.
/// </summary>
private static class ImageUriPrinter implements IImageSavingCallback {
    public ImageUriPrinter(String imagesFolderAlias) {
        mImagesFolderAlias = imagesFolderAlias;
        mResources = new ArrayList<String>();
    }

    public void imageSaving(ImageSavingArgs args) throws Exception {
        getResources().add(args.getImageFileName());

        // If we specified an image folder alias, we would also need
        // to redirect each stream to put its image in the alias folder.
        args.setImageStream(new FileOutputStream(MessageFormat.format("{0}/{1}", mImagesFolderAlias, args.getImageFileName())));
        args.setKeepImageStreamOpen(false);
    }

    public String getImagesFolderAlias() {
        return mImagesFolderAlias;
    }

    private final String mImagesFolderAlias;

    public ArrayList<String> getResources() {
        return mResources;
    }

    private final ArrayList<String> mResources;
}

Constructor Summary
XamlFlowSaveOptions()
Initializes a new instance of this class that can be used to save a document in the SaveFormat.XAML_FLOW format.
XamlFlowSaveOptions(intsaveFormat)
Initializes a new instance of this class that can be used to save a document in the SaveFormat.XAML_FLOW or SaveFormat.XAML_FLOW_PACK format.
 
Property Getters/Setters Summary
booleangetAllowEmbeddingPostScriptFonts()
void
           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.
java.lang.StringgetDefaultTemplate()
void
setDefaultTemplate(java.lang.Stringvalue)
           Gets or sets path to default template (including filename). Default value for this property is empty string.
intgetDml3DEffectsRenderingMode()
void
           Gets or sets a value determining how 3D effects are rendered. The value of the property is Dml3DEffectsRenderingMode integer constant.
intgetDmlEffectsRenderingMode()
void
           Gets or sets a value determining how DrawingML effects are rendered. The value of the property is DmlEffectsRenderingMode integer constant.
intgetDmlRenderingMode()
void
           Gets or sets a value determining how DrawingML shapes are rendered. The value of the property is DmlRenderingMode integer constant.
booleangetExportGeneratorName()
void
           When true, causes the name and version of Aspose.Words to be embedded into produced files. Default value is true.
booleangetFlatOpcXmlMappingOnly()
void
           Gets or sets value determining which document formats are allowed to be mapped by StructuredDocumentTag.XmlMapping. By default only LoadFormat.FLAT_OPC document format is allowed to be mapped.
IImageSavingCallbackgetImageSavingCallback()
void
           Allows to control how images are saved when a document is saved to XAML.
java.lang.StringgetImagesFolder()
void
setImagesFolder(java.lang.Stringvalue)
           Specifies the physical folder where images are saved when exporting a document to XAML format. Default is an empty string.
java.lang.StringgetImagesFolderAlias()
void
setImagesFolderAlias(java.lang.Stringvalue)
           Specifies the name of the folder used to construct image URIs written into an XAML document. Default is an empty string.
intgetImlRenderingMode()
void
           Gets or sets a value determining how ink (InkML) objects are rendered. The value of the property is ImlRenderingMode integer constant.
booleangetMemoryOptimization()
void
setMemoryOptimization(booleanvalue)
           Gets or sets value determining if memory optimization should be performed before saving the document. Default value for this property is false.
booleangetPrettyFormat()
void
setPrettyFormat(booleanvalue)
           When true, pretty formats output where applicable. Default value is false.
intgetSaveFormat()
void
setSaveFormat(intvalue)
           Specifies the format in which the document will be saved if this save options object is used. Can only be SaveFormat.XAML_FLOW. The value of the property is SaveFormat integer constant.
java.lang.StringgetTempFolder()
void
setTempFolder(java.lang.Stringvalue)
           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.
booleangetUpdateCreatedTimeProperty()
void
           Gets or sets a value determining whether the BuiltInDocumentProperties.CreatedTime property is updated before saving. Default value is false;
booleangetUpdateFields()
void
setUpdateFields(booleanvalue)
           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.
booleangetUpdateLastPrintedProperty()
void
           Gets or sets a value determining whether the BuiltInDocumentProperties.LastPrinted property is updated before saving.
booleangetUpdateLastSavedTimeProperty()
void
           Gets or sets a value determining whether the BuiltInDocumentProperties.LastSavedTime property is updated before saving.
booleangetUpdateSdtContent()
void
setUpdateSdtContent(booleanvalue)
           Gets or sets value determining whether content of StructuredDocumentTag is updated before saving.
booleangetUseAntiAliasing()
void
setUseAntiAliasing(booleanvalue)
           Gets or sets a value determining whether or not to use anti-aliasing for rendering.
booleangetUseHighQualityRendering()
void
           Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms.
 

    • Constructor Detail

      • XamlFlowSaveOptions

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

        Example:

        Shows how to print the filenames of linked images created while converting a document to flow-form .xaml.
        public void imageFolder() throws Exception {
            Document doc = new Document(getMyDir() + "Rendering.docx");
        
            ImageUriPrinter callback = new ImageUriPrinter(getArtifactsDir() + "XamlFlowImageFolderAlias");
        
            // Create a "XamlFlowSaveOptions" object, which we can pass to the document's "Save" method
            // to modify how we save the document to the XAML save format.
            XamlFlowSaveOptions options = new XamlFlowSaveOptions();
        
            Assert.assertEquals(SaveFormat.XAML_FLOW, options.getSaveFormat());
        
            // Use the "ImagesFolder" property to assign a folder in the local file system into which
            // Aspose.Words will save all the document's linked images.
            options.setImagesFolder(getArtifactsDir() + "XamlFlowImageFolder");
        
            // Use the "ImagesFolderAlias" property to use this folder
            // when constructing image URIs instead of the images folder's name.
            options.setImagesFolderAlias(getArtifactsDir() + "XamlFlowImageFolderAlias");
        
            options.setImageSavingCallback(callback);
        
            // A folder specified by "ImagesFolderAlias" will need to contain the resources instead of "ImagesFolder".
            // We must ensure the folder exists before the callback's streams can put their resources into it.
            new File(options.getImagesFolderAlias()).mkdir();
        
            doc.save(getArtifactsDir() + "XamlFlowSaveOptions.ImageFolder.xaml", options);
        
            for (String resource : callback.getResources())
                System.out.println("{callback.ImagesFolderAlias}/{resource}");
        }
        
        /// <summary>
        /// Counts and prints filenames of images while their parent document is converted to flow-form .xaml.
        /// </summary>
        private static class ImageUriPrinter implements IImageSavingCallback {
            public ImageUriPrinter(String imagesFolderAlias) {
                mImagesFolderAlias = imagesFolderAlias;
                mResources = new ArrayList<String>();
            }
        
            public void imageSaving(ImageSavingArgs args) throws Exception {
                getResources().add(args.getImageFileName());
        
                // If we specified an image folder alias, we would also need
                // to redirect each stream to put its image in the alias folder.
                args.setImageStream(new FileOutputStream(MessageFormat.format("{0}/{1}", mImagesFolderAlias, args.getImageFileName())));
                args.setKeepImageStreamOpen(false);
            }
        
            public String getImagesFolderAlias() {
                return mImagesFolderAlias;
            }
        
            private final String mImagesFolderAlias;
        
            public ArrayList<String> getResources() {
                return mResources;
            }
        
            private final ArrayList<String> mResources;
        }
      • XamlFlowSaveOptions

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

        Example:

        Shows how to print the filenames of linked images created while converting a document to flow-form .xaml.
        public void imageFolder() throws Exception {
            Document doc = new Document(getMyDir() + "Rendering.docx");
        
            ImageUriPrinter callback = new ImageUriPrinter(getArtifactsDir() + "XamlFlowImageFolderAlias");
        
            // Create a "XamlFlowSaveOptions" object, which we can pass to the document's "Save" method
            // to modify how we save the document to the XAML save format.
            XamlFlowSaveOptions options = new XamlFlowSaveOptions();
        
            Assert.assertEquals(SaveFormat.XAML_FLOW, options.getSaveFormat());
        
            // Use the "ImagesFolder" property to assign a folder in the local file system into which
            // Aspose.Words will save all the document's linked images.
            options.setImagesFolder(getArtifactsDir() + "XamlFlowImageFolder");
        
            // Use the "ImagesFolderAlias" property to use this folder
            // when constructing image URIs instead of the images folder's name.
            options.setImagesFolderAlias(getArtifactsDir() + "XamlFlowImageFolderAlias");
        
            options.setImageSavingCallback(callback);
        
            // A folder specified by "ImagesFolderAlias" will need to contain the resources instead of "ImagesFolder".
            // We must ensure the folder exists before the callback's streams can put their resources into it.
            new File(options.getImagesFolderAlias()).mkdir();
        
            doc.save(getArtifactsDir() + "XamlFlowSaveOptions.ImageFolder.xaml", options);
        
            for (String resource : callback.getResources())
                System.out.println("{callback.ImagesFolderAlias}/{resource}");
        }
        
        /// <summary>
        /// Counts and prints filenames of images while their parent document is converted to flow-form .xaml.
        /// </summary>
        private static class ImageUriPrinter implements IImageSavingCallback {
            public ImageUriPrinter(String imagesFolderAlias) {
                mImagesFolderAlias = imagesFolderAlias;
                mResources = new ArrayList<String>();
            }
        
            public void imageSaving(ImageSavingArgs args) throws Exception {
                getResources().add(args.getImageFileName());
        
                // If we specified an image folder alias, we would also need
                // to redirect each stream to put its image in the alias folder.
                args.setImageStream(new FileOutputStream(MessageFormat.format("{0}/{1}", mImagesFolderAlias, args.getImageFileName())));
                args.setKeepImageStreamOpen(false);
            }
        
            public String getImagesFolderAlias() {
                return mImagesFolderAlias;
            }
        
            private final String mImagesFolderAlias;
        
            public ArrayList<String> getResources() {
                return mResources;
            }
        
            private final ArrayList<String> mResources;
        }
    • 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.

        Example:

        Shows how to save the document with PostScript font.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        builder.getFont().setName("PostScriptFont");
        builder.writeln("Some text with PostScript font.");
        
        // Load the font with PostScript to use in the document.
        MemoryFontSource otf = new MemoryFontSource(DocumentHelper.getBytesFromStream(new FileInputStream(getFontsDir() + "AllegroOpen.otf")));
        doc.setFontSettings(new FontSettings());
        doc.getFontSettings().setFontsSources(new FontSourceBase[]{otf});
        
        // Embed TrueType fonts.
        doc.getFontInfos().setEmbedTrueTypeFonts(true);
        
        // Allow embedding PostScript fonts while embedding TrueType fonts.
        // Microsoft Word does not embed PostScript fonts, but can open documents with embedded fonts of this type.
        SaveOptions saveOptions = SaveOptions.createSaveOptions(SaveFormat.DOCX);
        saveOptions.setAllowEmbeddingPostScriptFonts(true);
        
        doc.save(getArtifactsDir() + "Document.AllowEmbeddingPostScriptFonts.docx", saveOptions);
      • 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.

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

      • getExportGeneratorName/setExportGeneratorName

        public boolean getExportGeneratorName() / public void setExportGeneratorName(boolean value)
        
        When true, causes the name and version of Aspose.Words to be embedded into produced files. Default value is true.
      • getFlatOpcXmlMappingOnly/setFlatOpcXmlMappingOnly

        public boolean getFlatOpcXmlMappingOnly() / public void setFlatOpcXmlMappingOnly(boolean value)
        
        Gets or sets value determining which document formats are allowed to be mapped by StructuredDocumentTag.XmlMapping. By default only LoadFormat.FLAT_OPC document format is allowed to be mapped.
      • getImageSavingCallback/setImageSavingCallback

        public IImageSavingCallback getImageSavingCallback() / public void setImageSavingCallback(IImageSavingCallback value)
        
        Allows to control how images are saved when a document is saved to XAML.

        Example:

        Shows how to print the filenames of linked images created while converting a document to flow-form .xaml.
        public void imageFolder() throws Exception {
            Document doc = new Document(getMyDir() + "Rendering.docx");
        
            ImageUriPrinter callback = new ImageUriPrinter(getArtifactsDir() + "XamlFlowImageFolderAlias");
        
            // Create a "XamlFlowSaveOptions" object, which we can pass to the document's "Save" method
            // to modify how we save the document to the XAML save format.
            XamlFlowSaveOptions options = new XamlFlowSaveOptions();
        
            Assert.assertEquals(SaveFormat.XAML_FLOW, options.getSaveFormat());
        
            // Use the "ImagesFolder" property to assign a folder in the local file system into which
            // Aspose.Words will save all the document's linked images.
            options.setImagesFolder(getArtifactsDir() + "XamlFlowImageFolder");
        
            // Use the "ImagesFolderAlias" property to use this folder
            // when constructing image URIs instead of the images folder's name.
            options.setImagesFolderAlias(getArtifactsDir() + "XamlFlowImageFolderAlias");
        
            options.setImageSavingCallback(callback);
        
            // A folder specified by "ImagesFolderAlias" will need to contain the resources instead of "ImagesFolder".
            // We must ensure the folder exists before the callback's streams can put their resources into it.
            new File(options.getImagesFolderAlias()).mkdir();
        
            doc.save(getArtifactsDir() + "XamlFlowSaveOptions.ImageFolder.xaml", options);
        
            for (String resource : callback.getResources())
                System.out.println("{callback.ImagesFolderAlias}/{resource}");
        }
        
        /// <summary>
        /// Counts and prints filenames of images while their parent document is converted to flow-form .xaml.
        /// </summary>
        private static class ImageUriPrinter implements IImageSavingCallback {
            public ImageUriPrinter(String imagesFolderAlias) {
                mImagesFolderAlias = imagesFolderAlias;
                mResources = new ArrayList<String>();
            }
        
            public void imageSaving(ImageSavingArgs args) throws Exception {
                getResources().add(args.getImageFileName());
        
                // If we specified an image folder alias, we would also need
                // to redirect each stream to put its image in the alias folder.
                args.setImageStream(new FileOutputStream(MessageFormat.format("{0}/{1}", mImagesFolderAlias, args.getImageFileName())));
                args.setKeepImageStreamOpen(false);
            }
        
            public String getImagesFolderAlias() {
                return mImagesFolderAlias;
            }
        
            private final String mImagesFolderAlias;
        
            public ArrayList<String> getResources() {
                return mResources;
            }
        
            private final ArrayList<String> mResources;
        }
      • getImagesFolder/setImagesFolder

        public java.lang.String getImagesFolder() / public void setImagesFolder(java.lang.String value)
        
        Specifies the physical folder where images are saved when exporting a document to XAML format. Default is an empty string.

        When you save a Document in XAML format, Aspose.Words needs to save all images embedded in the document as standalone files. ImagesFolder allows you to specify where the images will be saved and ImagesFolderAlias 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 ImagesFolder 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 ImagesFolder property or provide custom streams via the ImageSavingCallback event handler.

        Example:

        Shows how to print the filenames of linked images created while converting a document to flow-form .xaml.
        public void imageFolder() throws Exception {
            Document doc = new Document(getMyDir() + "Rendering.docx");
        
            ImageUriPrinter callback = new ImageUriPrinter(getArtifactsDir() + "XamlFlowImageFolderAlias");
        
            // Create a "XamlFlowSaveOptions" object, which we can pass to the document's "Save" method
            // to modify how we save the document to the XAML save format.
            XamlFlowSaveOptions options = new XamlFlowSaveOptions();
        
            Assert.assertEquals(SaveFormat.XAML_FLOW, options.getSaveFormat());
        
            // Use the "ImagesFolder" property to assign a folder in the local file system into which
            // Aspose.Words will save all the document's linked images.
            options.setImagesFolder(getArtifactsDir() + "XamlFlowImageFolder");
        
            // Use the "ImagesFolderAlias" property to use this folder
            // when constructing image URIs instead of the images folder's name.
            options.setImagesFolderAlias(getArtifactsDir() + "XamlFlowImageFolderAlias");
        
            options.setImageSavingCallback(callback);
        
            // A folder specified by "ImagesFolderAlias" will need to contain the resources instead of "ImagesFolder".
            // We must ensure the folder exists before the callback's streams can put their resources into it.
            new File(options.getImagesFolderAlias()).mkdir();
        
            doc.save(getArtifactsDir() + "XamlFlowSaveOptions.ImageFolder.xaml", options);
        
            for (String resource : callback.getResources())
                System.out.println("{callback.ImagesFolderAlias}/{resource}");
        }
        
        /// <summary>
        /// Counts and prints filenames of images while their parent document is converted to flow-form .xaml.
        /// </summary>
        private static class ImageUriPrinter implements IImageSavingCallback {
            public ImageUriPrinter(String imagesFolderAlias) {
                mImagesFolderAlias = imagesFolderAlias;
                mResources = new ArrayList<String>();
            }
        
            public void imageSaving(ImageSavingArgs args) throws Exception {
                getResources().add(args.getImageFileName());
        
                // If we specified an image folder alias, we would also need
                // to redirect each stream to put its image in the alias folder.
                args.setImageStream(new FileOutputStream(MessageFormat.format("{0}/{1}", mImagesFolderAlias, args.getImageFileName())));
                args.setKeepImageStreamOpen(false);
            }
        
            public String getImagesFolderAlias() {
                return mImagesFolderAlias;
            }
        
            private final String mImagesFolderAlias;
        
            public ArrayList<String> getResources() {
                return mResources;
            }
        
            private final ArrayList<String> mResources;
        }
        See Also:
        ImagesFolderAlias, ImageSavingCallback
      • getImagesFolderAlias/setImagesFolderAlias

        public java.lang.String getImagesFolderAlias() / public void setImagesFolderAlias(java.lang.String value)
        
        Specifies the name of the folder used to construct image URIs written into an XAML document. Default is an empty string.

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

        If ImagesFolderAlias is not an empty string, then the image URI written to XAML will be ImagesFolderAlias + <image file name>.

        If ImagesFolderAlias is an empty string, then the image URI written to XAML will be ImagesFolder + <image file name>.

        If ImagesFolderAlias is set to '.' (dot), then the image file name will be written to XAML without path regardless of other options.

        Example:

        Shows how to print the filenames of linked images created while converting a document to flow-form .xaml.
        public void imageFolder() throws Exception {
            Document doc = new Document(getMyDir() + "Rendering.docx");
        
            ImageUriPrinter callback = new ImageUriPrinter(getArtifactsDir() + "XamlFlowImageFolderAlias");
        
            // Create a "XamlFlowSaveOptions" object, which we can pass to the document's "Save" method
            // to modify how we save the document to the XAML save format.
            XamlFlowSaveOptions options = new XamlFlowSaveOptions();
        
            Assert.assertEquals(SaveFormat.XAML_FLOW, options.getSaveFormat());
        
            // Use the "ImagesFolder" property to assign a folder in the local file system into which
            // Aspose.Words will save all the document's linked images.
            options.setImagesFolder(getArtifactsDir() + "XamlFlowImageFolder");
        
            // Use the "ImagesFolderAlias" property to use this folder
            // when constructing image URIs instead of the images folder's name.
            options.setImagesFolderAlias(getArtifactsDir() + "XamlFlowImageFolderAlias");
        
            options.setImageSavingCallback(callback);
        
            // A folder specified by "ImagesFolderAlias" will need to contain the resources instead of "ImagesFolder".
            // We must ensure the folder exists before the callback's streams can put their resources into it.
            new File(options.getImagesFolderAlias()).mkdir();
        
            doc.save(getArtifactsDir() + "XamlFlowSaveOptions.ImageFolder.xaml", options);
        
            for (String resource : callback.getResources())
                System.out.println("{callback.ImagesFolderAlias}/{resource}");
        }
        
        /// <summary>
        /// Counts and prints filenames of images while their parent document is converted to flow-form .xaml.
        /// </summary>
        private static class ImageUriPrinter implements IImageSavingCallback {
            public ImageUriPrinter(String imagesFolderAlias) {
                mImagesFolderAlias = imagesFolderAlias;
                mResources = new ArrayList<String>();
            }
        
            public void imageSaving(ImageSavingArgs args) throws Exception {
                getResources().add(args.getImageFileName());
        
                // If we specified an image folder alias, we would also need
                // to redirect each stream to put its image in the alias folder.
                args.setImageStream(new FileOutputStream(MessageFormat.format("{0}/{1}", mImagesFolderAlias, args.getImageFileName())));
                args.setKeepImageStreamOpen(false);
            }
        
            public String getImagesFolderAlias() {
                return mImagesFolderAlias;
            }
        
            private final String mImagesFolderAlias;
        
            public ArrayList<String> getResources() {
                return mResources;
            }
        
            private final ArrayList<String> mResources;
        }
        See Also:
        ImagesFolder, ImageSavingCallback
      • getImlRenderingMode/setImlRenderingMode

        public int getImlRenderingMode() / public void setImlRenderingMode(int value)
        
        Gets or sets a value determining how ink (InkML) objects are rendered. The value of the property is ImlRenderingMode integer constant. The default value is ImlRenderingMode.INK_ML.

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

        Example:

        Shows how to render Ink object.
        Document doc = new Document(getMyDir() + "Ink object.docx");
        
        // Set 'ImlRenderingMode.InkML' ignores fall-back shape of ink (InkML) object and renders InkML itself.
        // If the rendering result is unsatisfactory,
        // please use 'ImlRenderingMode.Fallback' to get a result similar to previous versions.
        ImageSaveOptions saveOptions = new ImageSaveOptions(SaveFormat.JPEG);
        {
            saveOptions.setImlRenderingMode(ImlRenderingMode.INK_ML);
        }
        
        doc.save(getArtifactsDir() + "ImageSaveOptions.RenderInkObject.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.
      • 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 enhance the readability of the raw code of a saved .html document.
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        builder.writeln("Hello world!");
        
        HtmlSaveOptions htmlOptions = new HtmlSaveOptions(SaveFormat.HTML);
        {
            htmlOptions.setPrettyFormat(usePrettyFormat);
        }
        
        doc.save(getArtifactsDir() + "HtmlSaveOptions.PrettyFormat.html", htmlOptions);
        
        // Enabling pretty format makes the raw html code more readable by adding tab stop and new line characters.
        String html = FileUtils.readFileToString(new File(getArtifactsDir() + "HtmlSaveOptions.PrettyFormat.html"), StandardCharsets.UTF_8);
        
        if (usePrettyFormat)
            Assert.assertEquals(
                    "<html>\r\n" +
                            "\t<head>\r\n" +
                            "\t\t<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />\r\n" +
                            "\t\t<meta http-equiv=\"Content-Style-Type\" content=\"text/css\" />\r\n" +
                            MessageFormat.format("\t\t<meta name=\"generator\" content=\"{0} {1}\" />\r\n", BuildVersionInfo.getProduct(), BuildVersionInfo.getVersion()) +
                            "\t\t<title>\r\n" +
                            "\t\t</title>\r\n" +
                            "\t</head>\r\n" +
                            "\t<body style=\"font-family:'Times New Roman'; font-size:12pt\">\r\n" +
                            "\t\t<div>\r\n" +
                            "\t\t\t<p style=\"margin-top:0pt; margin-bottom:0pt\">\r\n" +
                            "\t\t\t\t<span>Hello world!</span>\r\n" +
                            "\t\t\t</p>\r\n" +
                            "\t\t\t<p style=\"margin-top:0pt; margin-bottom:0pt\">\r\n" +
                            "\t\t\t\t<span style=\"-aw-import:ignore\">&#xa0;</span>\r\n" +
                            "\t\t\t</p>\r\n" +
                            "\t\t</div>\r\n" +
                            "\t</body>\r\n</html>",
                    html);
        else
            Assert.assertEquals(
                    "<html><head><meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" />" +
                            "<meta http-equiv=\"Content-Style-Type\" content=\"text/css\" />" +
                            MessageFormat.format("<meta name=\"generator\" content=\"{0} {1}\" /><title></title></head>", BuildVersionInfo.getProduct(), BuildVersionInfo.getVersion()) +
                            "<body style=\"font-family:'Times New Roman'; font-size:12pt\">" +
                            "<div><p style=\"margin-top:0pt; margin-bottom:0pt\"><span>Hello world!</span></p>" +
                            "<p style=\"margin-top:0pt; margin-bottom:0pt\"><span style=\"-aw-import:ignore\">&#xa0;</span></p></div></body></html>",
                    html);
      • 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.XAML_FLOW. The value of the property is SaveFormat integer constant.

        Example:

        Shows how to print the filenames of linked images created while converting a document to flow-form .xaml.
        public void imageFolder() throws Exception {
            Document doc = new Document(getMyDir() + "Rendering.docx");
        
            ImageUriPrinter callback = new ImageUriPrinter(getArtifactsDir() + "XamlFlowImageFolderAlias");
        
            // Create a "XamlFlowSaveOptions" object, which we can pass to the document's "Save" method
            // to modify how we save the document to the XAML save format.
            XamlFlowSaveOptions options = new XamlFlowSaveOptions();
        
            Assert.assertEquals(SaveFormat.XAML_FLOW, options.getSaveFormat());
        
            // Use the "ImagesFolder" property to assign a folder in the local file system into which
            // Aspose.Words will save all the document's linked images.
            options.setImagesFolder(getArtifactsDir() + "XamlFlowImageFolder");
        
            // Use the "ImagesFolderAlias" property to use this folder
            // when constructing image URIs instead of the images folder's name.
            options.setImagesFolderAlias(getArtifactsDir() + "XamlFlowImageFolderAlias");
        
            options.setImageSavingCallback(callback);
        
            // A folder specified by "ImagesFolderAlias" will need to contain the resources instead of "ImagesFolder".
            // We must ensure the folder exists before the callback's streams can put their resources into it.
            new File(options.getImagesFolderAlias()).mkdir();
        
            doc.save(getArtifactsDir() + "XamlFlowSaveOptions.ImageFolder.xaml", options);
        
            for (String resource : callback.getResources())
                System.out.println("{callback.ImagesFolderAlias}/{resource}");
        }
        
        /// <summary>
        /// Counts and prints filenames of images while their parent document is converted to flow-form .xaml.
        /// </summary>
        private static class ImageUriPrinter implements IImageSavingCallback {
            public ImageUriPrinter(String imagesFolderAlias) {
                mImagesFolderAlias = imagesFolderAlias;
                mResources = new ArrayList<String>();
            }
        
            public void imageSaving(ImageSavingArgs args) throws Exception {
                getResources().add(args.getImageFileName());
        
                // If we specified an image folder alias, we would also need
                // to redirect each stream to put its image in the alias folder.
                args.setImageStream(new FileOutputStream(MessageFormat.format("{0}/{1}", mImagesFolderAlias, args.getImageFileName())));
                args.setKeepImageStreamOpen(false);
            }
        
            public String getImagesFolderAlias() {
                return mImagesFolderAlias;
            }
        
            private final String mImagesFolderAlias;
        
            public ArrayList<String> getResources() {
                return mResources;
            }
        
            private final ArrayList<String> mResources;
        }
      • 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 java.lang.IndexOutOfBoundsException. 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);
      • getUpdateCreatedTimeProperty/setUpdateCreatedTimeProperty

        public boolean getUpdateCreatedTimeProperty() / public void setUpdateCreatedTimeProperty(boolean value)
        
        Gets or sets a value determining whether the BuiltInDocumentProperties.CreatedTime property is updated before saving. Default value is false;
      • 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.
      • 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 "CreatedTime" property when saving.
        Document doc = new Document();
        
        Calendar calendar = Calendar.getInstance();
        calendar.set(2019, 11, 20);
        doc.getBuiltInDocumentProperties().setCreatedTime(calendar.getTime());
        
        // This flag determines whether the created time, 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 created time.
        DocSaveOptions saveOptions = new DocSaveOptions();
        saveOptions.setUpdateCreatedTimeProperty(isUpdateCreatedTimeProperty);
        
        doc.save(getArtifactsDir() + "DocSaveOptions.UpdateCreatedTimeProperty.docx", saveOptions);

        Example:

        Shows how to update a document's "Last printed" property when saving.
        Document doc = new Document();
        
        Calendar calendar = Calendar.getInstance();
        calendar.set(2019, 11, 20);
        doc.getBuiltInDocumentProperties().setLastPrinted(calendar.getTime());
        
        // 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);
      • 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 determine whether to preserve the document's "Last saved time" property when saving.
        Document doc = new Document(getMyDir() + "Document.docx");
        
        // When we save the document to an OOXML format, we can create an OoxmlSaveOptions object
        // and then pass it to the document's saving method to modify how we save the document.
        // Set the "UpdateLastSavedTimeProperty" property to "true" to
        // set the output document's "Last saved time" built-in property to the current date/time.
        // Set the "UpdateLastSavedTimeProperty" property to "false" to
        // preserve the original value of the input document's "Last saved time" built-in property.
        OoxmlSaveOptions saveOptions = new OoxmlSaveOptions();
        saveOptions.setUpdateLastSavedTimeProperty(updateLastSavedTimeProperty);
        
        doc.save(getArtifactsDir() + "OoxmlSaveOptions.LastSavedTime.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 to update structured document tags while saving a document to PDF.
        Document doc = new Document();
        
        // Insert a drop-down list structured document tag.
        StructuredDocumentTag 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"));
        
        // The drop-down list currently displays "Choose an item" as the default text.
        // Set the "SelectedValue" property to one of the list items to get the tag to
        // display that list item's value instead of the default text.
        tag.getListItems().setSelectedValue(tag.getListItems().get(1));
        
        doc.getFirstSection().getBody().appendChild(tag);
        
        // Create a "PdfSaveOptions" object to pass to the document's "Save" method
        // to modify how that method saves the document to .PDF.
        PdfSaveOptions options = new PdfSaveOptions();
        
        // Set the "UpdateSdtContent" property to "false" not to update the structured document tags
        // while saving the document to PDF. They will display their default values as they were at the time of construction.
        // Set the "UpdateSdtContent" property to "true" to make sure the tags display updated values in the PDF.
        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);