com.aspose.words
Class MarkdownSaveOptions

java.lang.Object
  SaveOptions
      TxtSaveOptionsBase
          com.aspose.words.MarkdownSaveOptions

public class MarkdownSaveOptions 
extends TxtSaveOptionsBase

public void renameImages() throws Exception {
    Document doc = new Document(getMyDir() + "Rendering.docx");

    MarkdownSaveOptions saveOptions = new MarkdownSaveOptions();
    // If we convert a document that contains images into Markdown, we will end up with one Markdown file which links to several images.
    // Each image will be in the form of a file in the local file system.
    // There is also a callback that can customize the name and file system location of each image.
    saveOptions.setImageSavingCallback(new SavedImageRename("MarkdownSaveOptions.HandleDocument.md"));
    saveOptions.setSaveFormat(SaveFormat.MARKDOWN);

    // The ImageSaving() method of our callback will be run at this time.
    doc.save(getArtifactsDir() + "MarkdownSaveOptions.HandleDocument.md", saveOptions);

    Supplier<Stream<String>> filteredShapes = () -> DocumentHelper.directoryGetFiles(
            getArtifactsDir(), "*").stream().
            filter(s -> s.startsWith(getArtifactsDir() + "MarkdownSaveOptions.HandleDocument.md shape"));

    Assert.assertEquals(1, filteredShapes.get().filter(f -> f.endsWith(".jpeg")).count());
    Assert.assertEquals(8, filteredShapes.get().filter(f -> f.endsWith(".png")).count());
}

/// <summary>
/// Renames saved images that are produced when an Markdown document is saved.
/// </summary>
public static class SavedImageRename implements IImageSavingCallback
{
    public SavedImageRename(String outFileName)
    {
        mOutFileName = outFileName;
    }

    public void imageSaving(ImageSavingArgs args) throws Exception
    {
        String imageFileName = MessageFormat.format("{0} shape {1}, of type {2}.{3}",
                mOutFileName, ++mCount, args.getCurrentShape().getShapeType(),
                FilenameUtils.getExtension(args.getImageFileName()));

        args.setImageFileName(imageFileName);
        args.setImageStream(new FileOutputStream(getArtifactsDir() + imageFileName));

        Assert.assertTrue(args.isImageAvailable());
        Assert.assertFalse(args.getKeepImageStreamOpen());
    }

    private int mCount;
    private String mOutFileName;
}

MarkdownSaveOptions

public MarkdownSaveOptions()

Initializes a new instance of this class that can be used to save a document in the SaveFormat.MARKDOWN format.

Example:

Shows how to rename the image name during saving into Markdown document.

public void renameImages() throws Exception {
    Document doc = new Document(getMyDir() + "Rendering.docx");

    MarkdownSaveOptions saveOptions = new MarkdownSaveOptions();
    // If we convert a document that contains images into Markdown, we will end up with one Markdown file which links to several images.
    // Each image will be in the form of a file in the local file system.
    // There is also a callback that can customize the name and file system location of each image.
    saveOptions.setImageSavingCallback(new SavedImageRename("MarkdownSaveOptions.HandleDocument.md"));
    saveOptions.setSaveFormat(SaveFormat.MARKDOWN);

    // The ImageSaving() method of our callback will be run at this time.
    doc.save(getArtifactsDir() + "MarkdownSaveOptions.HandleDocument.md", saveOptions);

    Supplier<Stream<String>> filteredShapes = () -> DocumentHelper.directoryGetFiles(
            getArtifactsDir(), "*").stream().
            filter(s -> s.startsWith(getArtifactsDir() + "MarkdownSaveOptions.HandleDocument.md shape"));

    Assert.assertEquals(1, filteredShapes.get().filter(f -> f.endsWith(".jpeg")).count());
    Assert.assertEquals(8, filteredShapes.get().filter(f -> f.endsWith(".png")).count());
}

/// <summary>
/// Renames saved images that are produced when an Markdown document is saved.
/// </summary>
public static class SavedImageRename implements IImageSavingCallback
{
    public SavedImageRename(String outFileName)
    {
        mOutFileName = outFileName;
    }

    public void imageSaving(ImageSavingArgs args) throws Exception
    {
        String imageFileName = MessageFormat.format("{0} shape {1}, of type {2}.{3}",
                mOutFileName, ++mCount, args.getCurrentShape().getShapeType(),
                FilenameUtils.getExtension(args.getImageFileName()));

        args.setImageFileName(imageFileName);
        args.setImageStream(new FileOutputStream(getArtifactsDir() + imageFileName));

        Assert.assertTrue(args.isImageAvailable());
        Assert.assertFalse(args.getKeepImageStreamOpen());
    }

    private int mCount;
    private String mOutFileName;
}

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

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

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.

Example:

Shows how 3D effects are rendered.

Document doc = new Document(getMyDir() + "DrawingML shape 3D effects.docx");

RenderCallback warningCallback = new RenderCallback();
doc.setWarningCallback(warningCallback);

PdfSaveOptions saveOptions = new PdfSaveOptions();
saveOptions.setDml3DEffectsRenderingMode(Dml3DEffectsRenderingMode.ADVANCED);

doc.save(getArtifactsDir() + "PdfSaveOptions.Dml3DEffectsRenderingModeTest.pdf", saveOptions);

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 the rendering quality of DrawingML effects in a document as we save it to PDF.

Document doc = new Document(getMyDir() + "DrawingML shape effects.docx");

// Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
// to modify how that method converts the document to .PDF.
PdfSaveOptions options = new PdfSaveOptions();

// Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.None" to discard all DrawingML effects.
// Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.Simplified"
// to render a simplified version of DrawingML effects.
// Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.Fine" to
// render DrawingML effects with more accuracy and also with more processing cost.
options.setDmlEffectsRenderingMode(effectsRenderingMode);

Assert.assertEquals(DmlRenderingMode.DRAWING_ML, options.getDmlRenderingMode());

doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingMLEffects.pdf", options);

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

// Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
// to modify how that method converts the document to .PDF.
PdfSaveOptions options = new PdfSaveOptions();

// Set the "DmlRenderingMode" property to "DmlRenderingMode.Fallback"
// to substitute DML shapes with their fallback shapes.
// Set the "DmlRenderingMode" property to "DmlRenderingMode.DrawingML"
// to render the DML shapes themselves.
options.setDmlRenderingMode(dmlRenderingMode);

doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingMLFallback.pdf", options);

Example:

Shows how to configure the rendering quality of DrawingML effects in a document as we save it to PDF.

Document doc = new Document(getMyDir() + "DrawingML shape effects.docx");

// Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
// to modify how that method converts the document to .PDF.
PdfSaveOptions options = new PdfSaveOptions();

// Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.None" to discard all DrawingML effects.
// Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.Simplified"
// to render a simplified version of DrawingML effects.
// Set the "DmlEffectsRenderingMode" property to "DmlEffectsRenderingMode.Fine" to
// render DrawingML effects with more accuracy and also with more processing cost.
options.setDmlEffectsRenderingMode(effectsRenderingMode);

Assert.assertEquals(DmlRenderingMode.DRAWING_ML, options.getDmlRenderingMode());

doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingMLEffects.pdf", options);

public java.nio.charset.Charset getEncoding() / public void setEncoding(java.nio.charset.Charset value)

Specifies the encoding to use when exporting in text formats. Default value is 'UTF-8' Charset.

Example:

Shows how to set encoding for a .txt output document.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Add some text with characters from outside the ASCII character set.
builder.write("À È Ì Ò Ù.");

// Create a "TxtSaveOptions" object, which we can pass to the document's "Save" method
// to modify how we save the document to plaintext.
TxtSaveOptions txtSaveOptions = new TxtSaveOptions();

// Verify that the "Encoding" property contains the appropriate encoding for our document's contents.
Assert.assertEquals(StandardCharsets.UTF_8, txtSaveOptions.getEncoding());

doc.save(getArtifactsDir() + "TxtSaveOptions.Encoding.UTF8.txt", txtSaveOptions);

String docText = new String(Files.readAllBytes(Paths.get(getArtifactsDir() + "TxtSaveOptions.Encoding.UTF8.txt")), StandardCharsets.UTF_8);

Assert.assertEquals("\uFEFFÀ È Ì Ò Ù.", docText.trim());

// Using an unsuitable encoding may result in a loss of document contents.
txtSaveOptions.setEncoding(StandardCharsets.US_ASCII);
doc.save(getArtifactsDir() + "TxtSaveOptions.Encoding.ASCII.txt", txtSaveOptions);
docText = new String(Files.readAllBytes(Paths.get(getArtifactsDir() + "TxtSaveOptions.Encoding.ASCII.txt")), StandardCharsets.US_ASCII);

Assert.assertEquals("? ? ? ? ?.", docText.trim());

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.

Example:

Shows how to disable adding name and version of Aspose.Words into produced files.

Document doc = new Document();

// Use https://docs.aspose.com/words/net/generator-or-producer-name-included-in-output-documents/ to know how to check the result.
OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(); { saveOptions.setExportGeneratorName(false); }

doc.save(getArtifactsDir() + "OoxmlSaveOptions.ExportGeneratorName.docx", saveOptions);

public int getExportHeadersFootersMode() / public void setExportHeadersFootersMode(int value)

Specifies the way headers and footers are exported to the text formats. Default value is TxtExportHeadersFootersMode.PRIMARY_ONLY. The value of the property is TxtExportHeadersFootersMode integer constant.

Example:

Shows how to specify how to export headers and footers to plain text format.

Document doc = new Document();

// Insert even and primary headers/footers into the document.
// The primary header/footers will override the even headers/footers.
doc.getFirstSection().getHeadersFooters().add(new HeaderFooter(doc, HeaderFooterType.HEADER_EVEN));
doc.getFirstSection().getHeadersFooters().getByHeaderFooterType(HeaderFooterType.HEADER_EVEN).appendParagraph("Even header");
doc.getFirstSection().getHeadersFooters().add(new HeaderFooter(doc, HeaderFooterType.FOOTER_EVEN));
doc.getFirstSection().getHeadersFooters().getByHeaderFooterType(HeaderFooterType.FOOTER_EVEN).appendParagraph("Even footer");
doc.getFirstSection().getHeadersFooters().add(new HeaderFooter(doc, HeaderFooterType.HEADER_PRIMARY));
doc.getFirstSection().getHeadersFooters().getByHeaderFooterType(HeaderFooterType.HEADER_PRIMARY).appendParagraph("Primary header");
doc.getFirstSection().getHeadersFooters().add(new HeaderFooter(doc, HeaderFooterType.FOOTER_PRIMARY));
doc.getFirstSection().getHeadersFooters().getByHeaderFooterType(HeaderFooterType.FOOTER_PRIMARY).appendParagraph("Primary footer");

// Insert pages to display these headers and footers.
DocumentBuilder builder = new DocumentBuilder(doc);
builder.writeln("Page 1");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Page 2");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.write("Page 3");

// Create a "TxtSaveOptions" object, which we can pass to the document's "Save" method
// to modify how we save the document to plaintext.
TxtSaveOptions saveOptions = new TxtSaveOptions();

// Set the "ExportHeadersFootersMode" property to "TxtExportHeadersFootersMode.None"
// to not export any headers/footers.
// Set the "ExportHeadersFootersMode" property to "TxtExportHeadersFootersMode.PrimaryOnly"
// to only export primary headers/footers.
// Set the "ExportHeadersFootersMode" property to "TxtExportHeadersFootersMode.AllAtEnd"
// to place all headers and footers for all section bodies at the end of the document.
saveOptions.setExportHeadersFootersMode(txtExportHeadersFootersMode);

doc.save(getArtifactsDir() + "TxtSaveOptions.ExportHeadersFooters.txt", saveOptions);

String docText = new Document(getArtifactsDir() + "TxtSaveOptions.ExportHeadersFooters.txt").getText().trim();

switch (txtExportHeadersFootersMode) {
    case TxtExportHeadersFootersMode.ALL_AT_END:
        Assert.assertEquals("Page 1\r" +
                "Page 2\r" +
                "Page 3\r" +
                "Even header\r\r" +
                "Primary header\r\r" +
                "Even footer\r\r" +
                "Primary footer", docText);

        break;
    case TxtExportHeadersFootersMode.PRIMARY_ONLY:
        Assert.assertEquals("Primary header\r" +
                "Page 1\r" +
                "Page 2\r" +
                "Page 3\r" +
                "Primary footer", docText);
        break;
    case TxtExportHeadersFootersMode.NONE:
        Assert.assertEquals("Page 1\r" +
                "Page 2\r" +
                "Page 3", docText);
        break;
}

public boolean getExportImagesAsBase64() / public void setExportImagesAsBase64(boolean value)

Specifies whether images are saved in Base64 format to the output file. Default value is false.

When this property is set to true images data are exported directly into the img elements and separate files are not created.

Example:

Shows how to save a .md document with images embedded inside it.

Document doc = new Document(getMyDir() + "Images.docx");

MarkdownSaveOptions saveOptions = new MarkdownSaveOptions(); { saveOptions.setExportImagesAsBase64(exportImagesAsBase64); }

doc.save(getArtifactsDir() + "MarkdownSaveOptions.ExportImagesAsBase64.md", saveOptions);

String outDocContents = FileUtils.readFileToString(new File(getArtifactsDir() + "MarkdownSaveOptions.ExportImagesAsBase64.md"), Charset.forName("UTF-8"));

Assert.assertTrue(exportImagesAsBase64
    ? outDocContents.contains("data:image/jpeg;base64")
    : outDocContents.contains("MarkdownSaveOptions.ExportImagesAsBase64.001.jpeg"));

public boolean getExportUnderlineFormatting() / public void setExportUnderlineFormatting(boolean value)

Gets or sets a boolean value indicating either to export underline text formatting as sequence of two plus characters "++". The default value is false.

Example:

Shows how to export underline formatting as ++.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

builder.setUnderline(Underline.SINGLE);
builder.write("Lorem ipsum. Dolor sit amet.");

MarkdownSaveOptions saveOptions = new MarkdownSaveOptions();
saveOptions.setExportUnderlineFormatting(true);
doc.save(getArtifactsDir() + "MarkdownSaveOptions.ExportUnderlineFormatting.md", saveOptions);

public boolean getForcePageBreaks() / public void setForcePageBreaks(boolean value)

Allows to specify whether the page breaks should be preserved during export.

The default value is false.

The property affects only page breaks that are inserted explicitly into a document. It is not related to page breaks that MS Word automatically inserts at the end of each page.

Example:

Shows how to specify whether to preserve page breaks when exporting a document to plaintext.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

builder.writeln("Page 1");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Page 2");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Page 3");

// Create a "TxtSaveOptions" object, which we can pass to the document's "Save"
// method to modify how we save the document to plaintext.
TxtSaveOptions saveOptions = new TxtSaveOptions();

// The Aspose.Words "Document" objects have page breaks, just like Microsoft Word documents.
// Save formats such as ".txt" are one continuous body of text without page breaks.
// Set the "ForcePageBreaks" property to "true" to preserve all page breaks in the form of '\f' characters.
// Set the "ForcePageBreaks" property to "false" to discard all page breaks.
saveOptions.setForcePageBreaks(forcePageBreaks);

doc.save(getArtifactsDir() + "TxtSaveOptions.PageBreaks.txt", saveOptions);

// If we load a plaintext document with page breaks,
// the "Document" object will use them to split the body into pages.
doc = new Document(getArtifactsDir() + "TxtSaveOptions.PageBreaks.txt");

Assert.assertEquals(forcePageBreaks ? 3 : 1, doc.getPageCount());

public IImageSavingCallback getImageSavingCallback() / public void setImageSavingCallback(IImageSavingCallback value)

Allows to control how images are saved when a document is saved to SaveFormat.MARKDOWN format.

Example:

Shows how to rename the image name during saving into Markdown document.

public void renameImages() throws Exception {
    Document doc = new Document(getMyDir() + "Rendering.docx");

    MarkdownSaveOptions saveOptions = new MarkdownSaveOptions();
    // If we convert a document that contains images into Markdown, we will end up with one Markdown file which links to several images.
    // Each image will be in the form of a file in the local file system.
    // There is also a callback that can customize the name and file system location of each image.
    saveOptions.setImageSavingCallback(new SavedImageRename("MarkdownSaveOptions.HandleDocument.md"));
    saveOptions.setSaveFormat(SaveFormat.MARKDOWN);

    // The ImageSaving() method of our callback will be run at this time.
    doc.save(getArtifactsDir() + "MarkdownSaveOptions.HandleDocument.md", saveOptions);

    Supplier<Stream<String>> filteredShapes = () -> DocumentHelper.directoryGetFiles(
            getArtifactsDir(), "*").stream().
            filter(s -> s.startsWith(getArtifactsDir() + "MarkdownSaveOptions.HandleDocument.md shape"));

    Assert.assertEquals(1, filteredShapes.get().filter(f -> f.endsWith(".jpeg")).count());
    Assert.assertEquals(8, filteredShapes.get().filter(f -> f.endsWith(".png")).count());
}

/// <summary>
/// Renames saved images that are produced when an Markdown document is saved.
/// </summary>
public static class SavedImageRename implements IImageSavingCallback
{
    public SavedImageRename(String outFileName)
    {
        mOutFileName = outFileName;
    }

    public void imageSaving(ImageSavingArgs args) throws Exception
    {
        String imageFileName = MessageFormat.format("{0} shape {1}, of type {2}.{3}",
                mOutFileName, ++mCount, args.getCurrentShape().getShapeType(),
                FilenameUtils.getExtension(args.getImageFileName()));

        args.setImageFileName(imageFileName);
        args.setImageStream(new FileOutputStream(getArtifactsDir() + imageFileName));

        Assert.assertTrue(args.isImageAvailable());
        Assert.assertFalse(args.getKeepImageStreamOpen());
    }

    private int mCount;
    private String mOutFileName;
}

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 the SaveFormat.MARKDOWN format. Default is an empty string.

When you save a Document in SaveFormat.MARKDOWN 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.

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.

If the folder specified by ImagesFolder doesn't exist, it will be created automatically.

Example:

Shows how to specifies the name of the folder used to construct image URIs.

DocumentBuilder builder = new DocumentBuilder();

builder.writeln("Some image below:");
builder.insertImage(getImageDir() + "Logo.jpg");

String imagesFolder = Paths.get(getArtifactsDir(), "ImagesDir").toString();
MarkdownSaveOptions saveOptions = new MarkdownSaveOptions();
// 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.
saveOptions.setImagesFolder(imagesFolder);
// Use the "ImagesFolderAlias" property to use this folder
// when constructing image URIs instead of the images folder's name.
saveOptions.setImagesFolderAlias("http://example.com/images");

builder.getDocument().save(getArtifactsDir() + "MarkdownSaveOptions.ImagesFolder.md", saveOptions);

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 a document. Default is an empty string.

When you save a Document in SaveFormat.MARKDOWN 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 Markdown will be ImagesFolderAlias + <image file name>.

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

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

Example:

Shows how to specifies the name of the folder used to construct image URIs.

DocumentBuilder builder = new DocumentBuilder();

builder.writeln("Some image below:");
builder.insertImage(getImageDir() + "Logo.jpg");

String imagesFolder = Paths.get(getArtifactsDir(), "ImagesDir").toString();
MarkdownSaveOptions saveOptions = new MarkdownSaveOptions();
// 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.
saveOptions.setImagesFolder(imagesFolder);
// Use the "ImagesFolderAlias" property to use this folder
// when constructing image URIs instead of the images folder's name.
saveOptions.setImagesFolderAlias("http://example.com/images");

builder.getDocument().save(getArtifactsDir() + "MarkdownSaveOptions.ImagesFolder.md", saveOptions);

See Also:

ImagesFolder, ImageSavingCallback

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

public int getLinkExportMode() / public void setLinkExportMode(int value)

Specifies how links will be written to the output file. Default value is MarkdownLinkExportMode.AUTO. The value of the property is MarkdownLinkExportMode integer constant.

Example:

Shows how to links will be written to the .md file.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
builder.insertShape(ShapeType.BALLOON, 100.0, 100.0);

// Image will be written as reference:
// ![ref1]
//
// [ref1]: aw_ref.001.png
MarkdownSaveOptions saveOptions = new MarkdownSaveOptions();
saveOptions.setLinkExportMode(MarkdownLinkExportMode.REFERENCE);
doc.save(getArtifactsDir() + "MarkdownSaveOptions.LinkExportMode.Reference.md", saveOptions);

// Image will be written as inline:
// ![](aw_inline.001.png)
saveOptions.setLinkExportMode(MarkdownLinkExportMode.INLINE);
doc.save(getArtifactsDir() + "MarkdownSaveOptions.LinkExportMode.Inline.md", saveOptions);

public int getListExportMode() / public void setListExportMode(int value)

Specifies how list items will be written to the output file. Default value is MarkdownListExportMode.MARKDOWN_SYNTAX. The value of the property is MarkdownListExportMode integer constant.

When this property is set to MarkdownListExportMode.PLAIN_TEXT all list labels are updated using Document.updateListLabels() and exported with their actual values. Such lists can be non-compatible with Markdown format and will be recognized as plain text upon importing in this case.

When this property is set to MarkdownListExportMode.MARKDOWN_SYNTAX, writer tries to export list items in manner that allows to numerate list items in automatic mode by Markdown.

Example:

Shows how to list items will be written to the markdown document.

Document doc = new Document(getMyDir() + "List item.docx");

// Use MarkdownListExportMode.PlainText or MarkdownListExportMode.MarkdownSyntax to export list.
MarkdownSaveOptions options = new MarkdownSaveOptions(); { options.setListExportMode(markdownListExportMode); }
doc.save(getArtifactsDir() + "MarkdownSaveOptions.ListExportMode.md", options);

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 rendering large documents to PDF.

Document doc = new Document(getMyDir() + "Rendering.docx");

// Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
// to modify how that method converts the document to .PDF.
SaveOptions saveOptions = SaveOptions.createSaveOptions(SaveFormat.PDF);

// Set the "MemoryOptimization" property to "true" to lower the memory footprint of large documents' saving operations
// at the cost of increasing the duration of the operation.
// Set the "MemoryOptimization" property to "false" to save the document as a PDF normally.
saveOptions.setMemoryOptimization(memoryOptimization);

doc.save(getArtifactsDir() + "PdfSaveOptions.MemoryOptimization.pdf", saveOptions);

public java.lang.String getParagraphBreak() / public void setParagraphBreak(java.lang.String value)

Specifies the string to use as a paragraph break when exporting in text formats.

The default value is ControlChar.CR_LF.

Example:

Shows how to save a .txt document with a custom paragraph break.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

builder.writeln("Paragraph 1.");
builder.writeln("Paragraph 2.");
builder.write("Paragraph 3.");

// Create a "TxtSaveOptions" object, which we can pass to the document's "Save" method
// to modify how we save the document to plaintext.
TxtSaveOptions txtSaveOptions = new TxtSaveOptions();

Assert.assertEquals(SaveFormat.TEXT, txtSaveOptions.getSaveFormat());

// Set the "ParagraphBreak" to a custom value that we wish to put at the end of every paragraph.
txtSaveOptions.setParagraphBreak(" End of paragraph.\r\r\t");

doc.save(getArtifactsDir() + "TxtSaveOptions.ParagraphBreak.txt", txtSaveOptions);

String docText = new Document(getArtifactsDir() + "TxtSaveOptions.ParagraphBreak.txt").getText().trim();

Assert.assertEquals("Paragraph 1. End of paragraph.\r\r\t" +
        "Paragraph 2. End of paragraph.\r\r\t" +
        "Paragraph 3. End of paragraph.", docText);

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

public IDocumentSavingCallback getProgressCallback() / public void setProgressCallback(IDocumentSavingCallback value)

Called during saving a document and accepts data about saving progress.

Progress is reported when saving to SaveFormat.DOCX, SaveFormat.FLAT_OPC, SaveFormat.DOCM, SaveFormat.DOTM, SaveFormat.DOTX, SaveFormat.DOC, SaveFormat.DOT, SaveFormat.HTML, SaveFormat.MHTML, SaveFormat.EPUB, SaveFormat.XAML_FLOW, or SaveFormat.XAML_FLOW_PACK.

Example:

Shows how to manage a document while saving to xamlflow.

public void progressCallback(int saveFormat, String ext) throws Exception
{
    Document doc = new Document(getMyDir() + "Big document.docx");

    // Following formats are supported: XamlFlow, XamlFlowPack.
    XamlFlowSaveOptions saveOptions = new XamlFlowSaveOptions(saveFormat);
    {
        saveOptions.setProgressCallback(new SavingProgressCallback());
    }

    try {
        doc.save(getArtifactsDir() + MessageFormat.format("XamlFlowSaveOptions.ProgressCallback.{0}", ext), saveOptions);
    }
    catch (IllegalStateException exception) {
        Assert.assertTrue(exception.getMessage().contains("EstimatedProgress"));
    }
}

public static Object[][] progressCallbackDataProvider() throws Exception
{
    return new Object[][]
            {
                    {SaveFormat.XAML_FLOW,  "xamlflow"},
                    {SaveFormat.XAML_FLOW_PACK,  "xamlflowpack"},
            };
}

/// <summary>
/// Saving progress callback. Cancel a document saving after the "MaxDuration" seconds.
/// </summary>
public static class SavingProgressCallback implements IDocumentSavingCallback
{
    /// <summary>
    /// Ctr.
    /// </summary>
    public SavingProgressCallback()
    {
        mSavingStartedAt = new Date();
    }

    /// <summary>
    /// Callback method which called during document saving.
    /// </summary>
    /// <param name="args">Saving arguments.</param>
    public void notify(DocumentSavingArgs args)
    {
        Date canceledAt = new Date();
        long diff = canceledAt.getTime() - mSavingStartedAt.getTime();
        long ellapsedSeconds = TimeUnit.MILLISECONDS.toSeconds(diff);

        if (ellapsedSeconds > MAX_DURATION)
            throw new IllegalStateException(MessageFormat.format("EstimatedProgress = {0}; CanceledAt = {1}", args.getEstimatedProgress(), canceledAt));
    }

    /// <summary>
    /// Date and time when document saving is started.
    /// </summary>
    private Date mSavingStartedAt;

    /// <summary>
    /// Maximum allowed duration in sec.
    /// </summary>
    private static final double MAX_DURATION = 0.01d;
}

Example:

Shows how to manage a document while saving to html.

public void progressCallback(int saveFormat, String ext) throws Exception
{
    Document doc = new Document(getMyDir() + "Big document.docx");

    // Following formats are supported: Html, Mhtml, Epub.
    HtmlSaveOptions saveOptions = new HtmlSaveOptions(saveFormat);
    {
        saveOptions.setProgressCallback(new SavingProgressCallback());
    }

    try {
        doc.save(getArtifactsDir() + MessageFormat.format("HtmlSaveOptions.ProgressCallback.{0}", ext), saveOptions);
    }
    catch (IllegalStateException exception) {
        Assert.assertTrue(exception.getMessage().contains("EstimatedProgress"));
    }

}

public static Object[][] progressCallbackDataProvider() throws Exception
{
    return new Object[][]
            {
                    {SaveFormat.HTML,  "html"},
                    {SaveFormat.MHTML,  "mhtml"},
                    {SaveFormat.EPUB,  "epub"},
            };
}

/// <summary>
/// Saving progress callback. Cancel a document saving after the "MaxDuration" seconds.
/// </summary>
public static class SavingProgressCallback implements IDocumentSavingCallback
{
    /// <summary>
    /// Ctr.
    /// </summary>
    public SavingProgressCallback()
    {
        mSavingStartedAt = new Date();
    }

    /// <summary>
    /// Callback method which called during document saving.
    /// </summary>
    /// <param name="args">Saving arguments.</param>
    public void notify(DocumentSavingArgs args)
    {
        Date canceledAt = new Date();
        long diff = canceledAt.getTime() - mSavingStartedAt.getTime();
        long ellapsedSeconds = TimeUnit.MILLISECONDS.toSeconds(diff);

        if (ellapsedSeconds > MAX_DURATION)
            throw new IllegalStateException(MessageFormat.format("EstimatedProgress = {0}; CanceledAt = {1}", args.getEstimatedProgress(), canceledAt));
    }

    /// <summary>
    /// Date and time when document saving is started.
    /// </summary>
    private Date mSavingStartedAt;

    /// <summary>
    /// Maximum allowed duration in sec.
    /// </summary>
    private static final double MAX_DURATION = 0.01d;
}

Example:

Shows how to manage a document while saving to docx.

public void progressCallback(int saveFormat, String ext) throws Exception
{
    Document doc = new Document(getMyDir() + "Big document.docx");

    // Following formats are supported: Docx, FlatOpc, Docm, Dotm, Dotx.
    OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(saveFormat);
    {
        saveOptions.setProgressCallback(new SavingProgressCallback());
    }

    try {
        doc.save(getArtifactsDir() + MessageFormat.format("OoxmlSaveOptions.ProgressCallback.{0}", ext), saveOptions);
    }
    catch (IllegalStateException exception) {
        Assert.assertTrue(exception.getMessage().contains("EstimatedProgress"));
    }
}

public static Object[][] progressCallbackDataProvider() throws Exception
{
    return new Object[][]
            {
                    {SaveFormat.DOCX,  "docx"},
                    {SaveFormat.DOCM,  "docm"},
                    {SaveFormat.DOTM,  "dotm"},
                    {SaveFormat.DOTX,  "dotx"},
                    {SaveFormat.FLAT_OPC,  "flatopc"},
            };
}

/// <summary>
/// Saving progress callback. Cancel a document saving after the "MaxDuration" seconds.
/// </summary>
public static class SavingProgressCallback implements IDocumentSavingCallback
{
    /// <summary>
    /// Ctr.
    /// </summary>
    public SavingProgressCallback()
    {
        mSavingStartedAt = new Date();
    }

    /// <summary>
    /// Callback method which called during document saving.
    /// </summary>
    /// <param name="args">Saving arguments.</param>
    public void notify(DocumentSavingArgs args)
    {
        Date canceledAt = new Date();
        long diff = canceledAt.getTime() - mSavingStartedAt.getTime();
        long ellapsedSeconds = TimeUnit.MILLISECONDS.toSeconds(diff);

        if (ellapsedSeconds > MAX_DURATION)
            throw new IllegalStateException(MessageFormat.format("EstimatedProgress = {0}; CanceledAt = {1}", args.getEstimatedProgress(), canceledAt));
    }

    /// <summary>
    /// Date and time when document saving is started.
    /// </summary>
    private Date mSavingStartedAt;

    /// <summary>
    /// Maximum allowed duration in sec.
    /// </summary>
    private static final double MAX_DURATION = 0.01d;
}

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

Example:

Shows how to rename the image name during saving into Markdown document.

public void renameImages() throws Exception {
    Document doc = new Document(getMyDir() + "Rendering.docx");

    MarkdownSaveOptions saveOptions = new MarkdownSaveOptions();
    // If we convert a document that contains images into Markdown, we will end up with one Markdown file which links to several images.
    // Each image will be in the form of a file in the local file system.
    // There is also a callback that can customize the name and file system location of each image.
    saveOptions.setImageSavingCallback(new SavedImageRename("MarkdownSaveOptions.HandleDocument.md"));
    saveOptions.setSaveFormat(SaveFormat.MARKDOWN);

    // The ImageSaving() method of our callback will be run at this time.
    doc.save(getArtifactsDir() + "MarkdownSaveOptions.HandleDocument.md", saveOptions);

    Supplier<Stream<String>> filteredShapes = () -> DocumentHelper.directoryGetFiles(
            getArtifactsDir(), "*").stream().
            filter(s -> s.startsWith(getArtifactsDir() + "MarkdownSaveOptions.HandleDocument.md shape"));

    Assert.assertEquals(1, filteredShapes.get().filter(f -> f.endsWith(".jpeg")).count());
    Assert.assertEquals(8, filteredShapes.get().filter(f -> f.endsWith(".png")).count());
}

/// <summary>
/// Renames saved images that are produced when an Markdown document is saved.
/// </summary>
public static class SavedImageRename implements IImageSavingCallback
{
    public SavedImageRename(String outFileName)
    {
        mOutFileName = outFileName;
    }

    public void imageSaving(ImageSavingArgs args) throws Exception
    {
        String imageFileName = MessageFormat.format("{0} shape {1}, of type {2}.{3}",
                mOutFileName, ++mCount, args.getCurrentShape().getShapeType(),
                FilenameUtils.getExtension(args.getImageFileName()));

        args.setImageFileName(imageFileName);
        args.setImageStream(new FileOutputStream(getArtifactsDir() + imageFileName));

        Assert.assertTrue(args.isImageAvailable());
        Assert.assertFalse(args.getKeepImageStreamOpen());
    }

    private int mCount;
    private String mOutFileName;
}

public int getTableContentAlignment() / public void setTableContentAlignment(int value)

Gets or sets a value that specifies how to align contents in tables when exporting into the SaveFormat.MARKDOWN format. The default value is TableContentAlignment.AUTO. The value of the property is TableContentAlignment integer constant.

Example:

Shows how to align contents in tables.

DocumentBuilder builder = new DocumentBuilder();

builder.insertCell();
builder.getParagraphFormat().setAlignment(ParagraphAlignment.RIGHT);
builder.write("Cell1");
builder.insertCell();
builder.getParagraphFormat().setAlignment(ParagraphAlignment.CENTER);
builder.write("Cell2");

MarkdownSaveOptions saveOptions = new MarkdownSaveOptions(); { saveOptions.setTableContentAlignment(tableContentAlignment); }

builder.getDocument().save(getArtifactsDir() + "MarkdownSaveOptions.MarkdownDocumentTableContentAlignment.md", saveOptions);

Document doc = new Document(getArtifactsDir() + "MarkdownSaveOptions.MarkdownDocumentTableContentAlignment.md");
Table table = doc.getFirstSection().getBody().getTables().get(0);

switch (tableContentAlignment)
{
    case TableContentAlignment.AUTO:
        Assert.assertEquals(ParagraphAlignment.RIGHT,
            table.getFirstRow().getCells().get(0).getFirstParagraph().getParagraphFormat().getAlignment());
        Assert.assertEquals(ParagraphAlignment.CENTER,
            table.getFirstRow().getCells().get(1).getFirstParagraph().getParagraphFormat().getAlignment());
        break;
    case TableContentAlignment.LEFT:
        Assert.assertEquals(ParagraphAlignment.LEFT,
            table.getFirstRow().getCells().get(0).getFirstParagraph().getParagraphFormat().getAlignment());
        Assert.assertEquals(ParagraphAlignment.LEFT,
            table.getFirstRow().getCells().get(1).getFirstParagraph().getParagraphFormat().getAlignment());
        break;
    case TableContentAlignment.CENTER:
        Assert.assertEquals(ParagraphAlignment.CENTER,
            table.getFirstRow().getCells().get(0).getFirstParagraph().getParagraphFormat().getAlignment());
        Assert.assertEquals(ParagraphAlignment.CENTER,
            table.getFirstRow().getCells().get(1).getFirstParagraph().getParagraphFormat().getAlignment());
        break;
    case TableContentAlignment.RIGHT:
        Assert.assertEquals(ParagraphAlignment.RIGHT,
            table.getFirstRow().getCells().get(0).getFirstParagraph().getParagraphFormat().getAlignment());
        Assert.assertEquals(ParagraphAlignment.RIGHT,
            table.getFirstRow().getCells().get(1).getFirstParagraph().getParagraphFormat().getAlignment());
        break;
}

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.

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

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;

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

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 all the fields in a document immediately before saving it to PDF.

Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Insert text with PAGE and NUMPAGES fields. These fields do not display the correct value in real time.
// We will need to manually update them using updating methods such as "Field.Update()", and "Document.UpdateFields()"
// each time we need them to display accurate values.
builder.write("Page ");
builder.insertField("PAGE", "");
builder.write(" of ");
builder.insertField("NUMPAGES", "");
builder.insertBreak(BreakType.PAGE_BREAK);
builder.writeln("Hello World!");

// Create a "PdfSaveOptions" object that we can pass to the document's "Save" method
// to modify how that method converts the document to .PDF.
PdfSaveOptions options = new PdfSaveOptions();

// Set the "UpdateFields" property to "false" to not update all the fields in a document right before a save operation.
// This is the preferable option if we know that all our fields will be up to date before saving.
// Set the "UpdateFields" property to "true" to iterate through all the document
// fields and update them before we save it as a PDF. This will make sure that all the fields will display
// the most accurate values in the PDF.
options.setUpdateFields(updateFields);

// We can clone PdfSaveOptions objects.
Assert.assertNotSame(options, options.deepClone());

doc.save(getArtifactsDir() + "PdfSaveOptions.UpdateFields.pdf", options);

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

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

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

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, SaveFormat.EPUB, SaveFormat.AZW_3 or SaveFormat.MOBI 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);

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