java.lang.ObjectSaveOptions
FixedPageSaveOptions
com.aspose.words.HtmlFixedSaveOptions
public class HtmlFixedSaveOptions
Constructor Summary |
---|
HtmlFixedSaveOptions()
Initializes a new instance of this class that can be used to save a document in the |
Property Getters/Setters Summary | ||
---|---|---|
int | getColorMode() | → inherited from SaveOptions |
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 |
||
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. | ||
int | getMetafileRenderingMode() | |
void | setMetafileRenderingMode(int value) | |
Gets or sets a value determining how metafile images should be rendered. The value of the property is MetafileRenderingMode integer constant. | ||
MetafileRenderingOptions | getMetafileRenderingOptions() | → inherited from FixedPageSaveOptions |
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 of XPS. 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 .
|
||
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 | 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. | ||
IWarningCallback | getWarningCallback() | → inherited from SaveOptions |
void | setWarningCallback(IWarningCallback value) | |
Called during a save operation, when an issue is detected that might result in data or formatting fidelity loss. |
Constructor Detail |
---|
public HtmlFixedSaveOptions()
Property Getters/Setters Detail |
---|
getColorMode/setColorMode | → inherited from SaveOptions |
public int getColorMode() / public void setColorMode(int value) |
This property is used when the document is exported to fixed page formats.
getCssClassNamesPrefix/setCssClassNamesPrefix | |
public java.lang.String getCssClassNamesPrefix() / public void setCssClassNamesPrefix(java.lang.String value) |
"aw"
.
getDefaultTemplate/setDefaultTemplate | → inherited from SaveOptions |
public java.lang.String getDefaultTemplate() / public void setDefaultTemplate(java.lang.String 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.
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.
getEncoding/setEncoding | |
public java.nio.charset.Charset getEncoding() / public void setEncoding(java.nio.charset.Charset value) |
getExportEmbeddedCss/setExportEmbeddedCss | |
public boolean getExportEmbeddedCss() / public void setExportEmbeddedCss(boolean value) |
getExportEmbeddedFonts/setExportEmbeddedFonts | |
public boolean getExportEmbeddedFonts() / public void setExportEmbeddedFonts(boolean value) |
getExportEmbeddedImages/setExportEmbeddedImages | |
public boolean getExportEmbeddedImages() / public void setExportEmbeddedImages(boolean value) |
getExportEmbeddedSvg/setExportEmbeddedSvg | |
public boolean getExportEmbeddedSvg() / public void setExportEmbeddedSvg(boolean value) |
true
.
getExportFormFields/setExportFormFields | |
public boolean getExportFormFields() / public void setExportFormFields(boolean value) |
getFontFormat/setFontFormat | |
public int getFontFormat() / public void setFontFormat(int value) |
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.
getMemoryOptimization/setMemoryOptimization | → inherited from SaveOptions |
public boolean getMemoryOptimization() / public void setMemoryOptimization(boolean value) |
getMetafileRenderingMode/setMetafileRenderingMode | |
public int getMetafileRenderingMode() / public void setMetafileRenderingMode(int value) |
Has effect only when a document contains metafile images.
Use this property to get or set the mode of how metafile images inside a document should be rendered when saving in Html format.
The default value is
getMetafileRenderingOptions | → inherited from FixedPageSaveOptions |
public MetafileRenderingOptions getMetafileRenderingOptions() |
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.PdfSaveOptions options = new PdfSaveOptions(); options.setNumeralFormat(NumeralFormat.CONTEXT);
getOptimizeOutput/setOptimizeOutput | |
public boolean getOptimizeOutput() / public void setOptimizeOutput(boolean value) |
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.doc"); OutputStream stream = new FileOutputStream(getMyDir() + "Rendering.SaveToPdfStreamOnePage Out.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.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.doc"); OutputStream stream = new FileOutputStream(getMyDir() + "Rendering.SaveToPdfStreamOnePage Out.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
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.doc"); HtmlSaveOptions htmlOptions = new HtmlSaveOptions(SaveFormat.HTML); // 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. htmlOptions.setPrettyFormat(true); doc.save(getMyDir() + "Document.PrettyFormat Out.html", htmlOptions);
getResourceSavingCallback/setResourceSavingCallback | |
public IResourceSavingCallback getResourceSavingCallback() / public void setResourceSavingCallback(IResourceSavingCallback value) |
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
getResourcesFolderAlias/setResourcesFolderAlias | |
public java.lang.String getResourcesFolderAlias() / public void setResourcesFolderAlias(java.lang.String value) |
null
.
When you save a
getSaveFormat/setSaveFormat | |
public int getSaveFormat() / public void setSaveFormat(int value) |
getShowPageBorder/setShowPageBorder | |
public boolean getShowPageBorder() / public void setShowPageBorder(boolean value) |
true
.
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.
getUpdateFields/setUpdateFields | → inherited from SaveOptions |
public boolean getUpdateFields() / public void setUpdateFields(boolean value) |
getUpdateSdtContent/setUpdateSdtContent | → inherited from SaveOptions |
public boolean getUpdateSdtContent() / public void setUpdateSdtContent(boolean value) |
true
.
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:
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:
getWarningCallback/setWarningCallback | → inherited from SaveOptions |
public IWarningCallback getWarningCallback() / public void setWarningCallback(IWarningCallback value) |
This property is obsolete. Please use
Example:
Demonstrates how to implement the IWarningCallback to be notified of any font substitution during document save.public 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 procssing. The callback can be set to listen for warnings generated during document * load and/or document save. */ public void warning(WarningInfo info) { // We are only interested in fonts being substituted. if (info.getWarningType() == WarningType.FONT_SUBSTITUTION) { System.out.println("Font substitution: " + info.getDescription()); } } }
Example:
Demonstrates how to recieve notifications of font substitutions by using IWarningCallback.// Load the document to render. Document doc = new Document(getMyDir() + "Document.doc"); FontSettings fontSettings = new FontSettings(); // We can choose the default font to use in the case of any missing fonts. fontSettings.setDefaultFontName("Arial"); // For testing we will set Aspose.Words to look for fonts only in a folder which doesn't exist. Since Aspose.Words won't // find any fonts in the specified directory, then during rendering the fonts in the document will be subsuited with the default // font specified under FontSettings.DefaultFontName. We can pick up on this subsuition using our callback. fontSettings.setFontsFolder("", false); // Create a new class implementing IWarningCallback which collect any warnings produced during document save. HandleDocumentWarnings callback = new HandleDocumentWarnings(); // We assign the callback to the appropriate save options class. In this case, we are going to save to PDF // so we create a PdfSaveOptions class and assign the callback there. PdfSaveOptions saveOptions = new PdfSaveOptions(); saveOptions.setWarningCallback(callback); // Pass the save options along with the save path to the save method. doc.save(getMyDir() + "Rendering.MissingFontNotification Out.pdf", saveOptions);