HtmlToImageFormat Class

Represents the formatting attributes for rendering HTML to GcBitmapGraphics.

Inheritance

HtmlToImageFormat

Namespace: GrapeCity.Documents.Drawing

Assembly: DS.Documents.Html.dll

Syntax

public class HtmlToImageFormat

Public Class HtmlToImageFormat

Constructors

Name Description

Name	Description
HtmlToImageFormat(bool, bool)	Initializes a new instance of HtmlToImageFormat. If `fullPage` is true, the resulting image size will be calculated automatically to include all page content. The minimal size will be determined by WindowSize. If `fullPage` is false, the maximum resulting image size will be determined by MaxWindowWidth and MaxWindowHeight (possibly clipping some content).

HtmlToImageFormat(bool, bool)

Initializes a new instance of HtmlToImageFormat.

If fullPage is true, the resulting image size will be calculated automatically to include all page content. The minimal size will be determined by WindowSize.

If fullPage is false, the maximum resulting image size will be determined by MaxWindowWidth and MaxWindowHeight (possibly clipping some content).

Properties

Name	Description
Clip	If set, captures the specified rectangular region only (in pixels). Note that this property is ignored if FullPage is true.
DefaultBackgroundColor	Gets or sets the background color to be used if the HTML page doesn't specify one. Defaults to White color.
FullPage	Gets or sets a value indicating whether the full HTML page should be captured. Note that if this property is true, MaxWindowWidth, MaxWindowHeight and Clip are ignored. Conversely, if this property is false, WindowSize is ignored.
MaxBottomMargin	Gets or sets the maximum height of the bottom margin, in pixels. Negative value prevents trimming the bottom margin. Defaults to 0 (no bottom margin).
MaxLeftMargin	Gets or sets the maximum width of the left margin, in pixels. Negative value prevents trimming the left margin. Defaults to 0 (no left margin).
MaxRightMargin	Gets or sets the maximum width of the right margin, in pixels. Negative value prevents trimming the right margin. Defaults to 0 (no right margin).
MaxTopMargin	Gets or sets the maximum height of the top margin, in pixels. Negative value prevents trimming the top margin. Defaults to 0 (no top margin).
MaxWindowHeight	Gets or sets the maximum window height, in pixels. Defaults to 1600. Note that this property is ignored if FullPage is true.
MaxWindowWidth	Gets or sets the maximum window width, in pixels. Defaults to 1200. Note that this property is ignored if FullPage is true.
Scale	Gets or sets the scale factor. Defaults to 1.0.
WindowSize	Gets or sets the minimal window size before trimming margins, in pixels. Defaults to 800 x 600. Note that this property is ignored if FullPage is false.