GrapeCity.Documents.Excel.HtmlSaveOptions

Class HtmlSaveOptions

Namespace

GrapeCity.Documents.Excel

Assembly

GcDocs.Excel.dll

Option class for saving html file.

public class HtmlSaveOptions : SaveOptionsBase

Inheritance

object

SaveOptionsBase

HtmlSaveOptions

Inherited Members

SaveOptionsBase.FileFormat

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

HtmlSaveOptions()

Creates options for saving html file.

public HtmlSaveOptions()

Properties

AddTooltipText

Indicates whether adding tooltip text when the data can't be fully displayed. The default value is false.

public bool AddTooltipText { get; set; }

Property Value

bool

AttachedFilesUrlPrefix

Specify the Url prefix of attached files such as image in the html file.

public string AttachedFilesUrlPrefix { get; set; }

Property Value

string

CellCssPrefix

Gets and sets the prefix of the css name, the default value is null.

public string CellCssPrefix { get; set; }

Property Value

string

CssExportType

Specify the way in which the stylesheet (CSS) is exported.

public CssExportType CssExportType { get; set; }

Property Value

CssExportType

Encoding

If not set, use Encoding.UTF8 as default enconding type.

public Encoding Encoding { get; set; }

Property Value

System.Text.Encoding

ExportArea

Indicates which area would be exported to html. This is used for exporting specific area of worksheet. Only take effect when HtmlSaveOptions.ExportSheetName is not null.

public string ExportArea { get; set; }

Property Value

string

ExportCssSeparately

Indicating whether exporting the worksheet style to css separately. The default value is true. When this property is set to false. Css style data is exported directly to each worksheet and separate stylesheet.css file are not created.

[Obsolete("ExportCssSeparately is deprecated. Use CssExportType instead.")]
public bool ExportCssSeparately { get; set; }

Property Value

bool

ExportDocumentProperties

Indicating whether exporting document properties. The default value is true.

public bool ExportDocumentProperties { get; set; }

Property Value

bool

ExportFileName

Indicates the name of the html file. Only for saving to html stream, and the default value is "workbook".

public string ExportFileName { get; set; }

Property Value

string

ExportGridlines

Indicating whether exporting the gridlines. The default value is false.

public bool ExportGridlines { get; set; }

Property Value

bool

ExportHeadings

Indicates whether exporting headings when saving file to html. The default value is false.

public bool ExportHeadings { get; set; }

Property Value

bool

ExportHiddenWorksheet

Indicating if exporting the hidden worksheet. The default value is false.

public bool ExportHiddenWorksheet { get; set; }

Property Value

bool

ExportImageAsBase64

Specifies whether images are saved in Base64 format to html. The default value is false. When this property is set to true image data is exported directly on the img elements and separate files are not created.

public bool ExportImageAsBase64 { get; set; }

Property Value

bool

ExportSheetName

Indicates which worksheet would be exported to html. This is used for exporting specific worksheet of workbook.

public string ExportSheetName { get; set; }

Property Value

string

ExportSingleTab

Indicates whether exporting the single tab when the file only has one worksheet or ExportSheetName is set. The default value is false.

public bool ExportSingleTab { get; set; }

Property Value

bool

IsExportComments

Indicates if exporting comments when saving file to html. The default value is false.

public bool IsExportComments { get; set; }

Property Value

bool

IsFullPathLink

Indicating whether using full path link in html. Only for exporting to html file. The default value is false.

public bool IsFullPathLink { get; set; }

Property Value

bool

IsWidthScalable

Indicates whether using scalable unit to describe the column width when exporting file to html. The default value is false.

public bool IsWidthScalable { get; set; }

Property Value

bool

LinkTargetType

Indicating the type of target attribute in <a> link. The default value is Blank.

public HyperLinkTargetType LinkTargetType { get; set; }

Property Value

HyperLinkTargetType

PageTitle

The title of the html page.

public string PageTitle { get; set; }

Property Value

string

TableCssId

Gets and sets the prefix of the type css name such as tr, td and so on, they are contained in the table element which has the specific TableCssId attribute. The default value is null.

public string TableCssId { get; set; }

Property Value

string