ImageSaveOptions class

ImageSaveOptions class

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

Inheritance: ImageSaveOptionsRenderingSaveOptionsSaveOptions

The ImageSaveOptions type exposes the following members:

Constructors

ConstructorDescription
ImageSaveOptions(save_format)Initializes a new instance of this class that can be used to save rendered images in the SaveFileFormat,
SaveFileFormat, SaveFileFormat, SaveFileFormat
or SaveFileFormat format.

Properties

PropertyDescription
save_formatSpecifies the format in which the rendered diagram pages will be saved if this save options object is used.
Can be SaveFileFormat, SaveFileFormat,
SaveFileFormat, SaveFileFormat or SaveFileFormat.
default_fontWhen characters in the diagram are unicode and not be set with correct font value or the font is not installed locally,
they may appear as block in pdf, image or XPS.
Set the DefaultFont such as MingLiu or MS Gothic to show these characters.
warning_callbackGets or sets warning callback.
page_sizeGets or sets the page size for the generated images.
Can be PageSize or null.
shapesGets or sets shapes to render. Default count is 0.
areaGets or sets the area of the shapes will be saved .
export_guide_shapesDefines whether need exporting the guide shapes or not.
is_export_commentsDefines whether need exporting the comments or not.
enlarge_pageSpecifies whether enlarge page .
emf_render_settingSetting for rendering Emf metafile.
image_brightnessGets or sets the brightness for the the generated images.
image_color_modeGets or sets the color mode for the generated images.
image_contrastGets or sets the contrast for the generated images.
jpeg_qualityGets or sets a value determining the quality of the generated JPEG images.
page_countGets or sets the number of pages to render when saving to a multipage TIFF file.
Default is MaxValue which means all pages of the diagram will be rendered.
page_indexGets or sets the 0-based index of the first page to render. Default is 0.
export_hidden_pageDefines whether need exporting the hidden page or not.
resolutionGets or sets the resolution for the generated images, in dots per inch.
scaleGets or sets the zoom factor for the generated images.
content_zoomThis parameter is similar with scale, but not effect the generated image size.
tiff_compressionGets or sets the type of compression to apply when saving generated images to the TIFF format.
save_foreground_pages_onlySpecifies whether all pages will be saved in image or only foreground.
same_as_pdf_conversion_areaSpecifies whether saving area same as pdf .
pixel_offset_modeGets or set a value specifying how pixels are offset during rendering.
smoothing_modeSpecifies whether smoothing (antialiasing) is applied to lines and curves and the edges of filled areas.
compositing_qualitySpecifies the quality level to use during compositing.
interpolation_modeSpecifies the algorithm that is used when images are scaled or rotated.

Methods

MethodDescription
create_save_options(save_format)Creates a save options object of a class suitable for the specified save format.

See Also