HtmlOptions

Inheritance: java.lang.Object, com.aspose.slides.SaveOptions

All Implemented Interfaces: com.aspose.slides.IHtmlOptions

public class HtmlOptions extends SaveOptions implements IHtmlOptions

Represents a HTML exporting options.

Constructors

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

Methods

Method	Description
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.
getNotesCommentsLayouting()	Provides options that control how notes and comments is placed in exported document.
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.
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.
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
setPicturesCompression(int value)	Represents the pictures compression level
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.

HtmlOptions(ILinkEmbedController linkEmbedController)

public HtmlOptions(ILinkEmbedController linkEmbedController)

Creates a new HtmlOptions object specifiing callback.

Parameters:

Parameter	Type	Description
linkEmbedController	ILinkEmbedController	Callback object which controls saving project.

HtmlOptions()

public HtmlOptions()

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

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

Returns: ISlidesLayoutOptions

setSlidesLayoutOptions(ISlidesLayoutOptions value)

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

Parameters:

Parameter	Type	Description
value	ISlidesLayoutOptions

getInkOptions()

public final IInkOptions getInkOptions()

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

Returns: IInkOptions

getNotesCommentsLayouting()

public final INotesCommentsLayoutingOptions getNotesCommentsLayouting()

Provides options that control how notes and comments is placed in exported document.

Returns: INotesCommentsLayoutingOptions

getShowHiddenSlides()

public final boolean getShowHiddenSlides()

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

Returns: boolean

setShowHiddenSlides(boolean value)

public final void setShowHiddenSlides(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

getHtmlFormatter()

public final IHtmlFormatter getHtmlFormatter()

Returns or sets HTML template. Read/write IHtmlFormatter.

Returns: IHtmlFormatter

setHtmlFormatter(IHtmlFormatter value)

public final void setHtmlFormatter(IHtmlFormatter value)

Returns or sets HTML template. Read/write IHtmlFormatter.

Parameters:

Parameter	Type	Description
value	IHtmlFormatter

getSlideImageFormat()

public final ISlideImageFormat getSlideImageFormat()

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

Returns: ISlideImageFormat

setSlideImageFormat(ISlideImageFormat value)

public final void setSlideImageFormat(ISlideImageFormat value)

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

Parameters:

Parameter	Type	Description
value	ISlideImageFormat

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.

Returns: byte

setJpegQuality(byte value)

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.

The default value is 95.

Parameters:

Parameter	Type	Description
value	byte

getPicturesCompression()

public final int getPicturesCompression()

Represents the pictures compression level

Returns: int

setPicturesCompression(int value)

public final void setPicturesCompression(int value)

Represents the pictures compression level

Parameters:

Parameter	Type	Description
value	int

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)

Returns: boolean

setDeletePicturesCroppedAreas(boolean value)

public final void setDeletePicturesCroppedAreas(boolean value)

Parameters:

Parameter	Type	Description
value	boolean

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.

Returns: boolean

setSvgResponsiveLayout(boolean value)

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.

Parameters:

Parameter	Type	Description
value	boolean