java.lang.ObjectSaveOptions
FixedPageSaveOptions
com.aspose.words.HtmlFixedSaveOptions
public class HtmlFixedSaveOptions
Example:
public void htmlFixedResourceFolder() throws Exception {
// Open a document which contains images
Document doc = new Document(getMyDir() + "Rendering.docx");
HtmlFixedSaveOptions options = new HtmlFixedSaveOptions();
{
options.setSaveFormat(SaveFormat.HTML_FIXED);
options.setExportEmbeddedImages(false);
options.setResourcesFolder(getArtifactsDir() + "HtmlFixedResourceFolder");
options.setResourcesFolderAlias(getArtifactsDir() + "HtmlFixedResourceFolderAlias");
options.setShowPageBorder(false);
options.setResourceSavingCallback(new ResourceUriPrinter());
}
// A folder specified by ResourcesFolderAlias will contain the resources instead of ResourcesFolder
// We must ensure the folder exists before the streams can put their resources into it
new File(options.getResourcesFolderAlias()).mkdir();
doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.HtmlFixedResourceFolder.html", options);
}
/// <summary>
/// Counts and prints URIs of resources contained by as they are converted to fixed .Html.
/// </summary>
private static class ResourceUriPrinter implements IResourceSavingCallback {
public void resourceSaving(ResourceSavingArgs args) throws Exception {
// If we set a folder alias in the SaveOptions object, it will be printed here
System.out.println(MessageFormat.format("Resource #{0} \"{1}\"", ++mSavedResourceCount, args.getResourceFileName()));
String extension = FilenameUtils.getExtension(args.getResourceFileName());
switch (extension) {
case "ttf":
case "woff": {
// By default 'ResourceFileUri' used system folder for fonts
// To avoid problems across platforms you must explicitly specify the path for the fonts
args.setResourceFileUri(getArtifactsDir() + File.separatorChar + args.getResourceFileName());
break;
}
}
System.out.println("\t" + args.getResourceFileUri());
// If we specified a ResourcesFolderAlias we will also need to redirect each stream to put its resource in that folder
args.setResourceStream(new FileOutputStream(args.getResourceFileUri()));
args.setKeepResourceStreamOpen(false);
}
private int mSavedResourceCount;
}
Constructor Summary |
---|
HtmlFixedSaveOptions()
|
Property Getters/Setters Summary | ||
---|---|---|
int | getColorMode() | → inherited from FixedPageSaveOptions |
void | setColorMode(int value) | |
Gets or sets a value determining how colors are rendered. The value of the property is ColorMode integer constant. | ||
java.lang.String | getCssClassNamesPrefix() | |
void | setCssClassNamesPrefix(java.lang.String value) | |
Specifies prefix which is added to all class names in style.css file.
Default value is "aw" .
|
||
java.lang.String | getDefaultTemplate() | → inherited from SaveOptions |
void | setDefaultTemplate(java.lang.String value) | |
Gets or sets path to default template (including filename). Default value for this property is empty string. | ||
int | getDml3DEffectsRenderingMode() | → inherited from SaveOptions |
void | setDml3DEffectsRenderingMode(int value) | |
Gets or sets a value determining how 3D effects are rendered. The value of the property is Dml3DEffectsRenderingMode integer constant. | ||
int | getDmlEffectsRenderingMode() | → inherited from SaveOptions |
void | setDmlEffectsRenderingMode(int value) | |
Gets or sets a value determining how DrawingML effects are rendered. The value of the property is DmlEffectsRenderingMode integer constant. | ||
int | getDmlRenderingMode() | → inherited from SaveOptions |
void | setDmlRenderingMode(int value) | |
Gets or sets a value determining how DrawingML shapes are rendered. The value of the property is DmlRenderingMode integer constant. | ||
java.nio.charset.Charset | getEncoding() | |
void | setEncoding(java.nio.charset.Charset value) | |
Specifies the encoding to use when exporting to HTML. Default value is 'UTF-8' Charset. | ||
boolean | getExportEmbeddedCss() | |
void | setExportEmbeddedCss(boolean value) | |
Specifies whether the CSS (Cascading Style Sheet) should be embedded into Html document. | ||
boolean | getExportEmbeddedFonts() | |
void | setExportEmbeddedFonts(boolean value) | |
Specifies whether fonts should be embedded into Html document in Base64 format. Note setting this flag can significantly increase size of output Html file. | ||
boolean | getExportEmbeddedImages() | |
void | setExportEmbeddedImages(boolean value) | |
Specifies whether images should be embedded into Html document in Base64 format. Note setting this flag can significantly increase size of output Html file. | ||
boolean | getExportEmbeddedSvg() | |
void | setExportEmbeddedSvg(boolean value) | |
Specifies whether SVG resources should be embedded into Html document.
Default value is true .
|
||
boolean | getExportFormFields() | |
void | setExportFormFields(boolean value) | |
Gets or sets indication of whether form fields are exported as interactive items (as 'input' tag) rather than converted to text or graphics. | ||
int | getFontFormat() | |
void | setFontFormat(int value) | |
Gets or sets |
||
int | getJpegQuality() | → inherited from FixedPageSaveOptions |
void | setJpegQuality(int value) | |
Gets or sets a value determining the quality of the JPEG images inside Html document. | ||
boolean | getMemoryOptimization() | → inherited from SaveOptions |
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. | ||
MetafileRenderingOptions | getMetafileRenderingOptions() | → inherited from FixedPageSaveOptions |
void | setMetafileRenderingOptions(MetafileRenderingOptions value) | |
Allows to specify metafile rendering options. | ||
int | getNumeralFormat() | → inherited from FixedPageSaveOptions |
void | setNumeralFormat(int value) | |
Gets or sets |
||
boolean | getOptimizeOutput() | |
void | setOptimizeOutput(boolean value) | |
Flag indicates whether it is required to optimize output. If this flag is set redundant nested canvases and empty canvases are removed, also neighbor glyphs with the same formating are concatenated. Note: The accuracy of the content display may be affected if this property is set to true. Default is true. | ||
int | getPageCount() | → inherited from FixedPageSaveOptions |
void | setPageCount(int value) | |
Gets or sets the number of pages to save.
Default is |
||
int | getPageHorizontalAlignment() | |
void | setPageHorizontalAlignment(int value) | |
Specifies the horizontal alignment of pages in an HTML document.
Default value is HtmlFixedHorizontalPageAlignment.Center .
The value of the property is HtmlFixedPageHorizontalAlignment integer constant. |
||
int | getPageIndex() | → inherited from FixedPageSaveOptions |
void | setPageIndex(int value) | |
Gets or sets the 0-based index of the first page to save. Default is 0. | ||
double | getPageMargins() | |
void | setPageMargins(double value) | |
Specifies the margins around pages in an HTML document. The margins value is measured in points and should be equal to or greater than 0. Default value is 10 points. | ||
IPageSavingCallback | getPageSavingCallback() | → inherited from FixedPageSaveOptions |
void | setPageSavingCallback(IPageSavingCallback value) | |
Allows to control how separate pages are saved when a document is exported to fixed page format. | ||
boolean | getPrettyFormat() | → inherited from SaveOptions |
void | setPrettyFormat(boolean value) | |
When true , pretty formats output where applicable.
Default value is false.
|
||
IResourceSavingCallback | getResourceSavingCallback() | |
void | setResourceSavingCallback(IResourceSavingCallback value) | |
Allows to control how resources (images, fonts and css) are saved when a document is exported to fixed page Html format. | ||
java.lang.String | getResourcesFolder() | |
void | setResourcesFolder(java.lang.String value) | |
Specifies the physical folder where resources (images, fonts, css) are saved when exporting a document to Html format.
Default is null .
|
||
java.lang.String | getResourcesFolderAlias() | |
void | setResourcesFolderAlias(java.lang.String value) | |
Specifies the name of the folder used to construct image URIs written into an Html document.
Default is null .
|
||
boolean | getSaveFontFaceCssSeparately() | |
void | setSaveFontFaceCssSeparately(boolean value) | |
Flag indicates whether "@font-face" CSS rules should be placed into a separate file "fontFaces.css"
when a document is being saved with external stylesheet (that is, when false ).
Default value is false , all CSS rules are written into single file "styles.css".
|
||
int | getSaveFormat() | |
void | setSaveFormat(int value) | |
Specifies the format in which the document will be saved if this save options object is used.
Can only be |
||
boolean | getShowPageBorder() | |
void | setShowPageBorder(boolean value) | |
Specifies whether border around pages should be shown.
Default is true .
|
||
java.lang.String | getTempFolder() | → inherited from SaveOptions |
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.
|
||
boolean | getUpdateFields() | → inherited from SaveOptions |
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. | ||
boolean | getUpdateLastPrintedProperty() | → inherited from SaveOptions |
void | setUpdateLastPrintedProperty(boolean value) | |
Gets or sets a value determining whether the |
||
boolean | getUpdateLastSavedTimeProperty() | → inherited from SaveOptions |
void | setUpdateLastSavedTimeProperty(boolean value) | |
Gets or sets a value determining whether the |
||
boolean | getUpdateSdtContent() | → inherited from SaveOptions |
void | setUpdateSdtContent(boolean value) | |
Gets or sets value determining whether content of |
||
boolean | getUseAntiAliasing() | → inherited from SaveOptions |
void | setUseAntiAliasing(boolean value) | |
Gets or sets a value determining whether or not to use anti-aliasing for rendering. | ||
boolean | getUseHighQualityRendering() | → inherited from SaveOptions |
void | setUseHighQualityRendering(boolean value) | |
Gets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms. | ||
boolean | getUseTargetMachineFonts() | |
void | setUseTargetMachineFonts(boolean value) | |
Flag indicates whether fonts from target machine must be used to display the document.
If this flag is set to true, |
Method Summary | ||
---|---|---|
boolean | equals(java.lang.Object obj) | → inherited from FixedPageSaveOptions |
Determines whether the specified object is equal in value to the current object. |
Constructor Detail |
---|
public HtmlFixedSaveOptions()
Property Getters/Setters Detail |
---|
getColorMode/setColorMode | → inherited from FixedPageSaveOptions |
public int getColorMode() / public void setColorMode(int value) |
Example:
Shows how change image color with save options property// Open document with color image Document doc = new Document(getMyDir() + "Rendering.docx"); // Set grayscale mode for document PdfSaveOptions pdfSaveOptions = new PdfSaveOptions(); pdfSaveOptions.setColorMode(ColorMode.GRAYSCALE); // Assert that color image in document was grey doc.save(getArtifactsDir() + "PdfSaveOptions.ColorRendering.pdf", pdfSaveOptions);
getCssClassNamesPrefix/setCssClassNamesPrefix | |
public java.lang.String getCssClassNamesPrefix() / public void setCssClassNamesPrefix(java.lang.String value) |
"aw"
.
Example:
Shows how to add prefix to all class names in css file.Document doc = new Document(getMyDir() + "Bookmarks.docx"); HtmlFixedSaveOptions htmlFixedSaveOptions = new HtmlFixedSaveOptions(); htmlFixedSaveOptions.setCssClassNamesPrefix("test"); htmlFixedSaveOptions.setSaveFontFaceCssSeparately(true); doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.AddCssClassNamesPrefix.html", htmlFixedSaveOptions);
getDefaultTemplate/setDefaultTemplate | → inherited from SaveOptions |
public java.lang.String getDefaultTemplate() / public void setDefaultTemplate(java.lang.String value) |
Example:
Shows how to set a default .docx document template.Document doc = new Document(); // If we set this flag to true while not having a template attached to the document, // there will be no effect because there is no template document to draw style changes from doc.setAutomaticallyUpdateStyles(true); Assert.assertTrue(doc.getAttachedTemplate().isEmpty()); // We can set a default template document filename in a SaveOptions object to make it apply to // all documents we save with it that have no AttachedTemplate value SaveOptions options = SaveOptions.createSaveOptions("Document.DefaultTemplate.docx"); options.setDefaultTemplate(getMyDir() + "Business brochure.dotx"); doc.save(getArtifactsDir() + "Document.DefaultTemplate.docx", options);
getDml3DEffectsRenderingMode/setDml3DEffectsRenderingMode | → inherited from SaveOptions |
public int getDml3DEffectsRenderingMode() / public void setDml3DEffectsRenderingMode(int value) |
getDmlEffectsRenderingMode/setDmlEffectsRenderingMode | → inherited from SaveOptions |
public int getDmlEffectsRenderingMode() / public void setDmlEffectsRenderingMode(int value) |
This property is used when the document is exported to fixed page formats.
Example:
Shows how to configure DrawingML rendering quality with PdfSaveOptions.Document doc = new Document(getMyDir() + "DrawingML shape effects.docx"); // Creating a new PdfSaveOptions object and setting its DmlEffectsRenderingMode to "None" will // strip the shapes of all their shading effects in the output pdf PdfSaveOptions options = new PdfSaveOptions(); options.setDmlEffectsRenderingMode(DmlEffectsRenderingMode.NONE); options.setDmlRenderingMode(DmlRenderingMode.FALLBACK); doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingML.pdf", options);
getDmlRenderingMode/setDmlRenderingMode | → inherited from SaveOptions |
public int getDmlRenderingMode() / public void setDmlRenderingMode(int value) |
This property is used when the document is exported to fixed page formats.
Example:
Shows how to configure DrawingML rendering quality with PdfSaveOptions.Document doc = new Document(getMyDir() + "DrawingML shape effects.docx"); // Creating a new PdfSaveOptions object and setting its DmlEffectsRenderingMode to "None" will // strip the shapes of all their shading effects in the output pdf PdfSaveOptions options = new PdfSaveOptions(); options.setDmlEffectsRenderingMode(DmlEffectsRenderingMode.NONE); options.setDmlRenderingMode(DmlRenderingMode.FALLBACK); doc.save(getArtifactsDir() + "PdfSaveOptions.DrawingML.pdf", options);
getEncoding/setEncoding | |
public java.nio.charset.Charset getEncoding() / public void setEncoding(java.nio.charset.Charset value) |
Example:
Shows how to set encoding while exporting to HTML.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.writeln("Hello World!"); HtmlFixedSaveOptions htmlFixedSaveOptions = new HtmlFixedSaveOptions(); htmlFixedSaveOptions.setEncoding(Charset.forName("US-ASCII")); doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.UseEncoding.html", htmlFixedSaveOptions);
getExportEmbeddedCss/setExportEmbeddedCss | |
public boolean getExportEmbeddedCss() / public void setExportEmbeddedCss(boolean value) |
Example:
Shows how to export embedded objects into HTML file.Document doc = DocumentHelper.createDocumentFillWithDummyText(); HtmlFixedSaveOptions htmlFixedSaveOptions = new HtmlFixedSaveOptions(); htmlFixedSaveOptions.setExportEmbeddedCss(true); htmlFixedSaveOptions.setExportEmbeddedFonts(true); htmlFixedSaveOptions.setExportEmbeddedImages(true); htmlFixedSaveOptions.setExportEmbeddedSvg(true); doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.ExportEmbeddedObjects.html", htmlFixedSaveOptions);
getExportEmbeddedFonts/setExportEmbeddedFonts | |
public boolean getExportEmbeddedFonts() / public void setExportEmbeddedFonts(boolean value) |
Example:
Shows how to export embedded objects into HTML file.Document doc = DocumentHelper.createDocumentFillWithDummyText(); HtmlFixedSaveOptions htmlFixedSaveOptions = new HtmlFixedSaveOptions(); htmlFixedSaveOptions.setExportEmbeddedCss(true); htmlFixedSaveOptions.setExportEmbeddedFonts(true); htmlFixedSaveOptions.setExportEmbeddedImages(true); htmlFixedSaveOptions.setExportEmbeddedSvg(true); doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.ExportEmbeddedObjects.html", htmlFixedSaveOptions);
getExportEmbeddedImages/setExportEmbeddedImages | |
public boolean getExportEmbeddedImages() / public void setExportEmbeddedImages(boolean value) |
Example:
Shows how to export embedded objects into HTML file.Document doc = DocumentHelper.createDocumentFillWithDummyText(); HtmlFixedSaveOptions htmlFixedSaveOptions = new HtmlFixedSaveOptions(); htmlFixedSaveOptions.setExportEmbeddedCss(true); htmlFixedSaveOptions.setExportEmbeddedFonts(true); htmlFixedSaveOptions.setExportEmbeddedImages(true); htmlFixedSaveOptions.setExportEmbeddedSvg(true); doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.ExportEmbeddedObjects.html", htmlFixedSaveOptions);
getExportEmbeddedSvg/setExportEmbeddedSvg | |
public boolean getExportEmbeddedSvg() / public void setExportEmbeddedSvg(boolean value) |
true
.
Example:
Shows how to export embedded objects into HTML file.Document doc = DocumentHelper.createDocumentFillWithDummyText(); HtmlFixedSaveOptions htmlFixedSaveOptions = new HtmlFixedSaveOptions(); htmlFixedSaveOptions.setExportEmbeddedCss(true); htmlFixedSaveOptions.setExportEmbeddedFonts(true); htmlFixedSaveOptions.setExportEmbeddedImages(true); htmlFixedSaveOptions.setExportEmbeddedSvg(true); doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.ExportEmbeddedObjects.html", htmlFixedSaveOptions);
getExportFormFields/setExportFormFields | |
public boolean getExportFormFields() / public void setExportFormFields(boolean value) |
Example:
Show how to exporting form fields from a document into HTML file.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.insertCheckBox("CheckBox", false, 15); HtmlFixedSaveOptions htmlFixedSaveOptions = new HtmlFixedSaveOptions(); htmlFixedSaveOptions.setExportFormFields(true); doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.ExportFormFields.html", htmlFixedSaveOptions);
getFontFormat/setFontFormat | |
public int getFontFormat() / public void setFontFormat(int value) |
Example:
Shows how used target machine fonts to display the document.public void usingMachineFonts() throws Exception { Document doc = new Document(getMyDir() + "Bullet points with alternative font.docx"); HtmlFixedSaveOptions saveOptions = new HtmlFixedSaveOptions(); saveOptions.setUseTargetMachineFonts(true); saveOptions.setFontFormat(ExportFontFormat.TTF); saveOptions.setExportEmbeddedFonts(false); saveOptions.setResourceSavingCallback(new ResourceSavingCallback()); doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.UsingMachineFonts.html", saveOptions); } private static class ResourceSavingCallback implements IResourceSavingCallback { /** * Called when Aspose.Words saves an external resource to fixed page HTML or SVG. */ public void resourceSaving(final ResourceSavingArgs args) { System.out.println(MessageFormat.format("Original document URI:\t{0}", args.getDocument().getOriginalFileName())); System.out.println(MessageFormat.format("Resource being saved:\t{0}", args.getResourceFileName())); System.out.println(MessageFormat.format("Full uri after saving:\t{0}", args.getResourceFileUri())); args.setResourceStream(new ByteArrayOutputStream()); args.setKeepResourceStreamOpen(true); String extension = FilenameUtils.getExtension(args.getResourceFileName()); switch (extension) { case "ttf": case "woff": Assert.fail("'ResourceSavingCallback' is not fired for fonts when 'UseTargetMachineFonts' is true"); break; } } }
getJpegQuality/setJpegQuality | → inherited from FixedPageSaveOptions |
public int getJpegQuality() / public void setJpegQuality(int value) |
Has effect only when a document contains JPEG images.
Use this property to get or set the quality of the images inside a document when saving in fixed page format. The value may vary from 0 to 100 where 0 means worst quality but maximum compression and 100 means best quality but minimum compression.
The default value is 95.
Example:
Converts a page of a Word document into JPEG images of different qualities.Document doc = new Document(getMyDir() + "Rendering.docx"); ImageSaveOptions saveOptions = new ImageSaveOptions(SaveFormat.JPEG); // Try worst quality saveOptions.setJpegQuality(0); doc.save(getArtifactsDir() + "Rendering.SaveToImageJpegQuality.0.jpeg", saveOptions); // Try best quality saveOptions.setJpegQuality(100); doc.save(getArtifactsDir() + "Rendering.SaveToImageJpegQuality.100.jpeg", saveOptions);
getMemoryOptimization/setMemoryOptimization | → inherited from SaveOptions |
public boolean getMemoryOptimization() / public void setMemoryOptimization(boolean value) |
Example:
Shows an option to optimize memory consumption when you work with large documents.Document doc = new Document(getMyDir() + "Rendering.docx"); // When set to true it will improve document memory footprint but will add extra time to processing SaveOptions saveOptions = SaveOptions.createSaveOptions(SaveFormat.PDF); saveOptions.setMemoryOptimization(true); doc.save(getArtifactsDir() + "PdfSaveOptions.MemoryOptimization.pdf", saveOptions);
getMetafileRenderingOptions/setMetafileRenderingOptions | → inherited from FixedPageSaveOptions |
public MetafileRenderingOptions getMetafileRenderingOptions() / public void setMetafileRenderingOptions(MetafileRenderingOptions value) |
Example:
Shows added fallback to bitmap rendering and changing type of warnings about unsupported metafile records.Document doc = new Document(getMyDir() + "WMF with image.docx"); MetafileRenderingOptions metafileRenderingOptions = new MetafileRenderingOptions(); metafileRenderingOptions.setEmulateRasterOperations(false); metafileRenderingOptions.setRenderingMode(MetafileRenderingMode.VECTOR_WITH_FALLBACK); // If Aspose.Words cannot correctly render some of the metafile records to vector graphics then Aspose.Words renders this metafile to a bitmap HandleDocumentWarnings callback = new HandleDocumentWarnings(); doc.setWarningCallback(callback); PdfSaveOptions saveOptions = new PdfSaveOptions(); saveOptions.setMetafileRenderingOptions(metafileRenderingOptions); doc.save(getArtifactsDir() + "PdfSaveOptions.HandleBinaryRasterWarnings.pdf", saveOptions); Assert.assertEquals(callback.mWarnings.getCount(), 1); Assert.assertTrue(callback.mWarnings.get(0).getDescription().contains("R2_XORPEN")); } public static class HandleDocumentWarnings implements IWarningCallback { /** * Our callback only needs to implement the "Warning" method. This method is called whenever there is a * potential issue during document processing. The callback can be set to listen for warnings generated during document * load and/or document save. */ public void warning(final WarningInfo info) { //For now type of warnings about unsupported metafile records changed from DataLoss/UnexpectedContent to MinorFormattingLoss if (info.getWarningType() == WarningType.MINOR_FORMATTING_LOSS) { System.out.println("Unsupported operation: " + info.getDescription()); this.mWarnings.warning(info); } } public WarningInfoCollection mWarnings = new WarningInfoCollection(); }
getNumeralFormat/setNumeralFormat | → inherited from FixedPageSaveOptions |
public int getNumeralFormat() / public void setNumeralFormat(int value) |
Example:
Demonstrates how to set the numeral format used when saving to PDF.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); builder.writeln("1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 50, 100"); PdfSaveOptions options = new PdfSaveOptions(); options.setNumeralFormat(NumeralFormat.EASTERN_ARABIC_INDIC); doc.save(getArtifactsDir() + "Rendering.SetNumeralFormat.pdf", options);
getOptimizeOutput/setOptimizeOutput | |
public boolean getOptimizeOutput() / public void setOptimizeOutput(boolean value) |
Example:
Shows how to optimize document objects while saving to html.Document doc = new Document(getMyDir() + "Unoptimized content.docx"); HtmlFixedSaveOptions saveOptions = new HtmlFixedSaveOptions(); saveOptions.setOptimizeOutput(true); doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.OptimizeGraphicsOutput.html", saveOptions);
getPageCount/setPageCount | → inherited from FixedPageSaveOptions |
public int getPageCount() / public void setPageCount(int value) |
Example:
Converts just one page (third page in this example) of the document to PDF.Document doc = new Document(getMyDir() + "Rendering.docx"); OutputStream stream = new FileOutputStream(getArtifactsDir() + "Rendering.SaveToPdfStreamOnePage.pdf"); try { PdfSaveOptions options = new PdfSaveOptions(); options.setPageIndex(2); options.setPageCount(1); doc.save(stream, options); } finally { if (stream != null) { stream.close(); } }
getPageHorizontalAlignment/setPageHorizontalAlignment | |
public int getPageHorizontalAlignment() / public void setPageHorizontalAlignment(int value) |
HtmlFixedHorizontalPageAlignment.Center
.
The value of the property is HtmlFixedPageHorizontalAlignment integer constant.Example:
Shows how to set the horizontal alignment of pages in HTML file.Document doc = new Document(getMyDir() + "Bookmarks.docx"); HtmlFixedSaveOptions htmlFixedSaveOptions = new HtmlFixedSaveOptions(); htmlFixedSaveOptions.setPageHorizontalAlignment(HtmlFixedPageHorizontalAlignment.LEFT); doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.HorizontalAlignment.html", htmlFixedSaveOptions);
getPageIndex/setPageIndex | → inherited from FixedPageSaveOptions |
public int getPageIndex() / public void setPageIndex(int value) |
Example:
Converts just one page (third page in this example) of the document to PDF.Document doc = new Document(getMyDir() + "Rendering.docx"); OutputStream stream = new FileOutputStream(getArtifactsDir() + "Rendering.SaveToPdfStreamOnePage.pdf"); try { PdfSaveOptions options = new PdfSaveOptions(); options.setPageIndex(2); options.setPageCount(1); doc.save(stream, options); } finally { if (stream != null) { stream.close(); } }
getPageMargins/setPageMargins | |
public double getPageMargins() / public void setPageMargins(double value) |
Depends on the value of
Example:
Shows how to set the margins around pages in HTML file.Document doc = new Document(getMyDir() + "Bookmarks.docx"); HtmlFixedSaveOptions saveOptions = new HtmlFixedSaveOptions(); saveOptions.setPageMargins(10.0); doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.PageMargins.html", saveOptions);
getPageSavingCallback/setPageSavingCallback | → inherited from FixedPageSaveOptions |
public IPageSavingCallback getPageSavingCallback() / public void setPageSavingCallback(IPageSavingCallback value) |
getPrettyFormat/setPrettyFormat | → inherited from SaveOptions |
public boolean getPrettyFormat() / public void setPrettyFormat(boolean value) |
true
, pretty formats output where applicable.
Default value is false.
Set to true to make HTML, MHTML, EPUB, WordML, RTF, DOCX and ODT output human readable. Useful for testing or debugging.
Example:
Shows how to pass an option to export HTML tags in a well spaced, human readable format.Document doc = new Document(getMyDir() + "Document.docx"); // Enabling the PrettyFormat setting will export HTML in an indented format that is easy to read // If this is setting is false (by default) then the HTML tags will be exported in condensed form with no indentation HtmlSaveOptions htmlOptions = new HtmlSaveOptions(SaveFormat.HTML); htmlOptions.setPrettyFormat(isPrettyFormat); doc.save(getArtifactsDir() + "Document.SaveHtmlPrettyFormat.html", htmlOptions);
getResourceSavingCallback/setResourceSavingCallback | |
public IResourceSavingCallback getResourceSavingCallback() / public void setResourceSavingCallback(IResourceSavingCallback value) |
Example:
Shows how to print the URIs of linked resources created during conversion of a document to fixed-form .html.public void htmlFixedResourceFolder() throws Exception { // Open a document which contains images Document doc = new Document(getMyDir() + "Rendering.docx"); HtmlFixedSaveOptions options = new HtmlFixedSaveOptions(); { options.setSaveFormat(SaveFormat.HTML_FIXED); options.setExportEmbeddedImages(false); options.setResourcesFolder(getArtifactsDir() + "HtmlFixedResourceFolder"); options.setResourcesFolderAlias(getArtifactsDir() + "HtmlFixedResourceFolderAlias"); options.setShowPageBorder(false); options.setResourceSavingCallback(new ResourceUriPrinter()); } // A folder specified by ResourcesFolderAlias will contain the resources instead of ResourcesFolder // We must ensure the folder exists before the streams can put their resources into it new File(options.getResourcesFolderAlias()).mkdir(); doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.HtmlFixedResourceFolder.html", options); } /// <summary> /// Counts and prints URIs of resources contained by as they are converted to fixed .Html. /// </summary> private static class ResourceUriPrinter implements IResourceSavingCallback { public void resourceSaving(ResourceSavingArgs args) throws Exception { // If we set a folder alias in the SaveOptions object, it will be printed here System.out.println(MessageFormat.format("Resource #{0} \"{1}\"", ++mSavedResourceCount, args.getResourceFileName())); String extension = FilenameUtils.getExtension(args.getResourceFileName()); switch (extension) { case "ttf": case "woff": { // By default 'ResourceFileUri' used system folder for fonts // To avoid problems across platforms you must explicitly specify the path for the fonts args.setResourceFileUri(getArtifactsDir() + File.separatorChar + args.getResourceFileName()); break; } } System.out.println("\t" + args.getResourceFileUri()); // If we specified a ResourcesFolderAlias we will also need to redirect each stream to put its resource in that folder args.setResourceStream(new FileOutputStream(args.getResourceFileUri())); args.setKeepResourceStreamOpen(false); } private int mSavedResourceCount; }
getResourcesFolder/setResourcesFolder | |
public java.lang.String getResourcesFolder() / public void setResourcesFolder(java.lang.String value) |
null
.
Has effect only if
When you save a
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
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
by using the
Example:
Shows how to print the URIs of linked resources created during conversion of a document to fixed-form .html.public void htmlFixedResourceFolder() throws Exception { // Open a document which contains images Document doc = new Document(getMyDir() + "Rendering.docx"); HtmlFixedSaveOptions options = new HtmlFixedSaveOptions(); { options.setSaveFormat(SaveFormat.HTML_FIXED); options.setExportEmbeddedImages(false); options.setResourcesFolder(getArtifactsDir() + "HtmlFixedResourceFolder"); options.setResourcesFolderAlias(getArtifactsDir() + "HtmlFixedResourceFolderAlias"); options.setShowPageBorder(false); options.setResourceSavingCallback(new ResourceUriPrinter()); } // A folder specified by ResourcesFolderAlias will contain the resources instead of ResourcesFolder // We must ensure the folder exists before the streams can put their resources into it new File(options.getResourcesFolderAlias()).mkdir(); doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.HtmlFixedResourceFolder.html", options); } /// <summary> /// Counts and prints URIs of resources contained by as they are converted to fixed .Html. /// </summary> private static class ResourceUriPrinter implements IResourceSavingCallback { public void resourceSaving(ResourceSavingArgs args) throws Exception { // If we set a folder alias in the SaveOptions object, it will be printed here System.out.println(MessageFormat.format("Resource #{0} \"{1}\"", ++mSavedResourceCount, args.getResourceFileName())); String extension = FilenameUtils.getExtension(args.getResourceFileName()); switch (extension) { case "ttf": case "woff": { // By default 'ResourceFileUri' used system folder for fonts // To avoid problems across platforms you must explicitly specify the path for the fonts args.setResourceFileUri(getArtifactsDir() + File.separatorChar + args.getResourceFileName()); break; } } System.out.println("\t" + args.getResourceFileUri()); // If we specified a ResourcesFolderAlias we will also need to redirect each stream to put its resource in that folder args.setResourceStream(new FileOutputStream(args.getResourceFileUri())); args.setKeepResourceStreamOpen(false); } private int mSavedResourceCount; }
getResourcesFolderAlias/setResourcesFolderAlias | |
public java.lang.String getResourcesFolderAlias() / public void setResourcesFolderAlias(java.lang.String value) |
null
.
When you save a
Example:
Shows how to print the URIs of linked resources created during conversion of a document to fixed-form .html.public void htmlFixedResourceFolder() throws Exception { // Open a document which contains images Document doc = new Document(getMyDir() + "Rendering.docx"); HtmlFixedSaveOptions options = new HtmlFixedSaveOptions(); { options.setSaveFormat(SaveFormat.HTML_FIXED); options.setExportEmbeddedImages(false); options.setResourcesFolder(getArtifactsDir() + "HtmlFixedResourceFolder"); options.setResourcesFolderAlias(getArtifactsDir() + "HtmlFixedResourceFolderAlias"); options.setShowPageBorder(false); options.setResourceSavingCallback(new ResourceUriPrinter()); } // A folder specified by ResourcesFolderAlias will contain the resources instead of ResourcesFolder // We must ensure the folder exists before the streams can put their resources into it new File(options.getResourcesFolderAlias()).mkdir(); doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.HtmlFixedResourceFolder.html", options); } /// <summary> /// Counts and prints URIs of resources contained by as they are converted to fixed .Html. /// </summary> private static class ResourceUriPrinter implements IResourceSavingCallback { public void resourceSaving(ResourceSavingArgs args) throws Exception { // If we set a folder alias in the SaveOptions object, it will be printed here System.out.println(MessageFormat.format("Resource #{0} \"{1}\"", ++mSavedResourceCount, args.getResourceFileName())); String extension = FilenameUtils.getExtension(args.getResourceFileName()); switch (extension) { case "ttf": case "woff": { // By default 'ResourceFileUri' used system folder for fonts // To avoid problems across platforms you must explicitly specify the path for the fonts args.setResourceFileUri(getArtifactsDir() + File.separatorChar + args.getResourceFileName()); break; } } System.out.println("\t" + args.getResourceFileUri()); // If we specified a ResourcesFolderAlias we will also need to redirect each stream to put its resource in that folder args.setResourceStream(new FileOutputStream(args.getResourceFileUri())); args.setKeepResourceStreamOpen(false); } private int mSavedResourceCount; }
getSaveFontFaceCssSeparately/setSaveFontFaceCssSeparately | |
public boolean getSaveFontFaceCssSeparately() / public void setSaveFontFaceCssSeparately(boolean value) |
false
).
Default value is false
, all CSS rules are written into single file "styles.css".
true
restores the old behavior (separate files) for compatibility with legacy code.
Example:
Shows how to add prefix to all class names in css file.Document doc = new Document(getMyDir() + "Bookmarks.docx"); HtmlFixedSaveOptions htmlFixedSaveOptions = new HtmlFixedSaveOptions(); htmlFixedSaveOptions.setCssClassNamesPrefix("test"); htmlFixedSaveOptions.setSaveFontFaceCssSeparately(true); doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.AddCssClassNamesPrefix.html", htmlFixedSaveOptions);
getSaveFormat/setSaveFormat | |
public int getSaveFormat() / public void setSaveFormat(int value) |
Example:
Shows how to print the URIs of linked resources created during conversion of a document to fixed-form .html.public void htmlFixedResourceFolder() throws Exception { // Open a document which contains images Document doc = new Document(getMyDir() + "Rendering.docx"); HtmlFixedSaveOptions options = new HtmlFixedSaveOptions(); { options.setSaveFormat(SaveFormat.HTML_FIXED); options.setExportEmbeddedImages(false); options.setResourcesFolder(getArtifactsDir() + "HtmlFixedResourceFolder"); options.setResourcesFolderAlias(getArtifactsDir() + "HtmlFixedResourceFolderAlias"); options.setShowPageBorder(false); options.setResourceSavingCallback(new ResourceUriPrinter()); } // A folder specified by ResourcesFolderAlias will contain the resources instead of ResourcesFolder // We must ensure the folder exists before the streams can put their resources into it new File(options.getResourcesFolderAlias()).mkdir(); doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.HtmlFixedResourceFolder.html", options); } /// <summary> /// Counts and prints URIs of resources contained by as they are converted to fixed .Html. /// </summary> private static class ResourceUriPrinter implements IResourceSavingCallback { public void resourceSaving(ResourceSavingArgs args) throws Exception { // If we set a folder alias in the SaveOptions object, it will be printed here System.out.println(MessageFormat.format("Resource #{0} \"{1}\"", ++mSavedResourceCount, args.getResourceFileName())); String extension = FilenameUtils.getExtension(args.getResourceFileName()); switch (extension) { case "ttf": case "woff": { // By default 'ResourceFileUri' used system folder for fonts // To avoid problems across platforms you must explicitly specify the path for the fonts args.setResourceFileUri(getArtifactsDir() + File.separatorChar + args.getResourceFileName()); break; } } System.out.println("\t" + args.getResourceFileUri()); // If we specified a ResourcesFolderAlias we will also need to redirect each stream to put its resource in that folder args.setResourceStream(new FileOutputStream(args.getResourceFileUri())); args.setKeepResourceStreamOpen(false); } private int mSavedResourceCount; }
getShowPageBorder/setShowPageBorder | |
public boolean getShowPageBorder() / public void setShowPageBorder(boolean value) |
true
.
Example:
Shows how to print the URIs of linked resources created during conversion of a document to fixed-form .html.public void htmlFixedResourceFolder() throws Exception { // Open a document which contains images Document doc = new Document(getMyDir() + "Rendering.docx"); HtmlFixedSaveOptions options = new HtmlFixedSaveOptions(); { options.setSaveFormat(SaveFormat.HTML_FIXED); options.setExportEmbeddedImages(false); options.setResourcesFolder(getArtifactsDir() + "HtmlFixedResourceFolder"); options.setResourcesFolderAlias(getArtifactsDir() + "HtmlFixedResourceFolderAlias"); options.setShowPageBorder(false); options.setResourceSavingCallback(new ResourceUriPrinter()); } // A folder specified by ResourcesFolderAlias will contain the resources instead of ResourcesFolder // We must ensure the folder exists before the streams can put their resources into it new File(options.getResourcesFolderAlias()).mkdir(); doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.HtmlFixedResourceFolder.html", options); } /// <summary> /// Counts and prints URIs of resources contained by as they are converted to fixed .Html. /// </summary> private static class ResourceUriPrinter implements IResourceSavingCallback { public void resourceSaving(ResourceSavingArgs args) throws Exception { // If we set a folder alias in the SaveOptions object, it will be printed here System.out.println(MessageFormat.format("Resource #{0} \"{1}\"", ++mSavedResourceCount, args.getResourceFileName())); String extension = FilenameUtils.getExtension(args.getResourceFileName()); switch (extension) { case "ttf": case "woff": { // By default 'ResourceFileUri' used system folder for fonts // To avoid problems across platforms you must explicitly specify the path for the fonts args.setResourceFileUri(getArtifactsDir() + File.separatorChar + args.getResourceFileName()); break; } } System.out.println("\t" + args.getResourceFileUri()); // If we specified a ResourcesFolderAlias we will also need to redirect each stream to put its resource in that folder args.setResourceStream(new FileOutputStream(args.getResourceFileUri())); args.setKeepResourceStreamOpen(false); } private int mSavedResourceCount; }
getTempFolder/setTempFolder | → inherited from SaveOptions |
public java.lang.String getTempFolder() / public void setTempFolder(java.lang.String value) |
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
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 save a document using temporary files.Document doc = new Document(getMyDir() + "Rendering.docx"); // We can use a SaveOptions object to set the saving method of a document from a MemoryStream to temporary files // While saving, the files will briefly pop up in the folder we set as the TempFolder attribute below // Doing this will free up space in the memory that the stream would usually occupy DocSaveOptions options = new DocSaveOptions(); options.setTempFolder(getArtifactsDir() + "TempFiles"); // Ensure that the directory exists and save new File(options.getTempFolder()).mkdir(); doc.save(getArtifactsDir() + "DocSaveOptions.TempFolder.doc", options);
getUpdateFields/setUpdateFields | → inherited from SaveOptions |
public boolean getUpdateFields() / public void setUpdateFields(boolean value) |
Example:
Shows how to update fields before saving into a PDF document.Document doc = DocumentHelper.createDocumentFillWithDummyText(); PdfSaveOptions pdfSaveOptions = new PdfSaveOptions(); pdfSaveOptions.setUpdateFields(false); // PdfSaveOptions objects can be cloned Assert.assertNotSame(pdfSaveOptions, pdfSaveOptions.deepClone()); doc.save(getArtifactsDir() + "PdfSaveOptions.WithoutUpdateFields.pdf", pdfSaveOptions);
getUpdateLastPrintedProperty/setUpdateLastPrintedProperty | → inherited from SaveOptions |
public boolean getUpdateLastPrintedProperty() / public void setUpdateLastPrintedProperty(boolean value) |
Example:
Shows how to update BuiltInDocumentProperties.LastPrinted property before saving.Document doc = new Document(); // Aspose.Words update BuiltInDocumentProperties.LastPrinted property by default DocSaveOptions saveOptions = new DocSaveOptions(); saveOptions.setUpdateLastPrintedProperty(isUpdateLastPrintedProperty); doc.save(getArtifactsDir() + "DocSaveOptions.UpdateLastPrintedProperty.docx", saveOptions);
getUpdateLastSavedTimeProperty/setUpdateLastSavedTimeProperty | → inherited from SaveOptions |
public boolean getUpdateLastSavedTimeProperty() / public void setUpdateLastSavedTimeProperty(boolean value) |
Example:
Shows how to update a document time property when you want to save it.Document doc = new Document(getMyDir() + "Document.docx"); // Get last saved time Date documentTimeBeforeSave = doc.getBuiltInDocumentProperties().getLastSavedTime(); OoxmlSaveOptions saveOptions = new OoxmlSaveOptions(); saveOptions.setUpdateLastSavedTimeProperty(true); doc.save(getArtifactsDir() + "OoxmlSaveOptions.UpdatingLastSavedTimeDocument.docx", saveOptions);
getUpdateSdtContent/setUpdateSdtContent | → inherited from SaveOptions |
public boolean getUpdateSdtContent() / public void setUpdateSdtContent(boolean value) |
true
.
Example:
Shows how structured document tags can be updated while saving to .pdf.Document doc = new Document(); // Insert two StructuredDocumentTags; a date and a drop down list StructuredDocumentTag tag = new StructuredDocumentTag(doc, SdtType.DATE, MarkupLevel.BLOCK); tag.setFullDate(new Date()); doc.getFirstSection().getBody().appendChild(tag); tag = new StructuredDocumentTag(doc, SdtType.DROP_DOWN_LIST, MarkupLevel.BLOCK); tag.getListItems().add(new SdtListItem("Value 1")); tag.getListItems().add(new SdtListItem("Value 2")); tag.getListItems().add(new SdtListItem("Value 3")); tag.getListItems().setSelectedValue(tag.getListItems().get(1)); doc.getFirstSection().getBody().appendChild(tag); // We've selected default values for both tags // We can save those values in the document without immediately updating the tags, leaving them in their default state // by using a SaveOptions object with this flag set PdfSaveOptions options = new PdfSaveOptions(); options.setUpdateSdtContent(false); doc.save(getArtifactsDir() + "StructuredDocumentTag.UpdateSdtContent.pdf", options);
getUseAntiAliasing/setUseAntiAliasing | → inherited from SaveOptions |
public boolean getUseAntiAliasing() / public void setUseAntiAliasing(boolean value) |
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:
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 | → inherited from SaveOptions |
public boolean getUseHighQualityRendering() / public void setUseHighQualityRendering(boolean value) |
false
.
This property is used when the document is exported to image formats:
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);
getUseTargetMachineFonts/setUseTargetMachineFonts | |
public boolean getUseTargetMachineFonts() / public void setUseTargetMachineFonts(boolean value) |
Example:
Shows how used target machine fonts to display the document.public void usingMachineFonts() throws Exception { Document doc = new Document(getMyDir() + "Bullet points with alternative font.docx"); HtmlFixedSaveOptions saveOptions = new HtmlFixedSaveOptions(); saveOptions.setUseTargetMachineFonts(true); saveOptions.setFontFormat(ExportFontFormat.TTF); saveOptions.setExportEmbeddedFonts(false); saveOptions.setResourceSavingCallback(new ResourceSavingCallback()); doc.save(getArtifactsDir() + "HtmlFixedSaveOptions.UsingMachineFonts.html", saveOptions); } private static class ResourceSavingCallback implements IResourceSavingCallback { /** * Called when Aspose.Words saves an external resource to fixed page HTML or SVG. */ public void resourceSaving(final ResourceSavingArgs args) { System.out.println(MessageFormat.format("Original document URI:\t{0}", args.getDocument().getOriginalFileName())); System.out.println(MessageFormat.format("Resource being saved:\t{0}", args.getResourceFileName())); System.out.println(MessageFormat.format("Full uri after saving:\t{0}", args.getResourceFileUri())); args.setResourceStream(new ByteArrayOutputStream()); args.setKeepResourceStreamOpen(true); String extension = FilenameUtils.getExtension(args.getResourceFileName()); switch (extension) { case "ttf": case "woff": Assert.fail("'ResourceSavingCallback' is not fired for fonts when 'UseTargetMachineFonts' is true"); break; } } }
Method Detail |
---|
equals | → inherited from FixedPageSaveOptions |
public boolean equals(java.lang.Object obj) |