This is an abstract base class for classes that allow the user to specify additional options when saving a project into a particular format. More...

#include <SaveOptions.h>

Inherits Aspose::Tasks::Saving::SimpleSaveOptions.

Inherited by Aspose::Tasks::Saving::HtmlSaveOptions, Aspose::Tasks::Saving::ImageSaveOptions, Aspose::Tasks::Saving::PdfSaveOptions, Aspose::Tasks::Saving::SvgOptions, Aspose::Tasks::Saving::XamlOptions, and Aspose::Tasks::Saving::XpsOptions.

Public Member Functions
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...

virtual bool	get_UseGradientBrush ()
	Gets a value indicating whether gradient brush should be used when rendering Gantt Chart. More...

virtual void	set_UseGradientBrush (bool value)
	Sets a value indicating whether gradient brush should be used when rendering Gantt Chart. 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

This is an abstract base class for classes that allow the user to specify additional options when saving a project into a particular format.

An instance of any derived class from SaveOptions class is passed to the stream Save or string Save overloads for the user to define custom options when saving a document.

Member Function Documentation

◆ get_BarStyles()

const System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Aspose::Tasks::Visualization::BarStyle> > >& Aspose::Tasks::Saving::SaveOptions::get_BarStyles ( ) const

Gets the list of the instances of the BarStyle class that appear in project view.

◆ get_CustomPageSize()

System::Drawing::SizeF Aspose::Tasks::Saving::SaveOptions::get_CustomPageSize ( ) const

Gets the custom page size in points (1 point = 1/72 of inch).

◆ get_DrawNonWorkingTime()

bool Aspose::Tasks::Saving::SaveOptions::get_DrawNonWorkingTime ( ) const

Gets a value indicating whether non-working time should be drawn (Default value is TRUE).

◆ get_EndDate()

System::DateTime Aspose::Tasks::Saving::SaveOptions::get_EndDate ( ) const

Gets a date to finish rendering to.

◆ get_FitContent()

bool Aspose::Tasks::Saving::SaveOptions::get_FitContent ( ) const

Gets a value indicating whether row height should be increased to fit its content.

◆ get_FitTimescaleToEndOfPage()

bool Aspose::Tasks::Saving::SaveOptions::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.

◆ get_Gridlines()

const System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Aspose::Tasks::Visualization::Gridline> > >& Aspose::Tasks::Saving::SaveOptions::get_Gridlines ( ) const

Gets a list of Gridline that appear in project view.

◆ get_IsPortrait()

bool Aspose::Tasks::Saving::SaveOptions::get_IsPortrait ( ) const

Gets a value indicating whether the page orientation is portrait; returns false if the page orientation is landscape.

Is not applicable when SaveOptions.PageSize == Visualization.PageSize.DefinedInView. In this case View.PageInfo.PageSettings.IsPortrait is used instead. Is not applicable when SaveOptions.CustomPageSize is set.

◆ get_LegendDrawingOptions()

Aspose::Tasks::Saving::LegendDrawingOptions Aspose::Tasks::Saving::SaveOptions::get_LegendDrawingOptions ( ) const

Gets a value which define how to render a legend. Default value is LegendDrawingOptions.OnEveryPage.

◆ get_LegendOnEachPage()

bool Aspose::Tasks::Saving::SaveOptions::get_LegendOnEachPage ( )

Gets a value indicating whether legend should be shown on each page (Default value is TRUE).

◆ get_MarkCriticalTasks()

bool Aspose::Tasks::Saving::SaveOptions::get_MarkCriticalTasks ( ) const

Gets a value indicating whether critical tasks should be displayed in red color (Default value is FALSE).

◆ get_NonWorkingTimeColor()

System::Drawing::Color Aspose::Tasks::Saving::SaveOptions::get_NonWorkingTimeColor ( )

Gets the non-working time color.

◆ get_PageCount()

int32_t Aspose::Tasks::Saving::SaveOptions::get_PageCount ( ) const

Gets the number of pages of project.

◆ get_PageSize()

Aspose::Tasks::Visualization::PageSize Aspose::Tasks::Saving::SaveOptions::get_PageSize ( ) const

Gets the size of page to be rendered (Default value is PageSize.A4).

◆ get_PresentationFormat()

Aspose::Tasks::Visualization::PresentationFormat Aspose::Tasks::Saving::SaveOptions::get_PresentationFormat ( ) const

Gets the PresentationFormat in which the document will be saved.

◆ get_RenderToSinglePage()

bool Aspose::Tasks::Saving::SaveOptions::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.

◆ get_RollUpGanttBars()

bool Aspose::Tasks::Saving::SaveOptions::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.

Is only applicable when Gantt chart view is rendered.

◆ get_StartDate()

System::DateTime Aspose::Tasks::Saving::SaveOptions::get_StartDate ( ) const

Gets the date to start rendering from.

◆ get_TextStyles()

const System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Aspose::Tasks::Visualization::TextStyle> > >& Aspose::Tasks::Saving::SaveOptions::get_TextStyles ( ) const

Gets the list of the instances of the TextStyle class that appear in project view.

◆ get_Timescale()

Aspose::Tasks::Visualization::Timescale Aspose::Tasks::Saving::SaveOptions::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.

◆ get_UseGradientBrush()

virtual bool Aspose::Tasks::Saving::SaveOptions::get_UseGradientBrush ( )

virtual

Gets a value indicating whether gradient brush should be used when rendering Gantt Chart.

Is only applicable when Gantt chart view is rendered.

Reimplemented in Aspose::Tasks::Saving::SvgOptions, and Aspose::Tasks::Saving::HtmlSaveOptions.

◆ get_View()

System::SharedPtr<Aspose::Tasks::Visualization::ProjectView> Aspose::Tasks::Saving::SaveOptions::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.

◆ get_ViewSettings()

System::SharedPtr<Aspose::Tasks::View> Aspose::Tasks::Saving::SaveOptions::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)

Exceptions

ArgumentException When set method is called and instance of View class with not supported value of Screen property is provided.

◆ set_BarStyles()

void Aspose::Tasks::Saving::SaveOptions::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.

◆ set_CustomPageSize()

void Aspose::Tasks::Saving::SaveOptions::set_CustomPageSize ( System::Drawing::SizeF value )

Sets the custom page size in points (1 point = 1/72 of inch).

◆ set_DrawNonWorkingTime()

void Aspose::Tasks::Saving::SaveOptions::set_DrawNonWorkingTime ( bool value )

Sets a value indicating whether non-working time should be drawn (Default value is TRUE).

◆ set_EndDate()

void Aspose::Tasks::Saving::SaveOptions::set_EndDate ( System::DateTime value )

Sets a date to finish rendering to.

◆ set_FitContent()

void Aspose::Tasks::Saving::SaveOptions::set_FitContent ( bool value )

Sets a value indicating whether row height should be increased to fit its content.

◆ set_FitTimescaleToEndOfPage()

void Aspose::Tasks::Saving::SaveOptions::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.

◆ set_Gridlines()

void Aspose::Tasks::Saving::SaveOptions::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.

◆ set_IsPortrait()

void Aspose::Tasks::Saving::SaveOptions::set_IsPortrait ( bool value )

Sets a value indicating whether the page orientation is portrait; returns false if the page orientation is landscape.

Is not applicable when SaveOptions.PageSize == Visualization.PageSize.DefinedInView. In this case View.PageInfo.PageSettings.IsPortrait is used instead. Is not applicable when SaveOptions.CustomPageSize is set.

◆ set_LegendDrawingOptions()

void Aspose::Tasks::Saving::SaveOptions::set_LegendDrawingOptions ( Aspose::Tasks::Saving::LegendDrawingOptions value )

Sets a value which define how to render a legend. Default value is LegendDrawingOptions.OnEveryPage.

◆ set_LegendOnEachPage()

void Aspose::Tasks::Saving::SaveOptions::set_LegendOnEachPage ( bool value )

Sets a value indicating whether legend should be shown on each page (Default value is TRUE).

◆ set_MarkCriticalTasks()

void Aspose::Tasks::Saving::SaveOptions::set_MarkCriticalTasks ( bool value )

Sets a value indicating whether critical tasks should be displayed in red color (Default value is FALSE).

◆ set_NonWorkingTimeColor()

void Aspose::Tasks::Saving::SaveOptions::set_NonWorkingTimeColor ( System::Drawing::Color value )

Sets the non-working time color.

◆ set_PageSize()

void Aspose::Tasks::Saving::SaveOptions::set_PageSize ( Aspose::Tasks::Visualization::PageSize value )

Sets the size of page to be rendered (Default value is PageSize.A4).

◆ set_PresentationFormat()

void Aspose::Tasks::Saving::SaveOptions::set_PresentationFormat ( Aspose::Tasks::Visualization::PresentationFormat value )

Sets the PresentationFormat in which the document will be saved.

◆ set_RenderToSinglePage()

void Aspose::Tasks::Saving::SaveOptions::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.

◆ set_RollUpGanttBars()

void Aspose::Tasks::Saving::SaveOptions::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.

Is only applicable when Gantt chart view is rendered.

◆ set_StartDate()

void Aspose::Tasks::Saving::SaveOptions::set_StartDate ( System::DateTime value )

Sets the date to start rendering from.

◆ set_TextStyles()

void Aspose::Tasks::Saving::SaveOptions::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.

◆ set_Timescale()

void Aspose::Tasks::Saving::SaveOptions::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.

◆ set_UseGradientBrush()

virtual void Aspose::Tasks::Saving::SaveOptions::set_UseGradientBrush ( bool value )

virtual

Sets a value indicating whether gradient brush should be used when rendering Gantt Chart.

Is only applicable when Gantt chart view is rendered.

Reimplemented in Aspose::Tasks::Saving::SvgOptions, and Aspose::Tasks::Saving::HtmlSaveOptions.

◆ set_View()

void Aspose::Tasks::Saving::SaveOptions::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.

◆ set_ViewSettings()

void Aspose::Tasks::Saving::SaveOptions::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)

Exceptions

ArgumentException When set method is called and instance of View class with not supported value of Screen property is provided.

Public Member Functions

Detailed Description

Member Function Documentation

◆ get_BarStyles()

◆ get_CustomPageSize()

◆ get_DrawNonWorkingTime()

◆ get_EndDate()

◆ get_FitContent()

◆ get_FitTimescaleToEndOfPage()

◆ get_Gridlines()

◆ get_IsPortrait()

◆ get_LegendDrawingOptions()

◆ get_LegendOnEachPage()

◆ get_MarkCriticalTasks()

◆ get_NonWorkingTimeColor()

◆ get_PageCount()

◆ get_PageSize()

◆ get_PresentationFormat()

◆ get_RenderToSinglePage()

◆ get_RollUpGanttBars()

◆ get_StartDate()

◆ get_TextStyles()

◆ get_Timescale()

◆ get_UseGradientBrush()

◆ get_View()

◆ get_ViewSettings()

◆ set_BarStyles()

◆ set_CustomPageSize()

◆ set_DrawNonWorkingTime()

◆ set_EndDate()

◆ set_FitContent()

◆ set_FitTimescaleToEndOfPage()

◆ set_Gridlines()

◆ set_IsPortrait()

◆ set_LegendDrawingOptions()

◆ set_LegendOnEachPage()

◆ set_MarkCriticalTasks()

◆ set_NonWorkingTimeColor()

◆ set_PageSize()

◆ set_PresentationFormat()

◆ set_RenderToSinglePage()

◆ set_RollUpGanttBars()

◆ set_StartDate()

◆ set_TextStyles()

◆ set_Timescale()

◆ set_UseGradientBrush()

◆ set_View()

◆ set_ViewSettings()