com.aspose.tasks

Interfaces

Classes

Exceptions

com.aspose.tasks

Class HtmlSaveOptions



  • public class HtmlSaveOptions
    extends SaveOptions

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

    • Constructor Detail

      • HtmlSaveOptions

        public HtmlSaveOptions()

        Initializes a new instance of the HtmlSaveOptions class.

    • Method Detail

      • copyOutputPropertiesFrom

        public final void copyOutputPropertiesFrom(SaveOptions source)
        Reserved for internal usage.
        Parameters:
        source - Reserved for internal usage.
      • deepClone

        public final SaveOptions deepClone()
        Reserved for internal usage.
        Returns:
        Reserved for internal usage.
      • 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.
      • 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.
      • 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 class SaveOptions
        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 class SaveOptions
        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.