EbookSaveOptions

EbookSaveOptions class

Represents the options for saving ebook file.

Constructors

Name	Description
EbookSaveOptions	Creates options for saving ebook file.
EbookSaveOptions

Properties

Name	Type	Description
IgnoreInvisibleShapes	boolean	Indicate whether exporting those not visible shapes The default values is false.
PageTitle	String	The title of the html page. Only for saving to html stream.
AttachedFilesDirectory	String	The directory that the attached files will be saved to. Only for saving to html stream.
AttachedFilesUrlPrefix	String	Specify the Url prefix of attached files such as image in the html file. Only for saving to html stream.
DefaultFontName	String	Specify the default font name for exporting html, the default font will be used when the font of style is not existing,
AddGenericFont	boolean	Indicates whether to add a generic font to CSS font-family. The default value is true
WorksheetScalable	boolean	Indicates if zooming in or out the html via worksheet zoom level when saving file to html, the default value is false.
IsExportComments	boolean	Indicates if exporting comments when saving file to html, the default value is false.
ExportCommentsType	int	Represents type of exporting comments to html files. The value of the property is PrintCommentsType integer constant.
DisableDownlevelRevealedComments	boolean	Indicates if disable Downlevel-revealed conditional comments when exporting file to html, the default value is false.
IsExpImageToTempDir	boolean	Indicates whether exporting image files to temp directory. Only for saving to html stream.
ImageScalable	boolean	Indicates whether using scalable unit to describe the image width when using scalable unit to describe the column width.
WidthScalable	boolean	Indicates whether exporting column width in unit of scale to html. The default value is false.
ExportSingleTab	boolean	Indicates whether exporting the single tab when the file only has one worksheet. The default value is false.
ExportImagesAsBase64	boolean	Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB. When this property is set to true image data
ExportActiveWorksheetOnly	boolean	Indicates if only exporting the active worksheet to html file. If true then only the active worksheet will be exported t
ExportPrintAreaOnly	boolean	Indicates if only exporting the print area to html file. The default value is false.
ExportArea	CellArea	Gets or Sets the exporting CellArea of current active Worksheet. If you set this attribute, the print area of current ac
ParseHtmlTagInCell	boolean	Indicates whether html tag(such as ) in cell should be parsed as cell value or preserved as it is. The defau
HtmlCrossStringType	int	Indicates if a cross-cell string will be displayed in the same way as MS Excel when saving an Excel file in html format.
HiddenColDisplayType	int	Hidden column(the width of this column is 0) in excel,before save this into html format, if HtmlHiddenColDisplayType is
HiddenRowDisplayType	int	Hidden row(the height of this row is 0) in excel,before save this into html format, if HtmlHiddenRowDisplayType is “Remo
Encoding	Encoding	If not set,use Encoding.UTF8 as default enconding type.
ExportObjectListener	IExportObjectListener	Gets or sets the ExportObjectListener for exporting objects. NOTE: This property is now obsolete. Instead, please use Ht
FilePathProvider	IFilePathProvider	Gets or sets the IFilePathProvider for exporting Worksheet to html separately.
StreamProvider	IStreamProvider	Gets or sets the IStreamProvider for exporting objects.
ImageOptions	ImageOrPrintOptions	Get the ImageOrPrintOptions object before exporting
SaveAsSingleFile	boolean	Indicates whether save the html as single file. The default value is false. If there are multiple worksheets or other re
ShowAllSheets	boolean	Indicates whether showing all sheets when saving as a single html file. Only works when SaveAsSingleFile is True.
ExportPageHeaders	boolean	Indicates whether exporting page headers. Only works when SaveAsSingleFile is True.
ExportPageFooters	boolean	Indicates whether exporting page headers. Only works when SaveAsSingleFile is True.
ExportHiddenWorksheet	boolean	Indicating if exporting the hidden worksheet content.The default value is true.
PresentationPreference	boolean	Indicating if html or mht file is presentation preference. The default value is false. if you want to get more beautiful
CellCssPrefix	String	Gets and sets the prefix of the css name,the default value is “”.
TableCssId	String	Gets and sets the prefix of the type css name such as tr,col,td and so on, they are contained in the table element which
IsFullPathLink	boolean	Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm. The default value is false.
ExportWorksheetCSSSeparately	boolean	Indicating whether export the worksheet css separately.The default value is false.
ExportSimilarBorderStyle	boolean	Indicating whether exporting the similar border style when the border style is not supported by browsers. If you want to
MergeEmptyTdForcely	boolean	Indicates whether merging empty TD element forcedly when exporting file to html. The size of html file will be reduced s
MergeEmptyTdType	int	The option to merge contiguous empty cells(empty td elements) The default value is MergeEmptyTdType.Default. The value o
ExportCellCoordinate	boolean	Indicates whether exporting excel coordinate of nonblank cells when saving file to html. The default value is false. If
ExportExtraHeadings	boolean	Indicates whether exporting extra headings when the length of text is longer than max display column. The default value
ExportHeadings	boolean	Indicates whether exports sheet’s row and column headings when saving to HTML files. NOTE: This member is now obsolete.
ExportRowColumnHeadings	boolean	Indicates whether exports sheet’s row and column headings when saving to HTML files. The default value is false.
ExportFormula	boolean	Indicates whether exporting formula when saving file to html. The default value is true. If you want to import the outpu
AddTooltipText	boolean	Indicates whether adding tooltip text when the data can’t be fully displayed. The default value is false.
ExportGridLines	boolean	Indicating whether exporting the gridlines.The default value is false.
ExportBogusRowData	boolean	Indicating whether exporting bogus bottom row data. The default value is true.If you want to import the html or mht file
ExcludeUnusedStyles	boolean	Indicating whether excludes unused styles. For the generated html files, excluding unused styles can make the file size
ExportDocumentProperties	boolean	Indicating whether exporting document properties.The default value is true.If you want to import the html or mht file to
ExportWorksheetProperties	boolean	Indicating whether exporting worksheet properties.The default value is true.If you want to import the html or mht file t
ExportWorkbookProperties	boolean	Indicating whether exporting workbook properties.The default value is true.If you want to import the html or mht file to
ExportFrameScriptsAndProperties	boolean	Indicating whether exporting frame scripts and document properties. The default value is true.If you want to import the
ExportDataOptions	int	Indicating the rule of exporting html file data.The default value is All. The value of the property is HtmlExportDataOpt
LinkTargetType	int	Indicating the type of target attribute in link. The default value is HtmlLinkTargetType.Parent. The value of the pr
IsIECompatible	boolean	Indicating whether the output HTML is compatible with IE browser. The defalut value is false
FormatDataIgnoreColumnWidth	boolean	Indicating whether show the whole formatted data of cell when overflowing the column. If true then ignore the column wid
CalculateFormula	boolean	Indicates whether to calculate formulas before saving html file. The default value is false.
IsJsBrowserCompatible	boolean	Indicates whether JavaScript is compatible with browsers that do not support JavaScript. The default value is true.
IsMobileCompatible	boolean	Indicates whether the output HTML is compatible with mobile devices. The default value is false.
CssStyles	String	Gets or sets the additional css styles for the formatter. Only works when SaveAsSingleFile is True. Example: CssStyles=”
HideOverflowWrappedText	boolean	Indicates whether to hide overflow text when the cell format is set to wrap text. The default value is false
IsBorderCollapsed	boolean	Indicates whether the table borders are collapsed. The default value is true.
EncodeEntityAsCode	boolean
OfficeMathOutputMode	int	The value of the property is HtmlOfficeMathOutputType integer constant.
CellNameAttribute	String
DisableCss	boolean
EnableCssCustomProperties	boolean
HtmlVersion	int	The value of the property is HtmlVersion integer constant.
SheetSet	SheetSet
LayoutMode	int	The value of the property is HtmlLayoutMode integer constant.
EmbeddedFontType	int	The value of the property is HtmlEmbeddedFontType integer constant.
ExportNamedRangeAnchors	boolean
DataBarRenderMode	int	The value of the property is DataBarRenderMode integer constant.
SpaceMode	int	The value of the property is HtmlSpaceMode integer constant.
SaveFormat	int	Gets the save file format. The value of the property is SaveFormat integer constant.
ClearData	boolean	Make the workbook empty after saving the file.
CachedFileFolder	String	The cached file folder is used to store some large data.
ValidateMergedAreas	boolean	Indicates whether validate merged cells before saving the file. The default value is false.
MergeAreas	boolean	Indicates whether merge the areas of conditional formatting and validation before saving the file. The default value is
CreateDirectory	boolean	If true and the directory does not exist, the directory will be automatically created before saving the file. The defaul
SortNames	boolean	Indicates whether sorting defined names before saving file.
SortExternalNames	boolean	Indicates whether sorting external defined names before saving file.
RefreshChartCache	boolean	Indicates whether refreshing chart cache data
WarningCallback	IWarningCallback	Gets or sets warning callback.
CheckExcelRestriction	boolean
UpdateSmartArt	boolean	Indicates whether updating smart art setting. The default value is false. Only effects after calling Shape.GetResultOfSm
EncryptDocumentProperties	boolean

EbookSaveOptions() (1 of 2)

Creates options for saving ebook file.

EbookSaveOptions(saveFormat) (2 of 2)

EbookSaveOptions.IgnoreInvisibleShapes property

Indicate whether exporting those not visible shapes The default values is false.

Type: boolean

EbookSaveOptions.PageTitle property

The title of the html page. Only for saving to html stream.

Type: String

EbookSaveOptions.AttachedFilesDirectory property

The directory that the attached files will be saved to. Only for saving to html stream.

Type: String

EbookSaveOptions.AttachedFilesUrlPrefix property

Specify the Url prefix of attached files such as image in the html file. Only for saving to html stream.

Type: String

EbookSaveOptions.DefaultFontName property

Specify the default font name for exporting html, the default font will be used when the font of style is not existing, If this property is null, Aspose.Cells will use universal font which have the same family with the original font, the default value is null.

Type: String

EbookSaveOptions.AddGenericFont property

Indicates whether to add a generic font to CSS font-family. The default value is true

Type: boolean

EbookSaveOptions.WorksheetScalable property

Indicates if zooming in or out the html via worksheet zoom level when saving file to html, the default value is false.

Type: boolean

EbookSaveOptions.IsExportComments property

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

Type: boolean

EbookSaveOptions.ExportCommentsType property

Represents type of exporting comments to html files. The value of the property is PrintCommentsType integer constant.

Type: int

EbookSaveOptions.DisableDownlevelRevealedComments property

Indicates if disable Downlevel-revealed conditional comments when exporting file to html, the default value is false.

Type: boolean

EbookSaveOptions.IsExpImageToTempDir property

Indicates whether exporting image files to temp directory. Only for saving to html stream.

Type: boolean

EbookSaveOptions.ImageScalable property

Indicates whether using scalable unit to describe the image width when using scalable unit to describe the column width. The default value is true.

Type: boolean

EbookSaveOptions.WidthScalable property

Indicates whether exporting column width in unit of scale to html. The default value is false.

Type: boolean

EbookSaveOptions.ExportSingleTab property

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

Type: boolean

EbookSaveOptions.ExportImagesAsBase64 property

Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB. When this property is set to true image data is exported directly on the img elements and separate files are not created.

Type: boolean

EbookSaveOptions.ExportActiveWorksheetOnly property

Indicates if only exporting the active worksheet to html file. If true then only the active worksheet will be exported to html file; If false then the whole workbook will be exported to html file. The default value is false.

Type: boolean

EbookSaveOptions.ExportPrintAreaOnly property

Indicates if only exporting the print area to html file. The default value is false.

Type: boolean

EbookSaveOptions.ExportArea property

Gets or Sets the exporting CellArea of current active Worksheet. If you set this attribute, the print area of current active Worksheet will be omitted. Only the specified area will be exported when saving the file to html.

Type: CellArea

EbookSaveOptions.ParseHtmlTagInCell property

Indicates whether html tag(such as

) in cell should be parsed as cell value or preserved as it is. The default value is true.

Type: boolean

EbookSaveOptions.HtmlCrossStringType property

Indicates if a cross-cell string will be displayed in the same way as MS Excel when saving an Excel file in html format. By default the value is Default, so, for cross-cell strings, there is little difference between the html files created by Aspose.Cells and MS Excel. But the performance for creating large html files,setting the value to Cross would be several times faster than setting it to Default or Fit2Cell. The value of the property is HtmlCrossType integer constant.

Type: int

EbookSaveOptions.HiddenColDisplayType property

Hidden column(the width of this column is 0) in excel,before save this into html format, if HtmlHiddenColDisplayType is “Remove”,the hidden column would not been output, if the value is “Hidden”, the column would been output,but was hidden,the default value is “Hidden” The value of the property is HtmlHiddenColDisplayType integer constant.

Type: int

EbookSaveOptions.HiddenRowDisplayType property

Hidden row(the height of this row is 0) in excel,before save this into html format, if HtmlHiddenRowDisplayType is “Remove”,the hidden row would not been output, if the value is “Hidden”, the row would been output,but was hidden,the default value is “Hidden” The value of the property is HtmlHiddenRowDisplayType integer constant.

Type: int

EbookSaveOptions.Encoding property

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

Type: Encoding

EbookSaveOptions.ExportObjectListener property

Gets or sets the ExportObjectListener for exporting objects. NOTE: This property is now obsolete. Instead, please use HtmlSaveOptions.IStreamProvider property. This property will be removed 12 months later since August 2015. Aspose apologizes for any inconvenience you may have experienced.

Type: IExportObjectListener

EbookSaveOptions.FilePathProvider property

Gets or sets the IFilePathProvider for exporting Worksheet to html separately.

Type: IFilePathProvider

EbookSaveOptions.StreamProvider property

Gets or sets the IStreamProvider for exporting objects.

Type: IStreamProvider

EbookSaveOptions.ImageOptions property

Get the ImageOrPrintOptions object before exporting

Type: ImageOrPrintOptions

EbookSaveOptions.SaveAsSingleFile property

Indicates whether save the html as single file. The default value is false. If there are multiple worksheets or other required resources such as pictures in the workbook, commonly those worksheets and other resources need to be saved into separate files. For some scenarios, user maybe need to get only one resultant file such as for the convenience of transferring. If so, user may set this property as true.

Type: boolean

EbookSaveOptions.ShowAllSheets property

Indicates whether showing all sheets when saving as a single html file. Only works when SaveAsSingleFile is True.

Type: boolean

EbookSaveOptions.ExportPageHeaders property

Indicates whether exporting page headers. Only works when SaveAsSingleFile is True.

Type: boolean

EbookSaveOptions.ExportPageFooters property

Indicates whether exporting page headers. Only works when SaveAsSingleFile is True.

Type: boolean

EbookSaveOptions.ExportHiddenWorksheet property

Indicating if exporting the hidden worksheet content.The default value is true.

Type: boolean

EbookSaveOptions.PresentationPreference property

Indicating if html or mht file is presentation preference. The default value is false. if you want to get more beautiful presentation,please set the value to true.

Type: boolean

EbookSaveOptions.CellCssPrefix property

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

Type: String

EbookSaveOptions.TableCssId property

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

Type: String

EbookSaveOptions.IsFullPathLink property

Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm. The default value is false.

Type: boolean

EbookSaveOptions.ExportWorksheetCSSSeparately property

Indicating whether export the worksheet css separately.The default value is false.

Type: boolean

EbookSaveOptions.ExportSimilarBorderStyle property

Indicating whether exporting the similar border style when the border style is not supported by browsers. If you want to import the html or mht file to excel, please keep the default value. The default value is false.

Type: boolean

EbookSaveOptions.MergeEmptyTdForcely property

Indicates whether merging empty TD element forcedly when exporting file to html. The size of html file will be reduced significantly after setting value to true. The default value is false. If you want to import the html file to excel or export perfect grid lines when saving file to html, please keep the default value.

Type: boolean

EbookSaveOptions.MergeEmptyTdType property

The option to merge contiguous empty cells(empty td elements) The default value is MergeEmptyTdType.Default. The value of the property is MergeEmptyTdType integer constant.

Type: int

EbookSaveOptions.ExportCellCoordinate property

Indicates whether exporting excel coordinate of nonblank cells when saving file to html. The default value is false. If you want to import the output html to excel, please keep the default value.

Type: boolean

EbookSaveOptions.ExportExtraHeadings property

Indicates whether exporting extra headings when the length of text is longer than max display column. The default value is false. If you want to import the html file to excel, please keep the default value.

Type: boolean

EbookSaveOptions.ExportHeadings property

Indicates whether exports sheet’s row and column headings when saving to HTML files. NOTE: This member is now obsolete. Instead, please use HtmlSaveOptions.ExportRowColumnHeadings property. This property will be removed 12 months later since June 2022. Aspose apologizes for any inconvenience you may have experienced.

Type: boolean

EbookSaveOptions.ExportRowColumnHeadings property

Indicates whether exports sheet’s row and column headings when saving to HTML files. The default value is false.

Type: boolean

EbookSaveOptions.ExportFormula property

Indicates whether exporting formula when saving file to html. The default value is true. If you want to import the output html to excel, please keep the default value.

Type: boolean

EbookSaveOptions.AddTooltipText property

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

Type: boolean

EbookSaveOptions.ExportGridLines property

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

Type: boolean

EbookSaveOptions.ExportBogusRowData property

Indicating whether exporting bogus bottom row data. The default value is true.If you want to import the html or mht file to excel, please keep the default value.

Type: boolean

EbookSaveOptions.ExcludeUnusedStyles property

Indicating whether excludes unused styles. For the generated html files, excluding unused styles can make the file size smaller without affecting the visual effects. So the default value of this property is true. If user needs to keep all styles in the workbook for the generated html(such as the scenario that user needs to restore the workbook from the generated html later), please set this property as false.

Type: boolean

EbookSaveOptions.ExportDocumentProperties property

Indicating whether exporting document properties.The default value is true.If you want to import the html or mht file to excel, please keep the default value.

Type: boolean

EbookSaveOptions.ExportWorksheetProperties property

Indicating whether exporting worksheet properties.The default value is true.If you want to import the html or mht file to excel, please keep the default value.

Type: boolean

EbookSaveOptions.ExportWorkbookProperties property

Indicating whether exporting workbook properties.The default value is true.If you want to import the html or mht file to excel, please keep the default value.

Type: boolean

EbookSaveOptions.ExportFrameScriptsAndProperties property

Indicating whether exporting frame scripts and document properties. The default value is true.If you want to import the html or mht file to excel, please keep the default value.

Type: boolean

EbookSaveOptions.ExportDataOptions property

Indicating the rule of exporting html file data.The default value is All. The value of the property is HtmlExportDataOptions integer constant.

Type: int

EbookSaveOptions.LinkTargetType property

Indicating the type of target attribute in link. The default value is HtmlLinkTargetType.Parent. The value of the property is HtmlLinkTargetType integer constant.

Type: int