PdfSaveOptions class

PdfSaveOptions class

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

Inheritance: PdfSaveOptionsRenderingSaveOptionsSaveOptions

The PdfSaveOptions type exposes the following members:

Constructors

ConstructorDescription
PdfSaveOptions()Initializes a new instance of this class that can be used to save a document in the 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 only.
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.
page_countGets or sets the number of pages to render in PDF.
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.
save_foreground_pages_onlySpecifies whether all pages will be saved in image or only foreground.
complianceDesired conformance level for generated PDF document.
Default is PdfCompliance.PDF15.
encryption_detailsGets or sets a encryption details. If not set, then no encryption will be performed.
page_saving_callbackControl/Indicate progress of page saving process.
jpeg_qualitySpecifies the quality of JPEG compression for images (if JPEG compression is used).
Default is 95.
horizontal_resolutionGets or sets the horizontal resolution for generated images, in dots per inch.
Applies generating image method except Emf format images.
vertical_resolutionGets or sets the vertical resolution for generated images, in dots per inch.
Applies generating image method except Emf format image.
split_multi_pagesDefines whether split diagram to multi pages according to page’s setting.
export_hidden_pageDefines whether need exporting the hidden page or not.
text_compressionSpecifies compression type to be used for all content streams except images.
Default is PdfTextCompression.FLATE.
digital_signature_detailsGets or sets a digital signature details. If not set, then no signing will be performed.

Methods

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

See Also