ImageSaveOptions

ImageSaveOptions class

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

public class ImageSaveOptions : SaveOptions

Constructors

Name Description
ImageSaveOptions(SaveFileFormat) Initializes a new instance of the ImageSaveOptions class which can be used to save rendered images in TIFF, PNG, BMP or JPEG formats.

Properties

Name Description
BarStyles { get; set; } Gets or sets the list of the instances of the BarStyle class that appear in project view.
CustomPageSize { get; set; } Gets or sets the custom page size in points (1 point = 1/72 of inch).
DefaultFontName { get; set; } Gets or sets the default font for rendering.
DrawNonWorkingTime { get; set; } Gets or sets a value indicating whether non-working time should be drawn (Default value is TRUE).
EndDate { get; set; } Gets or sets a date to finish rendering to.
FitContent { get; set; } Gets or sets a value indicating whether row height should be increased to fit its content.
FontResolveCallback { get; set; } Gets or sets a callback which can be used to customize resolved fonts.
Gridlines { get; set; } Gets or sets a list of Gridline that appear in project view.
HorizontalResolution { get; set; } Gets or sets the horizontal resolution in dpi.
JpegQuality { get; set; } Gets or sets a JPEG quality. The allowed value range is 0..100.
LegendOnEachPage { get; set; } Gets or sets a value indicating whether legend should be shown on each page (Default value is TRUE).
MarkCriticalTasks { get; set; } Gets or sets a value indicating whether critical tasks should be displayed in red color (Default value is FALSE).
NonWorkingTimeColor { get; set; } Gets or sets the non-working time color.
PageCount { get; } Gets or sets the number of pages of project.
Pages { get; set; } Gets or 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.
PageSavingCallback { get; set; } Gets or sets a user-defined callback which is used to get an output stream for each rendered page.
PageSize { get; set; } Gets or sets the size of page to be rendered (Default value is PageSize.A4).
PixelFormat { get; set; } Gets or sets the format of the color data for each pixel in the image.
PresentationFormat { get; set; } Gets or sets the PresentationFormat in which the document will be saved.
ReduceFooterGap { get; set; } Gets or sets a value indicating whether a gap between last task and the footer must be reduced.
RenderToSinglePage { get; set; } Gets or 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.
RollUpGanttBars { get; set; } 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.
SaveFormat { get; } Gets or sets the format in which the document will be saved if this save options object is used.
StartDate { get; set; } Gets or sets the date to start rendering from.
TasksComparer { get; set; } Gets or sets the comparer to sort tasks on Gantt chart and Task Sheet chart.
TasksFilter { get; set; } Gets or sets the condition which is used to filter tasks rendered on Gantt, Task Sheet and Task Usage charts.
TextStyles { get; set; } Gets or sets the list of the instances of the TextStyle class that appear in project view.
TiffCompression { get; set; } Gets or sets the type of compression to apply when saving generated images to the TIFF format.
Timescale { get; set; } Gets or sets the Timescale value which is used to control how timescale (if present) is rendered when project is saved to graphical format.
virtual UseGradientBrush { get; set; } Gets or sets a value indicating whether gradient brush should be used when rendering Gantt Chart.
UseProjectDefaultFont { get; set; } Gets or sets a value indicating whether the default font must be used for rendering.
VerticalResolution { get; set; } Gets or sets the vertical resolution in dpi.
View { get; set; } 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. If both View and ViewSettings properties are set, columns from View overrides columns from ViewSettings.
ViewSettings { get; set; } Gets or 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, PresentationFormat property is ignored when project is saved. View should be from one of the following screen ((Screen)): (Gantt, TaskSheet, TaskUsage, ResourceSheet, ResourceUsage)

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