Aspose::Tasks::Saving::HtmlSaveOptions Class Reference

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

#include <HtmlSaveOptions.h>

Inherits Aspose::Tasks::Saving::SaveOptions, Aspose::Tasks::Saving::SaveOptions::IReduceBottomGap, Aspose::Tasks::Saving::SaveOptions::IFontCallbacks, and Aspose::Tasks::Saving::ICloneableSaveOptions.

Public Member Functions
System::String	get_CssStylePrefix () const
	Gets CSS style prefix. More...
void	set_CssStylePrefix (const System::String &value)
	Sets CSS style prefix. More...
System::SharedPtr< Aspose::Tasks::FontSettings >	get_FontSettings () override
	Specifies font settings used when rendering project's view. More...
bool	get_ReduceFooterGap () override
	Gets a value indicating whether a gap between last task and the footer must be reduced. More...
void	set_ReduceFooterGap (bool value)
	Sets a value indicating whether a gap between last task and the footer must be reduced. More...
bool	get_IncludeProjectNameInPageHeader () const
	Gets a value indicating whether to include project name in HTML page header. More...
void	set_IncludeProjectNameInPageHeader (bool value)
	Sets a value indicating whether to include project name in HTML page header. More...
bool	get_IncludeProjectNameInTitle () const
	Gets a value indicating whether to include project name in HTML title. More...
void	set_IncludeProjectNameInTitle (bool value)
	Sets a value indicating whether to include project name in HTML title. More...
System::SharedPtr< System::Collections::Generic::List< int32_t > >	get_Pages ()
	Gets a list of page numbers to save when rendering project layout. More...
void	set_Pages (const System::SharedPtr< System::Collections::Generic::List< int32_t >> &value)
	Sets a list of page numbers to save when rendering project layout. More...
ResourceExportType	get_ExportCss () const
	Gets the way CSS are exported. More...
void	set_ExportCss (ResourceExportType value)
	Sets the way CSS are exported. More...
ResourceExportType	get_ExportImages () const
	Gets the way images are exported. More...
void	set_ExportImages (ResourceExportType value)
	Sets the way images are exported. More...
ResourceExportType	get_ExportFonts () const
	Gets the way fonts are exported. More...
void	set_ExportFonts (ResourceExportType value)
	Sets the way fonts are exported. More...
const System::SharedPtr< ICssSavingCallback > &	get_CssSavingCallback () const
	Gets the callback that is called to create resource to store CSS. More...
void	set_CssSavingCallback (const System::SharedPtr< ICssSavingCallback > &value)
	Sets the callback that is called to create resource to store CSS. More...
const System::SharedPtr< IFontSavingCallback > &	get_FontSavingCallback () const
	Gets the callback that is called to create resource to store font. More...
void	set_FontSavingCallback (const System::SharedPtr< IFontSavingCallback > &value)
	Sets the callback that is called to create resource to store font. More...
const System::SharedPtr< IImageSavingCallback > &	get_ImageSavingCallback () const
	Gets the callback that is called to create resource to store font. More...
void	set_ImageSavingCallback (const System::SharedPtr< IImageSavingCallback > &value)
	Sets the callback that is called to create resource to store font. More...
FontFaceType	get_FontFaceTypes () const
	Gets the font face types. More...
void	set_FontFaceTypes (FontFaceType value)
	Sets the font face types. More...
bool	get_UseGradientBrush () override
	Gets a value indicating whether to use gradient brush when rendering project layout. More...
void	set_UseGradientBrush (bool value) override
	Sets a value indicating whether to use gradient brush when rendering project layout. More...
const System::SharedPtr< IPageSavingCallback > &	get_PageSavingCallback () const
	Gets a user-defined callback which is used to get an output stream for each rendered page. More...
void	set_PageSavingCallback (const System::SharedPtr< IPageSavingCallback > &value)
	Sets a user-defined callback which is used to get an output stream for each rendered page. More...
	HtmlSaveOptions ()
	Initializes a new instance of the HtmlSaveOptions class. More...
Public Member Functions inherited from Aspose::Tasks::Saving::SaveOptions
const System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Aspose::Tasks::Visualization::BarStyle > > > &	get_BarStyles () const
	Gets the list of the instances of the BarStyle class that appear in project view. More...
void	set_BarStyles (const System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Aspose::Tasks::Visualization::BarStyle >>> &value)
	Sets the list of the instances of the BarStyle class that appear in project view. More...
bool	get_DrawNonWorkingTime () const
	Gets a value indicating whether non-working time should be drawn (Default value is TRUE). More...
void	set_DrawNonWorkingTime (bool value)
	Sets a value indicating whether non-working time should be drawn (Default value is TRUE). More...
System::DateTime	get_EndDate () const
	Gets a date to finish rendering to. More...
void	set_EndDate (System::DateTime value)
	Sets a date to finish rendering to. More...
bool	get_FitTimescaleToEndOfPage () const
	Gets whether a calendar section of a view should be rendered to the end (right side) of the last page. If value is false, calendar section is rendered exactly to EndDate, even there is an empty space on a page. More...
void	set_FitTimescaleToEndOfPage (bool value)
	Sets whether a calendar section of a view should be rendered to the end (right side) of the last page. If value is false, calendar section is rendered exactly to EndDate, even there is an empty space on a page. More...
bool	get_FitContent () const
	Gets a value indicating whether row height should be increased to fit its content. More...
void	set_FitContent (bool value)
	Sets a value indicating whether row height should be increased to fit its content. More...
const System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Aspose::Tasks::Visualization::Gridline > > > &	get_Gridlines () const
	Gets a list of Gridline that appear in project view. More...
void	set_Gridlines (const System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Aspose::Tasks::Visualization::Gridline >>> &value)
	Sets a list of Gridline that appear in project view. More...
bool	get_LegendOnEachPage ()
	Gets a value indicating whether legend should be shown on each page (Default value is TRUE). More...
void	set_LegendOnEachPage (bool value)
	Sets a value indicating whether legend should be shown on each page (Default value is TRUE). More...
Aspose::Tasks::Saving::LegendDrawingOptions	get_LegendDrawingOptions () const
	Gets a value which define how to render a legend. Default value is LegendDrawingOptions.OnEveryPage. More...
void	set_LegendDrawingOptions (Aspose::Tasks::Saving::LegendDrawingOptions value)
	Sets a value which define how to render a legend. Default value is LegendDrawingOptions.OnEveryPage. More...
bool	get_MarkCriticalTasks () const
	Gets a value indicating whether critical tasks should be displayed in red color (Default value is FALSE). More...
void	set_MarkCriticalTasks (bool value)
	Sets a value indicating whether critical tasks should be displayed in red color (Default value is FALSE). More...
System::Drawing::Color	get_NonWorkingTimeColor ()
	Gets the non-working time color. More...
void	set_NonWorkingTimeColor (System::Drawing::Color value)
	Sets the non-working time color. More...
int32_t	get_PageCount () const
	Gets the number of pages of project. More...
Aspose::Tasks::Visualization::PageSize	get_PageSize () const
	Gets the size of page to be rendered (Default value is PageSize.A4). More...
void	set_PageSize (Aspose::Tasks::Visualization::PageSize value)
	Sets the size of page to be rendered (Default value is PageSize.A4). More...
bool	get_IsPortrait () const
	Gets a value indicating whether the page orientation is portrait; returns false if the page orientation is landscape. More...
void	set_IsPortrait (bool value)
	Sets a value indicating whether the page orientation is portrait; returns false if the page orientation is landscape. More...
Aspose::Tasks::Visualization::PresentationFormat	get_PresentationFormat () const
	Gets the PresentationFormat in which the document will be saved. More...
void	set_PresentationFormat (Aspose::Tasks::Visualization::PresentationFormat value)
	Sets the PresentationFormat in which the document will be saved. More...
bool	get_RollUpGanttBars () const
	Gets a value indicating whether subtasks on the summary task bar should be marked. For subtasks, the Rollup field indicates whether information on the subtask Gantt bars will be rolled up to the summary task bar. For summary tasks, the Rollup field indicates whether the summary task bar displays rolled up bars. You must have the Rollup field for summary tasks set to Yes for any subtasks to roll up to them. More...
void	set_RollUpGanttBars (bool value)
	Sets a value indicating whether subtasks on the summary task bar should be marked. For subtasks, the Rollup field indicates whether information on the subtask Gantt bars will be rolled up to the summary task bar. For summary tasks, the Rollup field indicates whether the summary task bar displays rolled up bars. You must have the Rollup field for summary tasks set to Yes for any subtasks to roll up to them. More...
System::DateTime	get_StartDate () const
	Gets the date to start rendering from. More...
void	set_StartDate (System::DateTime value)
	Sets the date to start rendering from. More...
const System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Aspose::Tasks::Visualization::TextStyle > > > &	get_TextStyles () const
	Gets the list of the instances of the TextStyle class that appear in project view. More...
void	set_TextStyles (const System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Aspose::Tasks::Visualization::TextStyle >>> &value)
	Sets the list of the instances of the TextStyle class that appear in project view. More...
Aspose::Tasks::Visualization::Timescale	get_Timescale () const
	Gets the Timescale value which is used to control how timescale (if present) is rendered when project is saved to graphical format. More...
void	set_Timescale (Aspose::Tasks::Visualization::Timescale value)
	Sets the Timescale value which is used to control how timescale (if present) is rendered when project is saved to graphical format. More...
System::SharedPtr< Aspose::Tasks::Visualization::ProjectView >	get_View ()
	Gets a list of the view columns to render (GanttChartColumn). If not set then task ids, task names, start and finish are rendered only. If both View and ViewSettings properties are set, columns from View overrides columns from ViewSettings. More...
void	set_View (const System::SharedPtr< Aspose::Tasks::Visualization::ProjectView > &value)
	Sets a list of the view columns to render (GanttChartColumn). If not set then task ids, task names, start and finish are rendered only. If both View and ViewSettings properties are set, columns from View overrides columns from ViewSettings. More...
System::SharedPtr< Aspose::Tasks::View >	get_ViewSettings () const
	Gets a view (View) to render. You can use this options to explicitly specify which view should be saved to PDF, HTML or Image formats. If this property is set, Visualization::PresentationFormat property is ignored when project is saved. View should be from one of the following screen ((Aspose::Tasks::View::Screen)): (Gantt, TaskSheet, TaskUsage, ResourceSheet, ResourceUsage) More...
void	set_ViewSettings (const System::SharedPtr< Aspose::Tasks::View > &value)
	Sets a view (View) to render. You can use this options to explicitly specify which view should be saved to PDF, HTML or Image formats. If this property is set, Visualization::PresentationFormat property is ignored when project is saved. View should be from one of the following screen ((Aspose::Tasks::View::Screen)): (Gantt, TaskSheet, TaskUsage, ResourceSheet, ResourceUsage) More...
System::Drawing::SizeF	get_CustomPageSize () const
	Gets the custom page size in points (1 point = 1/72 of inch). More...
void	set_CustomPageSize (System::Drawing::SizeF value)
	Sets the custom page size in points (1 point = 1/72 of inch). More...
bool	get_RenderToSinglePage () const
	Gets a value indicating whether a project should be rendered to a single page when project is saved in graphical format. The page size will be changed so the rendered project can be fit on one page. More...
void	set_RenderToSinglePage (bool value)
	Sets a value indicating whether a project should be rendered to a single page when project is saved in graphical format. The page size will be changed so the rendered project can be fit on one page. More...
Public Member Functions inherited from Aspose::Tasks::Saving::SimpleSaveOptions
SaveFileFormat	get_SaveFormat () const
	Gets the format in which the document will be saved if this save options object is used. More...
const System::SharedPtr< System::Collections::Generic::IComparer< System::SharedPtr< Task > > > &	get_TasksComparer () const
	Gets the comparer to sort tasks on Gantt chart and Task Sheet chart. More...
void	set_TasksComparer (const System::SharedPtr< System::Collections::Generic::IComparer< System::SharedPtr< Task >>> &value)
	Sets the comparer to sort tasks on Gantt chart and Task Sheet chart. More...
const System::SharedPtr< Aspose::Tasks::Util::ICondition< System::SharedPtr< Task > > > &	get_TasksFilter () const
	Gets the condition which is used to filter tasks rendered on Gantt, Task Sheet and Task Usage charts. More...
void	set_TasksFilter (const System::SharedPtr< Aspose::Tasks::Util::ICondition< System::SharedPtr< Task >>> &value)
	Sets the condition which is used to filter tasks rendered on Gantt, Task Sheet and Task Usage charts. More...

Detailed Description

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

Constructor & Destructor Documentation

HtmlSaveOptions()

Aspose::Tasks::Saving::HtmlSaveOptions::HtmlSaveOptions

(

)

Initializes a new instance of the HtmlSaveOptions class.

Member Function Documentation

get_CssSavingCallback()

const System::SharedPtr<ICssSavingCallback>& Aspose::Tasks::Saving::HtmlSaveOptions::get_CssSavingCallback

(

)

const

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

get_CssStylePrefix()

System::String Aspose::Tasks::Saving::HtmlSaveOptions::get_CssStylePrefix

(

)

const

Gets CSS style prefix.

get_ExportCss()

ResourceExportType Aspose::Tasks::Saving::HtmlSaveOptions::get_ExportCss

(

)

const

Gets the way CSS are exported.

get_ExportFonts()

ResourceExportType Aspose::Tasks::Saving::HtmlSaveOptions::get_ExportFonts

(

)

const

Gets the way fonts are exported.

get_ExportImages()

ResourceExportType Aspose::Tasks::Saving::HtmlSaveOptions::get_ExportImages

(

)

const

Gets the way images are exported.

get_FontFaceTypes()

FontFaceType Aspose::Tasks::Saving::HtmlSaveOptions::get_FontFaceTypes

(

)

const

Gets the font face types.

The font face types.

get_FontSavingCallback()

const System::SharedPtr<IFontSavingCallback>& Aspose::Tasks::Saving::HtmlSaveOptions::get_FontSavingCallback

(

)

const

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

get_FontSettings()

System::SharedPtr<Aspose::Tasks::FontSettings> Aspose::Tasks::Saving::HtmlSaveOptions::get_FontSettings ( )

override

Specifies font settings used when rendering project's view.

get_ImageSavingCallback()

const System::SharedPtr<IImageSavingCallback>& Aspose::Tasks::Saving::HtmlSaveOptions::get_ImageSavingCallback

(

)

const

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

get_IncludeProjectNameInPageHeader()

bool Aspose::Tasks::Saving::HtmlSaveOptions::get_IncludeProjectNameInPageHeader

(

)

const

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

get_IncludeProjectNameInTitle()

bool Aspose::Tasks::Saving::HtmlSaveOptions::get_IncludeProjectNameInTitle

(

)

const

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

get_Pages()

System::SharedPtr<System::Collections::Generic::List<int32_t> > Aspose::Tasks::Saving::HtmlSaveOptions::get_Pages

(

)

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

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

get_PageSavingCallback()

const System::SharedPtr<IPageSavingCallback>& Aspose::Tasks::Saving::HtmlSaveOptions::get_PageSavingCallback

(

)

const

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

get_ReduceFooterGap()

bool Aspose::Tasks::Saving::HtmlSaveOptions::get_ReduceFooterGap ( )

override

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

get_UseGradientBrush()

bool Aspose::Tasks::Saving::HtmlSaveOptions::get_UseGradientBrush ( )

overridevirtual

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.

Reimplemented from Aspose::Tasks::Saving::SaveOptions.

set_CssSavingCallback()

void Aspose::Tasks::Saving::HtmlSaveOptions::set_CssSavingCallback

(

const System::SharedPtr< ICssSavingCallback > &

value

)

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

set_CssStylePrefix()

void Aspose::Tasks::Saving::HtmlSaveOptions::set_CssStylePrefix

(

const System::String &

value

)

Sets CSS style prefix.

set_ExportCss()

void Aspose::Tasks::Saving::HtmlSaveOptions::set_ExportCss

(

ResourceExportType

value

)

Sets the way CSS are exported.

set_ExportFonts()

void Aspose::Tasks::Saving::HtmlSaveOptions::set_ExportFonts

(

ResourceExportType

value

)

Sets the way fonts are exported.

set_ExportImages()

void Aspose::Tasks::Saving::HtmlSaveOptions::set_ExportImages

(

ResourceExportType

value

)

Sets the way images are exported.

set_FontFaceTypes()

void Aspose::Tasks::Saving::HtmlSaveOptions::set_FontFaceTypes

(

FontFaceType

value

)

Sets the font face types.

The font face types.

set_FontSavingCallback()

void Aspose::Tasks::Saving::HtmlSaveOptions::set_FontSavingCallback

(

const System::SharedPtr< IFontSavingCallback > &

value

)

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

set_ImageSavingCallback()

void Aspose::Tasks::Saving::HtmlSaveOptions::set_ImageSavingCallback

(

const System::SharedPtr< IImageSavingCallback > &

value

)

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

set_IncludeProjectNameInPageHeader()

void Aspose::Tasks::Saving::HtmlSaveOptions::set_IncludeProjectNameInPageHeader

(

bool

value

)

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

set_IncludeProjectNameInTitle()

void Aspose::Tasks::Saving::HtmlSaveOptions::set_IncludeProjectNameInTitle

(

bool

value

)

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

set_Pages()

void Aspose::Tasks::Saving::HtmlSaveOptions::set_Pages

(

const System::SharedPtr< System::Collections::Generic::List< int32_t >> &

value

)

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

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

set_PageSavingCallback()

void Aspose::Tasks::Saving::HtmlSaveOptions::set_PageSavingCallback

(

const System::SharedPtr< IPageSavingCallback > &

value

)

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

set_ReduceFooterGap()

void Aspose::Tasks::Saving::HtmlSaveOptions::set_ReduceFooterGap

(

bool

value

)

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

set_UseGradientBrush()

void Aspose::Tasks::Saving::HtmlSaveOptions::set_UseGradientBrush ( bool  value )

overridevirtual

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.

Reimplemented from Aspose::Tasks::Saving::SaveOptions.