Class HtmlConverterSettings

Namespace

InSite.Web.Helpers

Assembly

InSite.UI.dll

public class HtmlConverterSettings

Inheritance

object

HtmlConverterSettings

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

HtmlConverterSettings(string)

public HtmlConverterSettings(string exePath)

Parameters

exePath string

Properties

Cookies

Set an additional cookie

public IEnumerable<HtmlConverterSettings.Cookie> Cookies { get; set; }

Property Value

IEnumerable<HtmlConverterSettings.Cookie>

DisablePdfCompression

Do not use lossless compression on pdf objects

public bool DisablePdfCompression { get; set; }

Property Value

bool

Dpi

Change the dpi explicitly (this has no effect on X11 based systems)

public int? Dpi { get; set; }

Property Value

int?

EnableExternalLinks

Make links to remote web pages

public bool EnableExternalLinks { get; set; }

Property Value

bool

EnableInternalLinks

Make local links

public bool EnableInternalLinks { get; set; }

Property Value

bool

EnableJavaScript

Do allow web pages to run javascript

public bool EnableJavaScript { get; set; }

Property Value

bool

EnablePrintMediaType

Use print media-type instead of screen

public bool EnablePrintMediaType { get; set; }

Property Value

bool

EnableSmartShrinking

Enable the intelligent shrinking strategy used by WebKit that makes the pixel/dpi

public bool EnableSmartShrinking { get; set; }

Property Value

bool

ExePath

public string ExePath { get; set; }

Property Value

string

FooterFontName

Set footer font name (default Arial)

public string FooterFontName { get; set; }

Property Value

string

FooterFontSize

Set footer font size (default 12)

public int? FooterFontSize { get; set; }

Property Value

int?

FooterSpacing

Spacing between footer and content in mm

public float? FooterSpacing { get; set; }

Property Value

float?

FooterTextCenter

Centered footer text

public string FooterTextCenter { get; set; }

Property Value

string

FooterTextLeft

Left aligned footer text

public string FooterTextLeft { get; set; }

Property Value

string

FooterTextRight

Right aligned footer text

public string FooterTextRight { get; set; }

Property Value

string

FooterUrl

Adds a html footer

public string FooterUrl { get; set; }

Property Value

string

HeaderFontName

Set header font name (default Arial)

public string HeaderFontName { get; set; }

Property Value

string

HeaderFontSize

Set header font size (default 12)

public int? HeaderFontSize { get; set; }

Property Value

int?

HeaderSpacing

Spacing between header and content in mm

public float? HeaderSpacing { get; set; }

Property Value

float?

HeaderTextCenter

Centered header text

public string HeaderTextCenter { get; set; }

Property Value

string

HeaderTextLeft

Left aligned header text

public string HeaderTextLeft { get; set; }

Property Value

string

HeaderTextRight

Right aligned header text

public string HeaderTextRight { get; set; }

Property Value

string

HeaderUrl

Adds a html header

public string HeaderUrl { get; set; }

Property Value

string

ImageDpi

When embedding images scale them down to this dpi (default 600)

public int? ImageDpi { get; set; }

Property Value

int?

ImageQuality

When jpeg compressing images use this quality (default 94)

public int? ImageQuality { get; set; }

Property Value

int?

JavaScriptDelay

Wait some milliseconds for javascript finish

public int? JavaScriptDelay { get; set; }

Property Value

int?

MarginBottom

Set the page bottom margin

public float? MarginBottom { get; set; }

Property Value

float?

MarginLeft

Set the page left margin (default 10mm)

public float? MarginLeft { get; set; }

Property Value

float?

MarginRight

Set the page right margin (default 10mm)

public float? MarginRight { get; set; }

Property Value

float?

MarginTop

Set the page top margin

public float? MarginTop { get; set; }

Property Value

float?

PageHeight

Page height

public float? PageHeight { get; set; }

Property Value

float?

PageOrientation

Set orientation to Landscape or Portrait

public PageOrientationType PageOrientation { get; set; }

Property Value

PageOrientationType

PageSize

Set paper size to: A4, Letter, etc.

public PageSizeType PageSize { get; set; }

Property Value

PageSizeType

PageWidth

Page width

public float? PageWidth { get; set; }

Property Value

float?

RenderGrayscale

PDF will be generated in grayscale

public bool RenderGrayscale { get; set; }

Property Value

bool

RenderLowQuality

Generates lower quality pdf/ps. Useful to shrink the result document space

public bool RenderLowQuality { get; set; }

Property Value

bool

ShowFooterLine

Display line below the footer

public bool ShowFooterLine { get; set; }

Property Value

bool

ShowHeaderLine

Display line below the header

public bool ShowHeaderLine { get; set; }

Property Value

bool

Title

The title of the generated pdf file (The title of the first document is used if not specified)

public string Title { get; set; }

Property Value

string

Variables

Replace [name] with value in header and footer

public IEnumerable<HtmlConverterSettings.Variable> Variables { get; set; }

Property Value

IEnumerable<HtmlConverterSettings.Variable>

Viewport

Set viewport size if you have custom scrollbars or css attribute overflow to emulate window size

public HtmlConverterSettings.ViewportSize Viewport { get; set; }

Property Value

HtmlConverterSettings.ViewportSize

WebCacheDirectory

Web cache directory

public string WebCacheDirectory { get; set; }

Property Value

string

WorkingDirectory

public string WorkingDirectory { get; set; }

Property Value

string

Zoom

Use this zoom factor (default 1)

public float Zoom { get; set; }

Property Value

float

Methods

ToString()

public override string ToString()

Returns

string