EbookSaveOptions Class

EbookSaveOptions class

Represents the options for saving ebook file.


type EbookSaveOptions struct  {
	ptr unsafe.Pointer
}

Constructors

MethodDescription
NewEbookSaveOptionsCreates options for saving ebook file.
NewEbookSaveOptions_SaveFormatCreates options for saving ebook file.
NewEbookSaveOptions_HtmlSaveOptionsConstructs from a parent object.

Methods

MethodDescription
IsNullChecks whether the implementation object is nullptr.
GetIgnoreInvisibleShapesIndicate whether exporting those not visible shapes
SetIgnoreInvisibleShapesIndicate whether exporting those not visible shapes
GetPageTitleThe title of the html page.Only for saving to html stream.
SetPageTitleThe title of the html page.Only for saving to html stream.
GetAttachedFilesDirectoryThe directory that the attached files will be saved to.Only for saving to html stream.
SetAttachedFilesDirectoryThe directory that the attached files will be saved to.Only for saving to html stream.
GetAttachedFilesUrlPrefixSpecify the Url prefix of attached files such as image in the html file.Only for saving to html stream.
SetAttachedFilesUrlPrefixSpecify the Url prefix of attached files such as image in the html file.Only for saving to html stream.
GetDefaultFontNameSpecify 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.
SetDefaultFontNameSpecify 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.
GetAddGenericFontIndicates whether to add a generic font to CSS font-family.The default value is true
SetAddGenericFontIndicates whether to add a generic font to CSS font-family.The default value is true
GetWorksheetScalableIndicates if zooming in or out the html via worksheet zoom level when saving file to html, the default value is false.
SetWorksheetScalableIndicates if zooming in or out the html via worksheet zoom level when saving file to html, the default value is false.
IsExportCommentsIndicates if exporting comments when saving file to html, the default value is false.
SetIsExportCommentsIndicates if exporting comments when saving file to html, the default value is false.
GetExportCommentsTypeRepresents type of exporting comments to html files.
SetExportCommentsTypeRepresents type of exporting comments to html files.
GetDisableDownlevelRevealedCommentsIndicates if disable Downlevel-revealed conditional comments when exporting file to html, the default value is false.
SetDisableDownlevelRevealedCommentsIndicates if disable Downlevel-revealed conditional comments when exporting file to html, the default value is false.
IsExpImageToTempDirIndicates whether exporting image files to temp directory.Only for saving to html stream.
SetIsExpImageToTempDirIndicates whether exporting image files to temp directory.Only for saving to html stream.
GetImageScalableIndicates whether using scalable unit to describe the image widthwhen using scalable unit to describe the column width.The default value is true.
SetImageScalableIndicates whether using scalable unit to describe the image widthwhen using scalable unit to describe the column width.The default value is true.
GetWidthScalableIndicates whether exporting column width in unit of scale to html.The default value is false.
SetWidthScalableIndicates whether exporting column width in unit of scale to html.The default value is false.
GetExportSingleTabIndicates whether exporting the single tab when the file only has one worksheet.The default value is false.
SetExportSingleTabIndicates whether exporting the single tab when the file only has one worksheet.The default value is false.
GetExportImagesAsBase64Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB.
SetExportImagesAsBase64Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB.
GetExportActiveWorksheetOnlyIndicates 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.
SetExportActiveWorksheetOnlyIndicates 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.
GetExportPrintAreaOnlyIndicates if only exporting the print area to html file. The default value is false.
SetExportPrintAreaOnlyIndicates if only exporting the print area to html file. The default value is false.
GetExportAreaGets 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.
SetExportAreaGets 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.
GetParseHtmlTagInCellIndicates whether html tag(such as <div></div>) in cell should be parsed as cell value or preserved as it is.The default value is true.
SetParseHtmlTagInCellIndicates whether html tag(such as <div></div>) in cell should be parsed as cell value or preserved as it is.The default value is true.
GetHtmlCrossStringTypeIndicates 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.
SetHtmlCrossStringTypeIndicates 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.
GetHiddenColDisplayTypeHidden 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”
SetHiddenColDisplayTypeHidden 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”
GetHiddenRowDisplayTypeHidden 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”
SetHiddenRowDisplayTypeHidden 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”
GetEncodingIf not set,use Encoding.UTF8 as default enconding type.
SetEncodingIf not set,use Encoding.UTF8 as default enconding type.
GetImageOptionsGet the ImageOrPrintOptions object before exporting
GetSaveAsSingleFileIndicates whether save the html as single file.The default value is false.
SetSaveAsSingleFileIndicates whether save the html as single file.The default value is false.
GetShowAllSheetsIndicates whether showing all sheets when saving as a single html file.
SetShowAllSheetsIndicates whether showing all sheets when saving as a single html file.
GetExportPageHeadersIndicates whether exporting page headers.
SetExportPageHeadersIndicates whether exporting page headers.
GetExportPageFootersIndicates whether exporting page headers.
SetExportPageFootersIndicates whether exporting page headers.
GetExportHiddenWorksheetIndicating if exporting the hidden worksheet content.The default value is true.
SetExportHiddenWorksheetIndicating if exporting the hidden worksheet content.The default value is true.
GetPresentationPreferenceIndicating 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.
SetPresentationPreferenceIndicating 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.
GetCellCssPrefixGets and sets the prefix of the css name,the default value is “”.
SetCellCssPrefixGets and sets the prefix of the css name,the default value is “”.
GetTableCssIdGets and sets the prefix of the type css name such as tr,col,td and so on, they are contained in the table elementwhich has the specific TableCssId attribute. The default value is “”.
SetTableCssIdGets and sets the prefix of the type css name such as tr,col,td and so on, they are contained in the table elementwhich has the specific TableCssId attribute. The default value is “”.
IsFullPathLinkIndicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm.The default value is false.
SetIsFullPathLinkIndicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm.The default value is false.
GetExportWorksheetCSSSeparatelyIndicating whether export the worksheet css separately.The default value is false.
SetExportWorksheetCSSSeparatelyIndicating whether export the worksheet css separately.The default value is false.
GetExportSimilarBorderStyleIndicating 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.
SetExportSimilarBorderStyleIndicating 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.
GetMergeEmptyTdTypeThe option to merge contiguous empty cells(empty td elements)The default value is MergeEmptyTdType.Default.
SetMergeEmptyTdTypeThe option to merge contiguous empty cells(empty td elements)The default value is MergeEmptyTdType.Default.
GetExportCellCoordinateIndicates 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.
SetExportCellCoordinateIndicates 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.
GetExportExtraHeadingsIndicates 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.
SetExportExtraHeadingsIndicates 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.
GetExportRowColumnHeadingsIndicates whether exports sheet’s row and column headings when saving to HTML files.
SetExportRowColumnHeadingsIndicates whether exports sheet’s row and column headings when saving to HTML files.
GetExportFormulaIndicates 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.
SetExportFormulaIndicates 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.
GetAddTooltipTextIndicates whether adding tooltip text when the data can’t be fully displayed.The default value is false.
SetAddTooltipTextIndicates whether adding tooltip text when the data can’t be fully displayed.The default value is false.
GetExportGridLinesIndicating whether exporting the gridlines.The default value is false.
SetExportGridLinesIndicating whether exporting the gridlines.The default value is false.
GetExportBogusRowDataIndicating whether exporting bogus bottom row data. The default value is true.If you want to import the html or mht fileto excel, please keep the default value.
SetExportBogusRowDataIndicating whether exporting bogus bottom row data. The default value is true.If you want to import the html or mht fileto excel, please keep the default value.
GetExcludeUnusedStylesIndicating whether excludes unused styles.For the generated html files, excluding unused styles can make the file size smallerwithout 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 userneeds to restore the workbook from the generated html later), please set this property as false.
SetExcludeUnusedStylesIndicating whether excludes unused styles.For the generated html files, excluding unused styles can make the file size smallerwithout 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 userneeds to restore the workbook from the generated html later), please set this property as false.
GetExportDocumentPropertiesIndicating whether exporting document properties.The default value is true.If you want to importthe html or mht file to excel, please keep the default value.
SetExportDocumentPropertiesIndicating whether exporting document properties.The default value is true.If you want to importthe html or mht file to excel, please keep the default value.
GetExportWorksheetPropertiesIndicating whether exporting worksheet properties.The default value is true.If you want to importthe html or mht file to excel, please keep the default value.
SetExportWorksheetPropertiesIndicating whether exporting worksheet properties.The default value is true.If you want to importthe html or mht file to excel, please keep the default value.
GetExportWorkbookPropertiesIndicating whether exporting workbook properties.The default value is true.If you want to importthe html or mht file to excel, please keep the default value.
SetExportWorkbookPropertiesIndicating whether exporting workbook properties.The default value is true.If you want to importthe html or mht file to excel, please keep the default value.
GetExportFrameScriptsAndPropertiesIndicating whether exporting frame scripts and document properties. The default value is true.If you want to import the html or mht fileto excel, please keep the default value.
SetExportFrameScriptsAndPropertiesIndicating whether exporting frame scripts and document properties. The default value is true.If you want to import the html or mht fileto excel, please keep the default value.
GetExportDataOptionsIndicating the rule of exporting html file data.The default value is All.
SetExportDataOptionsIndicating the rule of exporting html file data.The default value is All.
GetLinkTargetTypeIndicating the type of target attribute in <a> link. The default value is HtmlLinkTargetType.Parent.
SetLinkTargetTypeIndicating the type of target attribute in <a> link. The default value is HtmlLinkTargetType.Parent.
IsIECompatibleIndicating whether the output HTML is compatible with IE browser.The defalut value is false
SetIsIECompatibleIndicating whether the output HTML is compatible with IE browser.The defalut value is false
GetFormatDataIgnoreColumnWidthIndicating whether show the whole formatted data of cell when overflowing the column.If true then ignore the column width and the whole data of cell will be exported.If false then the data will be exported same as Excel.The default value is false.
SetFormatDataIgnoreColumnWidthIndicating whether show the whole formatted data of cell when overflowing the column.If true then ignore the column width and the whole data of cell will be exported.If false then the data will be exported same as Excel.The default value is false.
GetCalculateFormulaIndicates whether to calculate formulas before saving html file.
SetCalculateFormulaIndicates whether to calculate formulas before saving html file.
IsJsBrowserCompatibleIndicates whether JavaScript is compatible with browsers that do not support JavaScript.The default value is true.
SetIsJsBrowserCompatibleIndicates whether JavaScript is compatible with browsers that do not support JavaScript.The default value is true.
IsMobileCompatibleIndicates whether the output HTML is compatible with mobile devices.The default value is false.
SetIsMobileCompatibleIndicates whether the output HTML is compatible with mobile devices.The default value is false.
GetCssStylesGets or sets the additional css styles for the formatter.Only works when is True.
SetCssStylesGets or sets the additional css styles for the formatter.Only works when is True.
GetHideOverflowWrappedTextIndicates whether to hide overflow text when the cell format is set to wrap text.The default value is false
SetHideOverflowWrappedTextIndicates whether to hide overflow text when the cell format is set to wrap text.The default value is false
IsBorderCollapsedIndicates whether the table borders are collapsed.The default value is true.
SetIsBorderCollapsedIndicates whether the table borders are collapsed.The default value is true.
GetEncodeEntityAsCodeIndicates whether the html character entities are replaced with decimal code.(e.g. “&nbsp;” is replaced with “&#160;”).The default value is false.
SetEncodeEntityAsCodeIndicates whether the html character entities are replaced with decimal code.(e.g. “&nbsp;” is replaced with “&#160;”).The default value is false.
GetOfficeMathOutputModeIndicates how export OfficeMath objects to HTML, Default value is Image.
SetOfficeMathOutputModeIndicates how export OfficeMath objects to HTML, Default value is Image.
GetCellNameAttributeSpecifies the attribute that indicates the CellName to be written.(e.g. If the value is “id”, then for cell “A1”, the output will be:<td id=‘A1’>).The default value is null.
SetCellNameAttributeSpecifies the attribute that indicates the CellName to be written.(e.g. If the value is “id”, then for cell “A1”, the output will be:<td id=‘A1’>).The default value is null.
GetDisableCssIndicates whether only inline styles are applied, without relying on CSS.The default value is false.
SetDisableCssIndicates whether only inline styles are applied, without relying on CSS.The default value is false.