ImageSaveOptions Class

Allows to specify additional options when rendering project pages to images.
Inheritance Hierarchy

Namespace:  Aspose.Tasks.Saving
Assembly:  Aspose.Tasks (in Aspose.Tasks.dll) Version: 20.11
Syntax
public class ImageSaveOptions : SaveOptions

The ImageSaveOptions type exposes the following members.

Constructors
  NameDescription
Public methodCode exampleImageSaveOptions
Initializes a new instance of the ImageSaveOptions class which can be used to save rendered images in TIFF, PNG, BMP or JPEG formats.
Properties
  NameDescription
Public propertyCode exampleBarStyles
Gets or sets the list of the instances of the BarStyle class that appear in project view.
(Inherited from SaveOptions.)
Public propertyCode exampleDefaultFontName
Gets or sets the default font for rendering.
Public propertyCode exampleDrawNonWorkingTime
Gets or sets a value indicating whether non-working time should be drawn (Default value is TRUE).
(Inherited from SaveOptions.)
Public propertyCode exampleEndDate
Gets or sets a date to finish rendering to.
(Inherited from SaveOptions.)
Public propertyCode exampleFitContent
Gets or sets a value indicating whether row height should be increased to fit its content.
(Inherited from SaveOptions.)
Public propertyCode exampleGridlines
Gets or sets a list of Gridline that appear in project view.
(Inherited from SaveOptions.)
Public propertyCode exampleHorizontalResolution
Gets or sets the horizontal resolution in dpi.
Public propertyCode exampleJpegQuality
Gets or sets a JPEG quality.
Public propertyCode exampleLegendOnEachPage
Gets or sets a value indicating whether legend should be shown on each page (Default value is TRUE).
(Inherited from SaveOptions.)
Public propertyCode exampleMarkCriticalTasks
Gets or sets a value indicating whether critical tasks should be displayed in red color (Default value is FALSE).
(Inherited from SaveOptions.)
Public propertyCode exampleNonWorkingTimeColor
Gets or sets the non-working time color.
(Inherited from SaveOptions.)
Public propertyCode examplePageCount
Gets or sets the number of pages of project.
(Inherited from SaveOptions.)
Public propertyCode examplePages
Gets or sets a list of page numbers to save when saving project layout to separate files.
Remarks
All pages will be saved if this list is empty.
Public propertyPageSavingCallback
Gets or sets a user-defined callback which is used to get an output stream for each rendered page. Is applicable when SaveToSeparateFiles option is used.
Public propertyCode examplePageSize
Gets or sets the size of page to be rendered (Default value is PageSize.A4).
(Inherited from SaveOptions.)
Public propertyCode examplePixelFormat
Gets or sets the format of the color data for each pixel in the image.
Public propertyCode examplePresentationFormat
Gets or sets the PresentationFormat in which the document will be saved.
(Inherited from SaveOptions.)
Public propertyCode exampleReduceFooterGap
Gets or sets a value indicating whether a gap between last task and the footer must be reduced.
Public propertyCode exampleRollUpGanttBars
Gets or 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.
(Inherited from SaveOptions.)
Public propertyCode exampleSaveFormat
Gets or sets the format in which the document will be saved if this save options object is used.
(Inherited from SaveOptions.)
Public propertyCode exampleSaveToSeparateFiles
Gets or sets a value indicating whether to save project pages to separate files.
Public propertyCode exampleStartDate
Gets or sets the date to start rendering from.
(Inherited from SaveOptions.)
Public propertyCode exampleTasksComparer
Gets or sets the comparer to sort tasks on Gantt chart and Task Sheet chart.
(Inherited from SaveOptions.)
Public propertyCode exampleTasksFilter
Gets or sets the condition which is used to filter tasks rendered on Gantt, Task Sheet and Task Usage charts.
(Inherited from SaveOptions.)
Public propertyCode exampleTextStyles
Gets or sets the list of the instances of the TextStyle class that appear in project view.
(Inherited from SaveOptions.)
Public propertyCode exampleTiffCompression
Gets or sets the type of compression to apply when saving generated images to the TIFF format.
Public propertyCode exampleTimescale
Gets or sets the Timescale value which is used to control how timescale (if present) is rendered when project is saved to graphical format.
(Inherited from SaveOptions.)
Public propertyCode exampleTimescaleTier Obsolete.
Gets or sets the timescale tier of the Gantt Chart view. The default value is null.
(Inherited from SaveOptions.)
Public propertyCode exampleUseGradientBrush
Gets or sets a value indicating whether gradient brush should be used when rendering Gantt Chart.
(Inherited from SaveOptions.)
Public propertyCode exampleUseProjectDefaultFont
Gets or sets a value indicating whether the default font must be used for rendering.
Public propertyCode exampleVerticalResolution
Gets or sets the vertical resolution in dpi.
Public propertyCode exampleView
Gets or sets a list of the view columns to render (GanttChartColumn). If not set then task ids, task names, start and finish are rendered only.
(Inherited from SaveOptions.)
Methods
  NameDescription
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodToString (Inherited from Object.)
Examples
Shows how to save project into a stream as an image.
var project = new Project();

using (var stream = new FileStream(OutDir + "EmptyProjectSaveStream_out.xml", FileMode.Create, FileAccess.Write))
{
    var options = new ImageSaveOptions(SaveFileFormat.PNG);

    // by using of ImageSaveOptions we save the project into image format
    project.Save(stream, options);
}
See Also