[]
        
(Showing Draft Content)

GrapeCity.Documents.Pdf.SaveAsImageOptions

SaveAsImageOptions Class

Represents options used by the SaveAs* methods on GcPdfDocument and Page, such as SaveAsJpeg(string, OutputRange, SaveAsImageOptions), SaveAsJpeg(Stream, SaveAsImageOptions), etc.

Inheritance
SaveAsImageOptions
Namespace: GrapeCity.Documents.Pdf
Assembly: DS.Documents.Pdf.dll
Syntax
public class SaveAsImageOptions
Public Class SaveAsImageOptions

Constructors

Name Description
SaveAsImageOptions()

Properties

Name Description
AllowFontSbits

Gets or sets a value indicating whether bitmaps embedded in an OpenType font should be rendered.

The default is true.

This property is ignored if either UseRenderingCache or UseGlyphBitmapCache is false.

BackColor

Gets or sets the background color. The default is white.

CancellationToken

Gets or sets the CancellationToken object. Allows canceling the execution of GcPdfDocument.SaveAsXXX() methods, see CancellationToken.

DrawAnnotationFilter

Gets or sets a callback method that will be used to decide which annotations to draw.

DrawAnnotations

Gets or sets a value indicating whether to draw annotations. The default is true. See also DrawAnnotationFilter.

DrawFormFields

Gets or sets a value indicating whether to render form fields. The default is true.

DrawSvgTextAsPath

Gets or sets a value indicating whether SVG text elements should be rendered as graphic paths.

The default is true.

This property is ignored when rendering to formats other than SVG.

EmbedSvgFonts

Gets or sets a value indicating whether fonts used in the SVG text elements should be embedded.

The default is false.

This property is ignored when rendering to formats other than SVG or if DrawSvgTextAsPath is true.

EnableFontHinting

Gets or sets a value indicating whether font hinting should be enabled for TrueType fonts. The property is now obsolete and always gets true.

IgnoreErrors

Gets or sets a value indicating whether to ignore errors in PDF content stream if possible.

The default is true.

InterpolationMode

Gets or sets the sampling mode to use when drawing images with resizing. Default is Downscale.

PreciseCharPositions

Gets or sets a value indicating whether the positions are set for each individual character within the SVG text element.

Setting this property to false makes the resulting SVG file smaller but provides less precise positioning of individual characters.

The default is true.

This property is ignored when rendering to formats other than SVG or if DrawSvgTextAsPath is true.

Print

Gets or sets a value indicating whether the image is generated for printing. The visibility of PDF elements may depend on the output target, they can be visible in a preview but hidden when printed, and vice versa.

This property is now obsolete. All methods accepting SaveAsImageOptions as a parameter also now accept a ViewState object. Its properties should be used instead.

Resolution

Gets or sets the resolution of the generated images. The default is 96.

UseGlyphBitmapCache

Gets or sets a value indicating whether glyphs are cached as bitmaps rather than as glyph paths.

The default is true.

This property is ignored if UseRenderingCache is false.

UseRenderingCache

Gets or sets a value indicating whether to use rendering cache.

This property is true by default. Setting this property to false reduces memory consumption, at the cost of slower rendering speed.

Zoom

Gets or sets the zoom factor. The default is 1.

See Also