Class HtmlSaveOptions
- java.lang.Object
-
- com.aspose.tasks.SaveOptions
-
- com.aspose.tasks.HtmlSaveOptions
-
public class HtmlSaveOptions extends SaveOptions
Allows to specify additional options when rendering project pages to HTML.
-
-
Constructor Summary
Constructors Constructor Description HtmlSaveOptions()
Initializes a new instance of theHtmlSaveOptions
class.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
copyOutputPropertiesFrom(SaveOptions source)
SaveOptions
deepClone()
ICssSavingCallback
getCssSavingCallback()
Gets the callback that is called to create resource to store CSS.String
getCssStylePrefix()
Gets CSS style prefix.String
getDefaultFontName()
Gets the default font for rendering.int
getExportCss()
Gets the way CSS are exported.int
getExportFonts()
Gets the way fonts are exported.int
getExportImages()
Gets the way images are exported.int
getFontFaceTypes()
Gets the font face types.FontResolveCallbackDelegate
getFontResolveCallback()
Gets a callback which can be used to customize resolved fonts.IFontSavingCallback
getFontSavingCallback()
Gets the callback that is called to create resource to store font.IImageSavingCallback
getImageSavingCallback()
Gets the callback that is called to create resource to store font.boolean
getIncludeProjectNameInPageHeader()
Gets a value indicating whether to include project name in HTML page header.boolean
getIncludeProjectNameInTitle()
Gets a value indicating whether to include project name in HTML title.List<Integer>
getPages()
Gets a list of page numbers to save when rendering project layout.IPageSavingCallback
getPageSavingCallback()
Gets a user-defined callback which is used to get an output stream for each rendered page.boolean
getReduceFooterGap()
Gets a value indicating whether a gap between last task and the footer must be reduced.boolean
getUseGradientBrush()
Gets a value indicating whether to use gradient brush when rendering project layout.boolean
getUseProjectDefaultFont()
Gets a value indicating whether the default font must be used for rendering.void
setCssSavingCallback(ICssSavingCallback value)
Sets the callback that is called to create resource to store CSS.void
setCssStylePrefix(String value)
Sets CSS style prefix.void
setDefaultFontName(String value)
Sets the default font for rendering.void
setExportCss(int value)
Sets the way CSS are exported.void
setExportFonts(int value)
Sets the way fonts are exported.void
setExportImages(int value)
Sets the way images are exported.void
setFontFaceTypes(int value)
Sets the font face types.void
setFontResolveCallback(FontResolveCallbackDelegate value)
Sets a callback which can be used to customize resolved fonts.void
setFontSavingCallback(IFontSavingCallback value)
Sets the callback that is called to create resource to store font.void
setImageSavingCallback(IImageSavingCallback value)
Sets the callback that is called to create resource to store font.void
setIncludeProjectNameInPageHeader(boolean value)
Sets a value indicating whether to include project name in HTML page header.void
setIncludeProjectNameInTitle(boolean value)
Sets a value indicating whether to include project name in HTML title.void
setPages(List<Integer> value)
Sets a list of page numbers to save when rendering project layout.void
setPageSavingCallback(IPageSavingCallback value)
Sets a user-defined callback which is used to get an output stream for each rendered page.void
setReduceFooterGap(boolean value)
Sets a value indicating whether a gap between last task and the footer must be reduced.void
setUseGradientBrush(boolean value)
Sets a value indicating whether to use gradient brush when rendering project layout.void
setUseProjectDefaultFont(boolean value)
Sets a value indicating whether the default font must be used for rendering.-
Methods inherited from class com.aspose.tasks.SaveOptions
getBarStyles, getCustomPageSize, getDrawNonWorkingTime, getEndDate, getFitContent, getGridlines, getLegendOnEachPage, getMarkCriticalTasks, getNonWorkingTimeColor, getPageCount, getPageSize, getPresentationFormat, getRenderToSinglePage, getRollUpGanttBars, getSaveFormat, getStartDate, getTasksComparer, getTasksFilter, getTextStyles, getTimescale, getView, getViewSettings, setBarStyles, setCustomPageSize, setDrawNonWorkingTime, setEndDate, setFitContent, setGridlines, setLegendOnEachPage, setMarkCriticalTasks, setNonWorkingTimeColor, setPageSize, setPresentationFormat, setRenderToSinglePage, setRollUpGanttBars, setStartDate, setTasksComparer, setTasksFilter, setTextStyles, setTimescale, setView, setViewSettings
-
-
-
-
Constructor Detail
-
HtmlSaveOptions
public HtmlSaveOptions()
Initializes a new instance of the
HtmlSaveOptions
class.
-
-
Method Detail
-
copyOutputPropertiesFrom
public final void copyOutputPropertiesFrom(SaveOptions source)
- Parameters:
source
-
-
deepClone
public SaveOptions deepClone()
- Returns:
-
getCssSavingCallback
public final ICssSavingCallback getCssSavingCallback()
Gets the callback that is called to create resource to store CSS.
- Returns:
- the callback that is called to create resource to store CSS.
-
setCssSavingCallback
public final void setCssSavingCallback(ICssSavingCallback value)
Sets the callback that is called to create resource to store CSS.
- Parameters:
value
- the callback that is called to create resource to store CSS.
-
getCssStylePrefix
public final String getCssStylePrefix()
Gets CSS style prefix.
- Returns:
- CSS style prefix.
-
setCssStylePrefix
public final void setCssStylePrefix(String value)
Sets CSS style prefix.
- Parameters:
value
- CSS style prefix.
-
getDefaultFontName
public final String getDefaultFontName()
Gets the default font for rendering.
- Returns:
- the default font for rendering.
-
setDefaultFontName
public final void setDefaultFontName(String value)
Sets the default font for rendering.
- Parameters:
value
- the default font for rendering.
-
getExportCss
public final int getExportCss()
Gets the way CSS are exported.
- Returns:
- the way CSS are exported.
-
setExportCss
public final void setExportCss(int value)
Sets the way CSS are exported.
- Parameters:
value
- the way CSS are exported.
-
getExportFonts
public final int getExportFonts()
Gets the way fonts are exported.
- Returns:
- the way fonts are exported.
-
setExportFonts
public final void setExportFonts(int value)
Sets the way fonts are exported.
- Parameters:
value
- the way fonts are exported.
-
getExportImages
public final int getExportImages()
Gets the way images are exported.
- Returns:
- the way images are exported.
-
setExportImages
public final void setExportImages(int value)
Sets the way images are exported.
- Parameters:
value
- the way images are exported.
-
getFontFaceTypes
public final int getFontFaceTypes()
Gets the font face types.
Value: The font face types.- Returns:
- the font face types.
-
setFontFaceTypes
public final void setFontFaceTypes(int value)
Sets the font face types.
Value: The font face types.- Parameters:
value
- the font face types.
-
getFontResolveCallback
public final FontResolveCallbackDelegate getFontResolveCallback()
Gets a callback which can be used to customize resolved fonts.
- Returns:
- a callback which can be used to customize resolved fonts.
-
setFontResolveCallback
public final void setFontResolveCallback(FontResolveCallbackDelegate value)
Sets a callback which can be used to customize resolved fonts.
- Parameters:
value
- a callback which can be used to customize resolved fonts.
-
getFontSavingCallback
public final IFontSavingCallback getFontSavingCallback()
Gets the callback that is called to create resource to store font.
- Returns:
- the callback that is called to create resource to store font.
-
setFontSavingCallback
public final void setFontSavingCallback(IFontSavingCallback value)
Sets the callback that is called to create resource to store font.
- Parameters:
value
- the callback that is called to create resource to store font.
-
getImageSavingCallback
public final IImageSavingCallback getImageSavingCallback()
Gets the callback that is called to create resource to store font.
- Returns:
- the callback that is called to create resource to store font.
-
setImageSavingCallback
public final void setImageSavingCallback(IImageSavingCallback value)
Sets the callback that is called to create resource to store font.
- Parameters:
value
- 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:
- a value indicating whether to include project name in HTML page header.
-
setIncludeProjectNameInPageHeader
public final void setIncludeProjectNameInPageHeader(boolean value)
Sets a value indicating whether to include project name in HTML page header.
- Parameters:
value
- 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:
- a value indicating whether to include project name in HTML title.
-
setIncludeProjectNameInTitle
public final void setIncludeProjectNameInTitle(boolean value)
Sets a value indicating whether to include project name in HTML title.
- Parameters:
value
- 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:
- a user-defined callback which is used to get an output stream for each rendered page.
-
setPageSavingCallback
public final void setPageSavingCallback(IPageSavingCallback value)
Sets a user-defined callback which is used to get an output stream for each rendered page.
- Parameters:
value
- 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:
- a list of page numbers to save when rendering project layout.
-
setPages
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:
value
- 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:
- a value indicating whether a gap between last task and the footer must be reduced.
-
setReduceFooterGap
public final void setReduceFooterGap(boolean value)
Sets a value indicating whether a gap between last task and the footer must be reduced.
- Parameters:
value
- 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.- Overrides:
getUseGradientBrush
in classSaveOptions
- Returns:
- a value indicating whether to use gradient brush when rendering project layout.
-
setUseGradientBrush
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.- Overrides:
setUseGradientBrush
in classSaveOptions
- Parameters:
value
- a value indicating whether to use gradient brush when rendering project layout.
-
getUseProjectDefaultFont
public final boolean getUseProjectDefaultFont()
Gets a value indicating whether the default font must be used for rendering.
- Returns:
- a value indicating whether the default font must be used for rendering.
-
setUseProjectDefaultFont
public final void setUseProjectDefaultFont(boolean value)
Sets a value indicating whether the default font must be used for rendering.
- Parameters:
value
- a value indicating whether the default font must be used for rendering.
-
-