IHtmlOptions

All Implemented Interfaces: com.aspose.slides.ISaveOptions

public interface IHtmlOptions extends ISaveOptions

Represents a HTML exporting options.

Methods

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

getHtmlFormatter()

public abstract IHtmlFormatter getHtmlFormatter()

Returns or sets HTML template. Read/write IHtmlFormatter.

Returns: IHtmlFormatter

setHtmlFormatter(IHtmlFormatter value)

public abstract void setHtmlFormatter(IHtmlFormatter value)

Returns or sets HTML template. Read/write IHtmlFormatter.

Parameters:

Parameter	Type	Description
value	IHtmlFormatter

getSlideImageFormat()

public abstract ISlideImageFormat getSlideImageFormat()

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

Returns: ISlideImageFormat

setSlideImageFormat(ISlideImageFormat value)

public abstract void setSlideImageFormat(ISlideImageFormat value)

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

Parameters:

Parameter	Type	Description
value	ISlideImageFormat

getShowHiddenSlides()

public abstract boolean getShowHiddenSlides()

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

Returns: boolean

setShowHiddenSlides(boolean value)

public abstract void setShowHiddenSlides(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

getJpegQuality()

public abstract 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.

Returns: byte

setJpegQuality(byte value)

public abstract 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.

Parameters:

Parameter	Type	Description
value	byte

getPicturesCompression()

public abstract int getPicturesCompression()

Represents the pictures compression level Read/write PicturesCompression(#getPicturesCompression.getPicturesCompression/#setPicturesCompression(int).setPicturesCompression(int)).

Returns: int

setPicturesCompression(int value)

public abstract void setPicturesCompression(int value)

Represents the pictures compression level Read/write PicturesCompression(#getPicturesCompression.getPicturesCompression/#setPicturesCompression(int).setPicturesCompression(int)).

Parameters:

Parameter	Type	Description
value	int

getDeletePicturesCroppedAreas()

public abstract 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) Read/write boolean.

Returns: boolean

setDeletePicturesCroppedAreas(boolean value)

public abstract 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) Read/write boolean.

Parameters:

Parameter	Type	Description
value	boolean

getSvgResponsiveLayout()

public abstract boolean getSvgResponsiveLayout()

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

Returns: boolean

setSvgResponsiveLayout(boolean value)

public abstract void setSvgResponsiveLayout(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

getSlidesLayoutOptions()

public abstract 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();
 }

Returns: ISlidesLayoutOptions

setSlidesLayoutOptions(ISlidesLayoutOptions value)

public abstract 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();
 }

Parameters:

Parameter	Type	Description
value	ISlidesLayoutOptions

getInkOptions()

public abstract IInkOptions getInkOptions()

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

Returns: IInkOptions