[]
        
(Showing Draft Content)

GrapeCity.Documents.Pdf.SaveAsImageOptions

Class SaveAsImageOptions

Namespace
GrapeCity.Documents.Pdf
Assembly
GcDocs.Pdf.dll

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

public class SaveAsImageOptions
Inheritance
object
SaveAsImageOptions
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()

Constructors

SaveAsImageOptions()

public SaveAsImageOptions()
See Also

Properties

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.

public bool AllowFontSbits { get; set; }

Property Value

bool
See Also

BackColor

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

public Color BackColor { get; set; }

Property Value

System.Drawing.Color
See Also

CancellationToken

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

public CancellationToken CancellationToken { get; set; }

Property Value

System.Threading.CancellationToken
See Also

DrawAnnotations

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

public bool DrawAnnotations { get; set; }

Property Value

bool
See Also

DrawFormFields

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

public bool DrawFormFields { get; set; }

Property Value

bool
See Also

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.

public bool DrawSvgTextAsPath { get; set; }

Property Value

bool
See Also

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.

public bool EmbedSvgFonts { get; set; }

Property Value

bool
See Also

EnableFontHinting

Gets or sets a value indicating whether font hinting should be enabled for TrueType fonts.

The default is true.

public bool EnableFontHinting { get; set; }

Property Value

bool
See Also

IgnoreErrors

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

The default is true.

public bool IgnoreErrors { get; set; }

Property Value

bool
See Also

InterpolationMode

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

public InterpolationMode InterpolationMode { get; set; }

Property Value

InterpolationMode
See Also

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.

public bool PreciseCharPositions { get; set; }

Property Value

bool
See Also

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.

[Obsolete("Use ViewState instead.")]
public bool Print { get; set; }

Property Value

bool
See Also

Resolution

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

public float Resolution { get; set; }

Property Value

float
See Also

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.

public bool UseGlyphBitmapCache { get; set; }

Property Value

bool
See Also

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.

public bool UseRenderingCache { get; set; }

Property Value

bool
See Also

Zoom

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

public float Zoom { get; set; }

Property Value

float
See Also

See Also