public class HtmlSaveOptions extends SaveOptions
Allows to specify additional options when rendering project pages to HTML.
Constructor and Description |
---|
HtmlSaveOptions()
Initializes a new instance of the
HtmlSaveOptions class. |
Modifier and Type | Method and Description |
---|---|
void |
copyOutputPropertiesFrom(SaveOptions source)
Reserved for internal usage.
|
SaveOptions |
deepClone()
Reserved for internal usage.
|
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.
|
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.
|
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 |
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 |
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.
|
getBarStyles, getDrawNonWorkingTime, getEndDate, getFitContent, getGridlines, getLegendOnEachPage, getMarkCriticalTasks, getNonWorkingTimeColor, getPageCount, getPageSize, getPresentationFormat, getRollUpGanttBars, getSaveFormat, getShowProjectSummaryTask, getStartDate, getTasksComparer, getTasksFilter, getTextStyles, getTimescale, getTimescaleTier, getView, setBarStyles, setDrawNonWorkingTime, setEndDate, setFitContent, setGridlines, setLegendOnEachPage, setMarkCriticalTasks, setNonWorkingTimeColor, setPageSize, setPresentationFormat, setRollUpGanttBars, setShowProjectSummaryTask, setStartDate, setTasksComparer, setTasksFilter, setTextStyles, setTimescale, setTimescaleTier, setView
public HtmlSaveOptions()
Initializes a new instance of the HtmlSaveOptions
class.
public final void copyOutputPropertiesFrom(SaveOptions source)
source
- Reserved for internal usage.public final SaveOptions deepClone()
public final ICssSavingCallback getCssSavingCallback()
Gets the callback that is called to create resource to store CSS.
public final void setCssSavingCallback(ICssSavingCallback value)
Sets the callback that is called to create resource to store CSS.
value
- the callback that is called to create resource to store CSS.public final String getCssStylePrefix()
Gets CSS style prefix.
public final void setCssStylePrefix(String value)
Sets CSS style prefix.
value
- CSS style prefix.public final String getDefaultFontName()
Gets the default font for rendering.
public final void setDefaultFontName(String value)
Sets the default font for rendering.
value
- the default font for rendering.public final int getExportCss()
Gets the way CSS are exported.
public final void setExportCss(int value)
Sets the way CSS are exported.
value
- the way CSS are exported.public final int getExportFonts()
Gets the way fonts are exported.
public final void setExportFonts(int value)
Sets the way fonts are exported.
value
- the way fonts are exported.public final int getExportImages()
Gets the way images are exported.
public final void setExportImages(int value)
Sets the way images are exported.
value
- the way images are exported.public final int getFontFaceTypes()
Gets the font face types.
Value: The font face types.public final void setFontFaceTypes(int value)
Sets the font face types.
Value: The font face types.value
- the font face types.public final IFontSavingCallback getFontSavingCallback()
Gets the callback that is called to create resource to store font.
public final void setFontSavingCallback(IFontSavingCallback value)
Sets the callback that is called to create resource to store font.
value
- the callback that is called to create resource to store font.public final IImageSavingCallback getImageSavingCallback()
Gets the callback that is called to create resource to store font.
public final void setImageSavingCallback(IImageSavingCallback value)
Sets the callback that is called to create resource to store font.
value
- the callback that is called to create resource to store font.public final boolean getIncludeProjectNameInPageHeader()
Gets a value indicating whether to include project name in HTML page header.
public final void setIncludeProjectNameInPageHeader(boolean value)
Sets a value indicating whether to include project name in HTML page header.
value
- a value indicating whether to include project name in HTML page header.public final boolean getIncludeProjectNameInTitle()
Gets a value indicating whether to include project name in HTML title.
public final void setIncludeProjectNameInTitle(boolean value)
Sets a value indicating whether to include project name in HTML title.
value
- a value indicating whether to include project name in HTML title.public final List<Integer> getPages()
Gets a list of page numbers to save when rendering project layout.
public final void setPages(List<Integer> value)
Sets a list of page numbers to save when rendering project layout.
value
- a list of page numbers to save when rendering project layout.public final boolean getReduceFooterGap()
Gets a value indicating whether a gap between last task and the footer must be reduced.
public final void setReduceFooterGap(boolean value)
Sets a value indicating whether a gap between last task and the footer must be reduced.
value
- a value indicating whether a gap between last task and the footer must be reduced.public boolean getUseGradientBrush()
Gets a value indicating whether to use gradient brush when rendering project layout.
getUseGradientBrush
in class SaveOptions
public void setUseGradientBrush(boolean value)
Sets a value indicating whether to use gradient brush when rendering project layout.
setUseGradientBrush
in class SaveOptions
value
- a value indicating whether to use gradient brush when rendering project layout.public final boolean getUseProjectDefaultFont()
Gets a value indicating whether the default font must be used for rendering.
public final void setUseProjectDefaultFont(boolean value)
Sets a value indicating whether the default font must be used for rendering.
value
- a value indicating whether the default font must be used for rendering.