com.aspose.slides

Class HtmlOptions

java.lang.Object

com.aspose.slides.SaveOptions

com.aspose.slides.HtmlOptions

All Implemented Interfaces:

IHtmlOptions, ISaveOptions

public class HtmlOptions
extends SaveOptions
implements IHtmlOptions

Represents a HTML exporting options.

Constructor Summary

Constructors

Constructor and Description
HtmlOptions() Creates a new HtmlOptions object for saving into single HTML file.
HtmlOptions(ILinkEmbedController linkEmbedController) Creates a new HtmlOptions object specifiing callback.

Method Summary

Modifier and Type	Method and Description
boolean	getDeletePicturesCroppedAreas() A boolean flag indicates if the cropped parts remain as part of the document.
boolean	getDisableFontLigatures() Gets or sets a value indicating whether text is rendered without using ligatures.
IHtmlFormatter	getHtmlFormatter() Returns or sets HTML template.
IInkOptions	getInkOptions() Provides options that control the look of Ink objects in exported document.
byte	getJpegQuality() Returns or sets a value determining the quality of the JPEG images inside PDF document.
int	getPicturesCompression() Represents the pictures compression level
boolean	getShowHiddenSlides() Specifies whether the generated document should include hidden slides or not.
ISlideImageFormat	getSlideImageFormat() Returns or sets slide image format options.
ISlidesLayoutOptions	getSlidesLayoutOptions() Gets or sets the mode in which slides are placed on the page when exporting a presentation ISlidesLayoutOptions.
boolean	getSvgResponsiveLayout() True to exclude width and height attributes from svg container - that will make layout responsive.
void	setDeletePicturesCroppedAreas(boolean value) A boolean flag indicates if the cropped parts remain as part of the document.
void	setDisableFontLigatures(boolean value) Gets or sets a value indicating whether text is rendered without using ligatures.
void	setHtmlFormatter(IHtmlFormatter value) Returns or sets HTML template.
void	setJpegQuality(byte value) Returns or sets a value determining the quality of the JPEG images inside PDF document.
void	setPicturesCompression(int value) Represents the pictures compression level
void	setShowHiddenSlides(boolean value) Specifies whether the generated document should include hidden slides or not.
void	setSlideImageFormat(ISlideImageFormat value) Returns or sets slide image format options.
void	setSlidesLayoutOptions(ISlidesLayoutOptions value) Gets or sets the mode in which slides are placed on the page when exporting a presentation ISlidesLayoutOptions.
void	setSvgResponsiveLayout(boolean value) True to exclude width and height attributes from svg container - that will make layout responsive.

Methods inherited from class com.aspose.slides.SaveOptions

getDefaultRegularFont, getGradientStyle, getProgressCallback, getSkipJavaScriptLinks, getWarningCallback, setDefaultRegularFont, setGradientStyle, setProgressCallback, setSkipJavaScriptLinks, setWarningCallback

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.aspose.slides.ISaveOptions

getDefaultRegularFont, getGradientStyle, getProgressCallback, getSkipJavaScriptLinks, getWarningCallback, setDefaultRegularFont, setGradientStyle, setProgressCallback, setSkipJavaScriptLinks, setWarningCallback

Constructor Detail

HtmlOptions

public HtmlOptions(ILinkEmbedController linkEmbedController)

Creates a new HtmlOptions object specifiing callback.

Parameters:

linkEmbedController - Callback object which controls saving project.

HtmlOptions

public HtmlOptions()

Creates a new HtmlOptions object for saving into single HTML file.

Method Detail

getSlidesLayoutOptions

public final ISlidesLayoutOptions getSlidesLayoutOptions()

Gets or sets the mode in which slides are placed on the page when exporting a presentation ISlidesLayoutOptions.

Example:
 
 Presentation pres = new Presentation("pres.pptx");
 try {
     HtmlOptions options = new HtmlOptions();
     HandoutLayoutingOptions slidesLayoutOptions = new HandoutLayoutingOptions();
     slidesLayoutOptions.setHandout(HandoutType.Handouts4Horizontal);
     options.setSlidesLayoutOptions(slidesLayoutOptions);

     pres.save("pres.html", SaveFormat.Html, options);
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Specified by:

getSlidesLayoutOptions in interface IHtmlOptions

setSlidesLayoutOptions

public final void setSlidesLayoutOptions(ISlidesLayoutOptions value)

Gets or sets the mode in which slides are placed on the page when exporting a presentation ISlidesLayoutOptions.

Example:
 
 Presentation pres = new Presentation("pres.pptx");
 try {
     HtmlOptions options = new HtmlOptions();
     HandoutLayoutingOptions slidesLayoutOptions = new HandoutLayoutingOptions();
     slidesLayoutOptions.setHandout(HandoutType.Handouts4Horizontal);
     options.setSlidesLayoutOptions(slidesLayoutOptions);

     pres.save("pres.html", SaveFormat.Html, options);
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Specified by:

setSlidesLayoutOptions in interface IHtmlOptions

getInkOptions

public final IInkOptions getInkOptions()

Provides options that control the look of Ink objects in exported document. Read-only IInkOptions

Specified by:

getInkOptions in interface IHtmlOptions

getShowHiddenSlides

public final boolean getShowHiddenSlides()

Specifies whether the generated document should include hidden slides or not. Default is false.

Specified by:

getShowHiddenSlides in interface IHtmlOptions

setShowHiddenSlides

public final void setShowHiddenSlides(boolean value)

Specifies whether the generated document should include hidden slides or not. Default is false.

Specified by:

setShowHiddenSlides in interface IHtmlOptions

getHtmlFormatter

public final IHtmlFormatter getHtmlFormatter()

Returns or sets HTML template. Read/write IHtmlFormatter.

Specified by:

getHtmlFormatter in interface IHtmlOptions

setHtmlFormatter

public final void setHtmlFormatter(IHtmlFormatter value)

Returns or sets HTML template. Read/write IHtmlFormatter.

Specified by:

setHtmlFormatter in interface IHtmlOptions

getDisableFontLigatures

public final boolean getDisableFontLigatures()

Gets or sets a value indicating whether text is rendered without using ligatures. When set to true, ligatures will be disabled in the rendered output. By default, this property is set to false.

Example:
 
 Presentation pres = new Presentation("pres.pptx");
 try {
     HtmlOptions options = new HtmlOptions();
     options.setDisableFontLigatures(true);
     pres.save("presentation.html", SaveFormat.Html, options);
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Specified by:

getDisableFontLigatures in interface IHtmlOptions

setDisableFontLigatures

public final void setDisableFontLigatures(boolean value)

Gets or sets a value indicating whether text is rendered without using ligatures. When set to true, ligatures will be disabled in the rendered output. By default, this property is set to false.

Example:
 
 Presentation pres = new Presentation("pres.pptx");
 try {
     HtmlOptions options = new HtmlOptions();
     options.setDisableFontLigatures(true);
     pres.save("presentation.html", SaveFormat.Html, options);
 } finally {
     if (pres != null) pres.dispose();
 }
 
 

Specified by:

setDisableFontLigatures in interface IHtmlOptions

getSlideImageFormat

public final ISlideImageFormat getSlideImageFormat()

Returns or sets slide image format options. Read/write ISlideImageFormat.

Specified by:

getSlideImageFormat in interface IHtmlOptions

setSlideImageFormat

public final void setSlideImageFormat(ISlideImageFormat value)

Returns or sets slide image format options. Read/write ISlideImageFormat.

Specified by:

setSlideImageFormat in interface IHtmlOptions

getJpegQuality

public final byte getJpegQuality()

Returns or sets a value determining the quality of the JPEG images inside PDF document. Read/write byte.

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

Specified by:

getJpegQuality in interface IHtmlOptions

setJpegQuality

public final void setJpegQuality(byte value)

Returns or sets a value determining the quality of the JPEG images inside PDF document. Read/write byte.

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

Specified by:

setJpegQuality in interface IHtmlOptions

getPicturesCompression

public final int getPicturesCompression()

Represents the pictures compression level

Specified by:

getPicturesCompression in interface IHtmlOptions

setPicturesCompression

public final void setPicturesCompression(int value)

Represents the pictures compression level

Specified by:

setPicturesCompression in interface IHtmlOptions

getDeletePicturesCroppedAreas

public final boolean getDeletePicturesCroppedAreas()

A boolean flag indicates if the cropped parts remain as part of the document. If true the cropped parts will removed, if false they will be serialized in the document (which can possible lead to a larger file)

Specified by:

getDeletePicturesCroppedAreas in interface IHtmlOptions

setDeletePicturesCroppedAreas

public final void setDeletePicturesCroppedAreas(boolean value)

A boolean flag indicates if the cropped parts remain as part of the document. If true the cropped parts will removed, if false they will be serialized in the document (which can possible lead to a larger file)

Specified by:

setDeletePicturesCroppedAreas in interface IHtmlOptions

getSvgResponsiveLayout

public final boolean getSvgResponsiveLayout()

True to exclude width and height attributes from svg container - that will make layout responsive. False - otherwise. Read/write boolean.

Specified by:

getSvgResponsiveLayout in interface IHtmlOptions

setSvgResponsiveLayout

public final void setSvgResponsiveLayout(boolean value)

True to exclude width and height attributes from svg container - that will make layout responsive. False - otherwise. Read/write boolean.

Specified by:

setSvgResponsiveLayout in interface IHtmlOptions