HtmlSaveOptions

Inheritance: java.lang.Object, com.aspose.tasks.SimpleSaveOptions, com.aspose.tasks.SaveOptions

All Implemented Interfaces: com.aspose.tasks.SaveOptions.IReduceBottomGap, com.aspose.tasks.SaveOptions.IFontCallbacks, com.aspose.tasks.ICloneableSaveOptions

public class HtmlSaveOptions extends SaveOptions implements SaveOptions.IReduceBottomGap, SaveOptions.IFontCallbacks, ICloneableSaveOptions

Allows to specify additional options when rendering project pages to HTML.

Constructors

Constructor	Description
HtmlSaveOptions()	Initializes a new instance of the HtmlSaveOptions class.

Methods

Method	Description
copyOutputPropertiesFrom(SaveOptions source)	{@inheritDoc}
deepClone()	{@inheritDoc}
getCssSavingCallback()	Gets the callback that is called to create resource to store CSS.
getCssStylePrefix()	Gets CSS style prefix.
getExportCss()	Gets the way CSS are exported.
getExportFonts()	Gets the way fonts are exported.
getExportImages()	Gets the way images are exported.
getFontFaceTypes()	Gets the font face types.
getFontSavingCallback()	Gets the callback that is called to create resource to store font.
getFontSettings()	Specifies font settings used when rendering project’s view.
getImageSavingCallback()	Gets the callback that is called to create resource to store font.
getIncludeProjectNameInPageHeader()	Gets a value indicating whether to include project name in HTML page header.
getIncludeProjectNameInTitle()	Gets a value indicating whether to include project name in HTML title.
getPageSavingCallback()	Gets a user-defined callback which is used to get an output stream for each rendered page.
getPages()	Gets a list of page numbers to save when rendering project layout.
getReduceFooterGap()	Gets a value indicating whether a gap between last task and the footer must be reduced.
getUseGradientBrush()	Gets a value indicating whether to use gradient brush when rendering project layout.
setCssSavingCallback(ICssSavingCallback value)	Sets the callback that is called to create resource to store CSS.
setCssStylePrefix(String value)	Sets CSS style prefix.
setExportCss(int value)	Sets the way CSS are exported.
setExportFonts(int value)	Sets the way fonts are exported.
setExportImages(int value)	Sets the way images are exported.
setFontFaceTypes(int value)	Sets the font face types.
setFontSavingCallback(IFontSavingCallback value)	Sets the callback that is called to create resource to store font.
setImageSavingCallback(IImageSavingCallback value)	Sets the callback that is called to create resource to store font.
setIncludeProjectNameInPageHeader(boolean value)	Sets a value indicating whether to include project name in HTML page header.
setIncludeProjectNameInTitle(boolean value)	Sets a value indicating whether to include project name in HTML title.
setPageSavingCallback(IPageSavingCallback value)	Sets a user-defined callback which is used to get an output stream for each rendered page.
setPages(List<Integer> value)	Sets a list of page numbers to save when rendering project layout.
setReduceFooterGap(boolean value)	Sets a value indicating whether a gap between last task and the footer must be reduced.
setUseGradientBrush(boolean value)	Sets a value indicating whether to use gradient brush when rendering project layout.

HtmlSaveOptions()

public HtmlSaveOptions()

Initializes a new instance of the HtmlSaveOptions class.

copyOutputPropertiesFrom(SaveOptions source)

public final void copyOutputPropertiesFrom(SaveOptions source)

Reserved for internal usage.

Parameters:

Parameter	Type	Description
source	SaveOptions	{@inheritDoc}

deepClone()

public SaveOptions deepClone()

Reserved for internal usage.

Returns: SaveOptions - {@inheritDoc}

getCssSavingCallback()

public final ICssSavingCallback getCssSavingCallback()

Gets the callback that is called to create resource to store CSS.

Returns: ICssSavingCallback - the callback that is called to create resource to store CSS.

getCssStylePrefix()

public final String getCssStylePrefix()

Gets CSS style prefix.

Returns: java.lang.String - CSS style prefix.

getExportCss()

public final int getExportCss()

Gets the way CSS are exported.

Returns: int - the way CSS are exported.

getExportFonts()

public final int getExportFonts()

Gets the way fonts are exported.

Returns: int - the way fonts are exported.

getExportImages()

public final int getExportImages()

Gets the way images are exported.

Returns: int - the way images are exported.

getFontFaceTypes()

public final int getFontFaceTypes()

Gets the font face types.

Value: The font face types.

Returns: int - the font face types.

getFontSavingCallback()

public final IFontSavingCallback getFontSavingCallback()

Gets the callback that is called to create resource to store font.

Returns: IFontSavingCallback - the callback that is called to create resource to store font.

getFontSettings()

public final FontSettings getFontSettings()

Specifies font settings used when rendering project’s view.

Returns: FontSettings - font settings.

getImageSavingCallback()

public final IImageSavingCallback getImageSavingCallback()

Gets the callback that is called to create resource to store font.

Returns: IImageSavingCallback - the callback that is called to create resource to store font.

getIncludeProjectNameInPageHeader()

public final boolean getIncludeProjectNameInPageHeader()

Gets a value indicating whether to include project name in HTML page header.

Returns: boolean - a value indicating whether to include project name in HTML page header.

getIncludeProjectNameInTitle()

public final boolean getIncludeProjectNameInTitle()

Gets a value indicating whether to include project name in HTML title.

Returns: boolean - a value indicating whether to include project name in HTML title.

getPageSavingCallback()

public final IPageSavingCallback getPageSavingCallback()

Gets a user-defined callback which is used to get an output stream for each rendered page.

Returns: IPageSavingCallback - a user-defined callback which is used to get an output stream for each rendered page.

getPages()

public final List<Integer> getPages()

Gets a list of page numbers to save when rendering project layout.

---

All project pages will be saved if this list is empty.

Returns: java.util.List<java.lang.Integer> - a list of page numbers to save when rendering project layout.

getReduceFooterGap()

public final boolean getReduceFooterGap()

Gets a value indicating whether a gap between last task and the footer must be reduced.

Returns: boolean - a value indicating whether a gap between last task and the footer must be reduced.

getUseGradientBrush()

public boolean getUseGradientBrush()

Gets a value indicating whether to use gradient brush when rendering project layout.

---

Currently using of gradient brush is not supported when rendering to HTML.

Returns: boolean - a value indicating whether to use gradient brush when rendering project layout.

setCssSavingCallback(ICssSavingCallback value)

public final void setCssSavingCallback(ICssSavingCallback value)

Sets the callback that is called to create resource to store CSS.

Parameters:

Parameter	Type	Description
value	ICssSavingCallback	the callback that is called to create resource to store CSS.

setCssStylePrefix(String value)

public final void setCssStylePrefix(String value)

Sets CSS style prefix.

Parameters:

Parameter	Type	Description
value	java.lang.String	CSS style prefix.

setExportCss(int value)

public final void setExportCss(int value)

Sets the way CSS are exported.

Parameters:

Parameter	Type	Description
value	int	the way CSS are exported.

setExportFonts(int value)

public final void setExportFonts(int value)

Sets the way fonts are exported.

Parameters:

Parameter	Type	Description
value	int	the way fonts are exported.

setExportImages(int value)

public final void setExportImages(int value)

Sets the way images are exported.

Parameters:

Parameter	Type	Description
value	int	the way images are exported.

setFontFaceTypes(int value)

public final void setFontFaceTypes(int value)

Sets the font face types.

Value: The font face types.

Parameters:

Parameter	Type	Description
value	int	the font face types.

setFontSavingCallback(IFontSavingCallback value)

public final void setFontSavingCallback(IFontSavingCallback value)

Sets the callback that is called to create resource to store font.

Parameters:

Parameter	Type	Description
value	IFontSavingCallback	the callback that is called to create resource to store font.

setImageSavingCallback(IImageSavingCallback value)

public final void setImageSavingCallback(IImageSavingCallback value)

Sets the callback that is called to create resource to store font.

Parameters:

Parameter	Type	Description
value	IImageSavingCallback	the callback that is called to create resource to store font.

setIncludeProjectNameInPageHeader(boolean value)

public final void setIncludeProjectNameInPageHeader(boolean value)

Sets a value indicating whether to include project name in HTML page header.

Parameters:

Parameter	Type	Description
value	boolean	a value indicating whether to include project name in HTML page header.

setIncludeProjectNameInTitle(boolean value)

public final void setIncludeProjectNameInTitle(boolean value)

Sets a value indicating whether to include project name in HTML title.

Parameters:

Parameter	Type	Description
value	boolean	a value indicating whether to include project name in HTML title.

setPageSavingCallback(IPageSavingCallback value)

public final void setPageSavingCallback(IPageSavingCallback value)

Sets a user-defined callback which is used to get an output stream for each rendered page.

Parameters:

Parameter	Type	Description
value	IPageSavingCallback	a user-defined callback which is used to get an output stream for each rendered page.

setPages(List<Integer> value)

public final void setPages(List<Integer> value)

Sets a list of page numbers to save when rendering project layout.

---

All project pages will be saved if this list is empty.

Parameters:

Parameter	Type	Description
value	java.util.List<java.lang.Integer>	a list of page numbers to save when rendering project layout.

setReduceFooterGap(boolean value)

public final void setReduceFooterGap(boolean value)

Sets a value indicating whether a gap between last task and the footer must be reduced.

Parameters:

Parameter	Type	Description
value	boolean	a value indicating whether a gap between last task and the footer must be reduced.

setUseGradientBrush(boolean value)

public void setUseGradientBrush(boolean value)

Sets a value indicating whether to use gradient brush when rendering project layout.

---

Currently using of gradient brush is not supported when rendering to HTML.

Parameters:

Parameter	Type	Description
value	boolean	a value indicating whether to use gradient brush when rendering project layout.