ImageSaveOptions class
ImageSaveOptions class
Allows to specify additional options when rendering diagram pages to images.
Inheritance: ImageSaveOptions → RenderingSaveOptions → SaveOptions
The ImageSaveOptions type exposes the following members:
Constructors
| Constructor | Description |
|---|---|
| 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
| Property | Description |
|---|---|
| save_format | Specifies 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_font | When 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_callback | Gets or sets warning callback. |
| page_size | Gets or sets the page size for the generated images.
Can be PageSize or null. |
| shapes | Gets or sets shapes to render. Default count is 0. |
| area | Gets or sets the area of the shapes will be saved . |
| export_guide_shapes | Defines whether need exporting the guide shapes or not. |
| is_export_comments | Defines whether need exporting the comments or not. |
| enlarge_page | Specifies whether enlarge page . |
| emf_render_setting | Setting for rendering Emf metafile. |
| image_brightness | Gets or sets the brightness for the the generated images. |
| image_color_mode | Gets or sets the color mode for the generated images. |
| image_contrast | Gets or sets the contrast for the generated images. |
| jpeg_quality | Gets or sets a value determining the quality of the generated JPEG images. |
| page_count | Gets 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_index | Gets or sets the 0-based index of the first page to render. Default is 0. |
| export_hidden_page | Defines whether need exporting the hidden page or not. |
| resolution | Gets or sets the resolution for the generated images, in dots per inch. |
| scale | Gets or sets the zoom factor for the generated images. |
| content_zoom | This parameter is similar with scale, but not effect the generated image size. |
| tiff_compression | Gets or sets the type of compression to apply when saving generated images to the TIFF format. |
| save_foreground_pages_only | Specifies whether all pages will be saved in image or only foreground. |
| same_as_pdf_conversion_area | Specifies whether saving area same as pdf . |
| pixel_offset_mode | Gets or set a value specifying how pixels are offset during rendering. |
| smoothing_mode | Specifies whether smoothing (antialiasing) is applied to lines and curves and the edges of filled areas. |
| compositing_quality | Specifies the quality level to use during compositing. |
| interpolation_mode | Specifies the algorithm that is used when images are scaled or rotated. |
Methods
| Method | Description |
|---|---|
| create_save_options(save_format) | Creates a save options object of a class suitable for the specified save format. |
See Also
- module aspose.diagram.saving
- class RenderingSaveOptions