ImageSaveOptions

ImageSaveOptions class

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

The ImageSaveOptions type exposes the following members:

Constructors

NameDescription
ImageSaveOptions(save_format)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
save_format
bar_stylesGets or sets the list of the instances of the BarStyle class that appear in project view.
draw_non_working_timeGets or sets a value indicating whether non-working time should be drawn (Default value is TRUE).
end_dateGets or sets a date to finish rendering to.
fit_timescale_to_end_of_pageGets or 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.
fit_contentGets or sets a value indicating whether row height should be increased to fit its content.
gridlinesGets or sets a list of Gridline that appear in project view.
legend_on_each_pageGets or sets a value indicating whether legend should be shown on each page (Default value is TRUE).
legend_drawing_optionsGets or sets a value which define how to render a legend. Default value is LegendDrawingOptions.OnEveryPage.
mark_critical_tasksGets or sets a value indicating whether critical tasks should be displayed in red color (Default value is FALSE).
non_working_time_colorGets or sets the non-working time color.
page_countGets or sets the number of pages of project.
page_sizeGets or sets the size of page to be rendered (Default value is PageSize.A4).
is_portraitGets or sets a value indicating whether the page orientation is portrait; returns false if the page orientation is landscape.
presentation_formatGets or sets the presentation_format in which the document will be saved.
roll_up_gantt_barsGets 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.
start_dateGets or sets the date to start rendering from.
text_stylesGets or sets the list of the instances of the TextStyle class that appear in project view.
timescaleGets or sets the timescale value which is used to control how timescale (if present) is rendered when project is saved to graphical format.
use_gradient_brushGets or sets a value indicating whether gradient brush should be used when rendering Gantt Chart.
viewGets 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 view_settings properties are set, columns from View overrides columns from ViewSettings.
view_settingsGets 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)
custom_page_sizeGets or sets the custom page size in points (1 point = 1/72 of inch).
render_to_single_pageGets 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.
font_settingsSpecifies font settings used when rendering project’s view.
pagesGets or sets a list of page numbers to save when saving project layout to separate files.
jpeg_qualityGets or sets a JPEG quality. The allowed value range is 0..100.
reduce_footer_gapGets or sets a value indicating whether a gap between last task and the footer must be reduced.
tiff_compressionGets or sets the type of compression to apply when saving generated images to the TIFF format.
pixel_formatGets or sets the format of the color data for each pixel in the image.
horizontal_resolutionGets or sets the horizontal resolution in dpi.
vertical_resolutionGets or sets the vertical resolution in dpi.
page_saving_callbackGets or sets a user-defined callback which is used to get an output stream for each rendered page.

See Also