|
Aspose.Tasks for C++
|
Aspose::Tasks::Saving::ImageSaveOptions Class Reference
Allows to specify additional options when rendering project pages to images. More...
#include <ImageSaveOptions.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::SharedPtr< Aspose::Tasks::FontSettings > | get_FontSettings () override |
| Specifies font settings used when rendering project's view. More... | |
| System::SharedPtr< System::Collections::Generic::List< int32_t > > | get_Pages () |
| Gets a list of page numbers to save when saving project layout to separate files. More... | |
| void | set_Pages (const System::SharedPtr< System::Collections::Generic::List< int32_t >> &value) |
| Sets a list of page numbers to save when saving project layout to separate files. More... | |
| int32_t | get_JpegQuality () const |
| Gets a JPEG quality. The allowed value range is 0..100. More... | |
| void | set_JpegQuality (int32_t value) |
| Sets a JPEG quality. The allowed value range is 0..100. 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... | |
| Aspose::Tasks::Saving::TiffCompression | get_TiffCompression () const |
| Gets the type of compression to apply when saving generated images to the TIFF format. More... | |
| void | set_TiffCompression (Aspose::Tasks::Saving::TiffCompression value) |
| Sets the type of compression to apply when saving generated images to the TIFF format. More... | |
| System::Drawing::Imaging::PixelFormat | get_PixelFormat () const |
| Gets the format of the color data for each pixel in the image. More... | |
| void | set_PixelFormat (System::Drawing::Imaging::PixelFormat value) |
| Sets the format of the color data for each pixel in the image. More... | |
| float | get_HorizontalResolution () const |
| Gets the horizontal resolution in dpi. More... | |
| void | set_HorizontalResolution (float value) |
| Sets the horizontal resolution in dpi. More... | |
| float | get_VerticalResolution () const |
| Gets the vertical resolution in dpi. More... | |
| void | set_VerticalResolution (float value) |
| Sets the vertical resolution in dpi. 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... | |
| ImageSaveOptions (SaveFileFormat saveFormat) | |
| Initializes a new instance of the ImageSaveOptions class which can be used to save rendered images in TIFF, PNG, BMP or JPEG formats. 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... | |
| 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
Allows to specify additional options when rendering project pages to images.
Constructor & Destructor Documentation
◆ ImageSaveOptions()
| Aspose::Tasks::Saving::ImageSaveOptions::ImageSaveOptions | ( | SaveFileFormat | saveFormat | ) |
Initializes a new instance of the ImageSaveOptions class which can be used to save rendered images in TIFF, PNG, BMP or JPEG formats.
- Parameters
-
saveFormat Can be TIFF, PNG, BMP or JPEGSaveFileFormat.
- Exceptions
-
ArgumentException Thrown of saveFormat is not a valid image format. The valid values are TIFF, PNG, BMP or JPEG.
Member Function Documentation
◆ get_FontSettings()
|
override |
Specifies font settings used when rendering project's view.
◆ get_HorizontalResolution()
| float Aspose::Tasks::Saving::ImageSaveOptions::get_HorizontalResolution | ( | ) | const |
Gets the horizontal resolution in dpi.
◆ get_JpegQuality()
| int32_t Aspose::Tasks::Saving::ImageSaveOptions::get_JpegQuality | ( | ) | const |
Gets a JPEG quality. The allowed value range is 0..100.
◆ get_Pages()
| System::SharedPtr<System::Collections::Generic::List<int32_t> > Aspose::Tasks::Saving::ImageSaveOptions::get_Pages | ( | ) |
Gets a list of page numbers to save when saving project layout to separate files.
All pages will be saved if this list is empty.
◆ get_PageSavingCallback()
| const System::SharedPtr<IPageSavingCallback>& Aspose::Tasks::Saving::ImageSaveOptions::get_PageSavingCallback | ( | ) | const |
Gets a user-defined callback which is used to get an output stream for each rendered page.
◆ get_PixelFormat()
| System::Drawing::Imaging::PixelFormat Aspose::Tasks::Saving::ImageSaveOptions::get_PixelFormat | ( | ) | const |
Gets the format of the color data for each pixel in the image.
◆ get_ReduceFooterGap()
|
override |
Gets a value indicating whether a gap between last task and the footer must be reduced.
◆ get_TiffCompression()
| Aspose::Tasks::Saving::TiffCompression Aspose::Tasks::Saving::ImageSaveOptions::get_TiffCompression | ( | ) | const |
Gets the type of compression to apply when saving generated images to the TIFF format.
Has effect only when saving to TIFF. The default value is LZW.
◆ get_VerticalResolution()
| float Aspose::Tasks::Saving::ImageSaveOptions::get_VerticalResolution | ( | ) | const |
Gets the vertical resolution in dpi.
◆ set_HorizontalResolution()
| void Aspose::Tasks::Saving::ImageSaveOptions::set_HorizontalResolution | ( | float | value | ) |
Sets the horizontal resolution in dpi.
◆ set_JpegQuality()
| void Aspose::Tasks::Saving::ImageSaveOptions::set_JpegQuality | ( | int32_t | value | ) |
Sets a JPEG quality. The allowed value range is 0..100.
◆ set_Pages()
| void Aspose::Tasks::Saving::ImageSaveOptions::set_Pages | ( | const System::SharedPtr< System::Collections::Generic::List< int32_t >> & | value | ) |
Sets a list of page numbers to save when saving project layout to separate files.
All pages will be saved if this list is empty.
◆ set_PageSavingCallback()
| void Aspose::Tasks::Saving::ImageSaveOptions::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_PixelFormat()
| void Aspose::Tasks::Saving::ImageSaveOptions::set_PixelFormat | ( | System::Drawing::Imaging::PixelFormat | value | ) |
Sets the format of the color data for each pixel in the image.
◆ set_ReduceFooterGap()
| void Aspose::Tasks::Saving::ImageSaveOptions::set_ReduceFooterGap | ( | bool | value | ) |
Sets a value indicating whether a gap between last task and the footer must be reduced.
◆ set_TiffCompression()
| void Aspose::Tasks::Saving::ImageSaveOptions::set_TiffCompression | ( | Aspose::Tasks::Saving::TiffCompression | value | ) |
Sets the type of compression to apply when saving generated images to the TIFF format.
Has effect only when saving to TIFF. The default value is LZW.
◆ set_VerticalResolution()
| void Aspose::Tasks::Saving::ImageSaveOptions::set_VerticalResolution | ( | float | value | ) |
Sets the vertical resolution in dpi.