Aspose::Cells::Saving::EbookSaveOptions class
Contents
[
Hide
]EbookSaveOptions class
Represents the options for saving ebook file.
class EbookSaveOptions : public Aspose::Cells::HtmlSaveOptions
Methods
| Method | Description | |
|---|---|---|
| EbookSaveOptions() | Creates options for saving ebook file. | |
| explicit EbookSaveOptions(SaveFormat saveFormat) | Creates options for saving ebook file. | |
| EbookSaveOptions(EbookSaveOptions_Impl* impl) | Constructs from an implementation object. | |
| EbookSaveOptions(const EbookSaveOptions& src) | Copy constructor. | |
| EbookSaveOptions(const HtmlSaveOptions& src) | Constructs from a parent object. | |
| GetAddGenericFont() | Indicates whether to add a generic font to CSS font-family. The default value is true. | |
| GetAddTooltipText() | Indicates whether adding tooltip text when the data can’t be fully displayed. The default value is false. | |
| GetAttachedFilesDirectory() | The directory that the attached files will be saved to. Only for saving to html stream. | |
| GetAttachedFilesUrlPrefix() | Specify the Url prefix of attached files such as image in the html file. Only for saving to html stream. | |
| GetCachedFileFolder() | The cached file folder is used to store some large data. | |
| GetCalculateFormula() | Indicates whether to calculate formulas before saving html file. | |
| GetCellCssPrefix() | Gets and sets the prefix of the css name,the default value is “”. | |
| GetCellNameAttribute() | Specifies the attribute that indicates the CellName to be written. (e.g. If the value is “id”, then for cell “A1”, the output will be: | ). The default value is null. |
| GetCheckExcelRestriction() | Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K, it will be truncated. | |
| GetClearData() | Make the workbook empty after saving the file. | |
| GetCreateDirectory() | If true and the directory does not exist, the directory will be automatically created before saving the file. | |
| GetCssStyles() | Gets or sets the additional css styles for the formatter. Only works when SaveAsSingleFile is True. | |
| GetDefaultFontName() | 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. | |
| GetDisableCss() | Indicates whether only inline styles are applied, without relying on CSS. The default value is false. | |
| GetDisableDownlevelRevealedComments() | Indicates if disable Downlevel-revealed conditional comments when exporting file to html, the default value is false. | |
| GetEncodeEntityAsCode() | Indicates whether the html character entities are replaced with decimal code. (e.g. “ ” is replaced with “ ”). The default value is false. | |
| GetEncoding() | If not set,use Encoding.UTF8 as default enconding type. | |
| GetEncryptDocumentProperties() | Indicates whether encrypt document properties when saving as .xls file. The default value is true. | |
| GetExcludeUnusedStyles() | 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. | |
| GetExportActiveWorksheetOnly() | 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. | |
| GetExportArea() | 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. | |
| GetExportBogusRowData() | 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. | |
| GetExportCellCoordinate() | 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. | |
| GetExportCommentsType() | Represents type of exporting comments to html files. | |
| GetExportDataOptions() | Indicating the rule of exporting html file data.The default value is All. | |
| GetExportDocumentProperties() | 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. | |
| GetExportExtraHeadings() | 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. | |
| GetExportFormula() | 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. | |
| GetExportFrameScriptsAndProperties() | 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. | |
| GetExportGridLines() | Indicating whether exporting the gridlines.The default value is false. | |
| GetExportHiddenWorksheet() | Indicating if exporting the hidden worksheet content.The default value is true. | |
| GetExportImagesAsBase64() | Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB. | |
| GetExportPageFooters() | Indicates whether exporting page headers. | |
| GetExportPageHeaders() | Indicates whether exporting page headers. | |
| GetExportPrintAreaOnly() | Indicates if only exporting the print area to html file. The default value is false. | |
| GetExportRowColumnHeadings() | Indicates whether exports sheet’s row and column headings when saving to HTML files. | |
| GetExportSimilarBorderStyle() | 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. | |
| GetExportSingleTab() | Indicates whether exporting the single tab when the file only has one worksheet. The default value is false. | |
| GetExportWorkbookProperties() | 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. | |
| GetExportWorksheetCSSSeparately() | Indicating whether export the worksheet css separately.The default value is false. | |
| GetExportWorksheetProperties() | 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. | |
| GetFilePathProvider() | Gets or sets the IFilePathProvider for exporting Worksheet to html separately. | |
| GetFormatDataIgnoreColumnWidth() | Indicating 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. | |
| GetHiddenColDisplayType() | 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”. | |
| GetHiddenRowDisplayType() | 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”. | |
| GetHideOverflowWrappedText() | Indicates whether to hide overflow text when the cell format is set to wrap text. The default value is false. | |
| GetHtmlCrossStringType() | 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. | |
| GetIgnoreInvisibleShapes() | Indicate whether exporting those not visible shapes. | |
| GetImageOptions() | Get the ImageOrPrintOptions object before exporting. | |
| GetImageScalable() | Indicates whether using scalable unit to describe the image width when using scalable unit to describe the column width. The default value is true. | |
| GetLinkTargetType() | Indicating the type of target attribute in link. The default value is HtmlLinkTargetType.Parent. | |
| GetMergeAreas() | Indicates whether merge the areas of conditional formatting and validation before saving the file. | |
| GetMergeEmptyTdForcely() | (Deprecated) 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. | |
| GetMergeEmptyTdType() | The option to merge contiguous empty cells(empty td elements) The default value is MergeEmptyTdType.Default. | |
| GetOfficeMathOutputMode() | Indicates how export OfficeMath objects to HTML, Default value is Image. | |
| GetPageTitle() | The title of the html page. Only for saving to html stream. | |
| GetParseHtmlTagInCell() | Indicates whether html tag(such as ) in cell should be parsed as cell value or preserved as it is. The default value is true. | |
| GetPresentationPreference() | 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. | |
| GetRefreshChartCache() | Indicates whether refreshing chart cache data. | |
| GetSaveAsSingleFile() | Indicates whether save the html as single file. The default value is false. | |
| GetSaveFormat() | Gets the save file format. | |
| GetShowAllSheets() | Indicates whether showing all sheets when saving as a single html file. | |
| GetSortExternalNames() | Indicates whether sorting external defined names before saving file. | |
| GetSortNames() | Indicates whether sorting defined names before saving file. | |
| GetTableCssId() | 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 “”. | |
| GetUpdateSmartArt() | Indicates whether updating smart art setting. The default value is false. | |
| GetValidateMergedAreas() | Indicates whether validate merged cells before saving the file. | |
| GetWarningCallback() | Gets or sets warning callback. | |
| GetWidthScalable() | Indicates whether exporting column width in unit of scale to html. The default value is false. | |
| GetWorksheetScalable() | Indicates if zooming in or out the html via worksheet zoom level when saving file to html, the default value is false. | |
| HtmlSaveOptions() | Creates options for saving html file. | |
| explicit HtmlSaveOptions(SaveFormat saveFormat) | Creates options for saving htm file. | |
| HtmlSaveOptions(HtmlSaveOptions_Impl* impl) | Constructs from an implementation object. | |
| HtmlSaveOptions(const HtmlSaveOptions& src) | Copy constructor. | |
| HtmlSaveOptions(const SaveOptions& src) | Constructs from a parent object. | |
| IsBorderCollapsed() | Indicates whether the table borders are collapsed. The default value is true. | |
| IsExpImageToTempDir() | Indicates whether exporting image files to temp directory. Only for saving to html stream. | |
| IsExportComments() | Indicates if exporting comments when saving file to html, the default value is false. | |
| IsFullPathLink() | Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm. The default value is false. | |
| IsIECompatible() | Indicating whether the output HTML is compatible with IE browser. The defalut value is false. | |
| IsJsBrowserCompatible() | Indicates whether JavaScript is compatible with browsers that do not support JavaScript. The default value is true. | |
| IsMobileCompatible() | Indicates whether the output HTML is compatible with mobile devices. The default value is false. | |
| IsNull() const | Checks whether the implementation object is nullptr. | |
| explicit operator bool() const | operator bool() | |
| operator=(const EbookSaveOptions& src) | operator= | |
| operator=(const HtmlSaveOptions& src) | operator= | |
| operator=(const SaveOptions& src) | operator= | |
| SaveOptions(SaveOptions_Impl* impl) | Constructs from an implementation object. | |
| SaveOptions(const SaveOptions& src) | Copy constructor. | |
| SetAddGenericFont(bool value) | Indicates whether to add a generic font to CSS font-family. The default value is true. | |
| SetAddTooltipText(bool value) | Indicates whether adding tooltip text when the data can’t be fully displayed. The default value is false. | |
| SetAttachedFilesDirectory(const U16String& value) | The directory that the attached files will be saved to. Only for saving to html stream. | |
| SetAttachedFilesDirectory(const char16_t* value) | The directory that the attached files will be saved to. Only for saving to html stream. | |
| SetAttachedFilesUrlPrefix(const U16String& value) | Specify the Url prefix of attached files such as image in the html file. Only for saving to html stream. | |
| SetAttachedFilesUrlPrefix(const char16_t* value) | Specify the Url prefix of attached files such as image in the html file. Only for saving to html stream. | |
| SetCachedFileFolder(const U16String& value) | The cached file folder is used to store some large data. | |
| SetCachedFileFolder(const char16_t* value) | The cached file folder is used to store some large data. | |
| SetCalculateFormula(bool value) | Indicates whether to calculate formulas before saving html file. | |
| SetCellCssPrefix(const U16String& value) | Gets and sets the prefix of the css name,the default value is “”. | |
| SetCellCssPrefix(const char16_t* value) | Gets and sets the prefix of the css name,the default value is “”. | |
| SetCellNameAttribute(const U16String& value) | Specifies the attribute that indicates the CellName to be written. (e.g. If the value is “id”, then for cell “A1”, the output will be: | ). The default value is null. |
| SetCellNameAttribute(const char16_t* value) | Specifies the attribute that indicates the CellName to be written. (e.g. If the value is “id”, then for cell “A1”, the output will be: | ). The default value is null. |
| SetCheckExcelRestriction(bool value) | Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K, it will be truncated. | |
| SetClearData(bool value) | Make the workbook empty after saving the file. | |
| SetCreateDirectory(bool value) | If true and the directory does not exist, the directory will be automatically created before saving the file. | |
| SetCssStyles(const U16String& value) | Gets or sets the additional css styles for the formatter. Only works when SaveAsSingleFile is True. | |
| SetCssStyles(const char16_t* value) | Gets or sets the additional css styles for the formatter. Only works when SaveAsSingleFile is True. | |
| SetDefaultFontName(const U16String& value) | 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. | |
| SetDefaultFontName(const char16_t* value) | 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. | |
| SetDisableCss(bool value) | Indicates whether only inline styles are applied, without relying on CSS. The default value is false. | |
| SetDisableDownlevelRevealedComments(bool value) | Indicates if disable Downlevel-revealed conditional comments when exporting file to html, the default value is false. | |
| SetEncodeEntityAsCode(bool value) | Indicates whether the html character entities are replaced with decimal code. (e.g. “ ” is replaced with “ ”). The default value is false. | |
| SetEncoding(EncodingType value) | If not set,use Encoding.UTF8 as default enconding type. | |
| SetEncryptDocumentProperties(bool value) | Indicates whether encrypt document properties when saving as .xls file. The default value is true. | |
| SetExcludeUnusedStyles(bool value) | 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. | |
| SetExportActiveWorksheetOnly(bool value) | 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. | |
| SetExportArea(const CellArea& value) | 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. | |
| SetExportBogusRowData(bool value) | 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. | |
| SetExportCellCoordinate(bool value) | 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. | |
| SetExportCommentsType(PrintCommentsType value) | Represents type of exporting comments to html files. | |
| SetExportDataOptions(HtmlExportDataOptions value) | Indicating the rule of exporting html file data.The default value is All. | |
| SetExportDocumentProperties(bool value) | 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. | |
| SetExportExtraHeadings(bool value) | 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. | |
| SetExportFormula(bool value) | 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. | |
| SetExportFrameScriptsAndProperties(bool value) | 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. | |
| SetExportGridLines(bool value) | Indicating whether exporting the gridlines.The default value is false. | |
| SetExportHiddenWorksheet(bool value) | Indicating if exporting the hidden worksheet content.The default value is true. | |
| SetExportImagesAsBase64(bool value) | Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB. | |
| SetExportPageFooters(bool value) | Indicates whether exporting page headers. | |
| SetExportPageHeaders(bool value) | Indicates whether exporting page headers. | |
| SetExportPrintAreaOnly(bool value) | Indicates if only exporting the print area to html file. The default value is false. | |
| SetExportRowColumnHeadings(bool value) | Indicates whether exports sheet’s row and column headings when saving to HTML files. | |
| SetExportSimilarBorderStyle(bool value) | 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. | |
| SetExportSingleTab(bool value) | Indicates whether exporting the single tab when the file only has one worksheet. The default value is false. | |
| SetExportWorkbookProperties(bool value) | 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. | |
| SetExportWorksheetCSSSeparately(bool value) | Indicating whether export the worksheet css separately.The default value is false. | |
| SetExportWorksheetProperties(bool value) | 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. | |
| SetFilePathProvider(IFilePathProvider* value) | Gets or sets the IFilePathProvider for exporting Worksheet to html separately. | |
| SetFormatDataIgnoreColumnWidth(bool value) | Indicating 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. | |
| SetHiddenColDisplayType(HtmlHiddenColDisplayType value) | 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”. | |
| SetHiddenRowDisplayType(HtmlHiddenRowDisplayType value) | 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”. | |
| SetHideOverflowWrappedText(bool value) | Indicates whether to hide overflow text when the cell format is set to wrap text. The default value is false. | |
| SetHtmlCrossStringType(HtmlCrossType value) | 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. | |
| SetIgnoreInvisibleShapes(bool value) | Indicate whether exporting those not visible shapes. | |
| SetImageScalable(bool value) | Indicates whether using scalable unit to describe the image width when using scalable unit to describe the column width. The default value is true. | |
| SetIsBorderCollapsed(bool value) | Indicates whether the table borders are collapsed. The default value is true. | |
| SetIsExpImageToTempDir(bool value) | Indicates whether exporting image files to temp directory. Only for saving to html stream. | |
| SetIsExportComments(bool value) | Indicates if exporting comments when saving file to html, the default value is false. | |
| SetIsFullPathLink(bool value) | Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm. The default value is false. | |
| SetIsIECompatible(bool value) | Indicating whether the output HTML is compatible with IE browser. The defalut value is false. | |
| SetIsJsBrowserCompatible(bool value) | Indicates whether JavaScript is compatible with browsers that do not support JavaScript. The default value is true. | |
| SetIsMobileCompatible(bool value) | Indicates whether the output HTML is compatible with mobile devices. The default value is false. | |
| SetLinkTargetType(HtmlLinkTargetType value) | Indicating the type of target attribute in link. The default value is HtmlLinkTargetType.Parent. | |
| SetMergeAreas(bool value) | Indicates whether merge the areas of conditional formatting and validation before saving the file. | |
| SetMergeEmptyTdForcely(bool value) | (Deprecated) 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. | |
| SetMergeEmptyTdType(MergeEmptyTdType value) | The option to merge contiguous empty cells(empty td elements) The default value is MergeEmptyTdType.Default. | |
| SetOfficeMathOutputMode(HtmlOfficeMathOutputType value) | Indicates how export OfficeMath objects to HTML, Default value is Image. | |
| SetPageTitle(const U16String& value) | The title of the html page. Only for saving to html stream. | |
| SetPageTitle(const char16_t* value) | The title of the html page. Only for saving to html stream. | |
| SetParseHtmlTagInCell(bool value) | Indicates whether html tag(such as ) in cell should be parsed as cell value or preserved as it is. The default value is true. | |
| SetPresentationPreference(bool value) | 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. | |
| SetRefreshChartCache(bool value) | Indicates whether refreshing chart cache data. | |
| SetSaveAsSingleFile(bool value) | Indicates whether save the html as single file. The default value is false. | |
| SetShowAllSheets(bool value) | Indicates whether showing all sheets when saving as a single html file. | |
| SetSortExternalNames(bool value) | Indicates whether sorting external defined names before saving file. | |
| SetSortNames(bool value) | Indicates whether sorting defined names before saving file. | |
| SetTableCssId(const U16String& value) | 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 “”. | |
| SetTableCssId(const char16_t* value) | 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 “”. | |
| SetUpdateSmartArt(bool value) | Indicates whether updating smart art setting. The default value is false. | |
| SetValidateMergedAreas(bool value) | Indicates whether validate merged cells before saving the file. | |
| SetWarningCallback(IWarningCallback* value) | Gets or sets warning callback. | |
| SetWidthScalable(bool value) | Indicates whether exporting column width in unit of scale to html. The default value is false. | |
| SetWorksheetScalable(bool value) | Indicates if zooming in or out the html via worksheet zoom level when saving file to html, the default value is false. | |
| ~EbookSaveOptions() | Destructor. | |
| ~HtmlSaveOptions() | Destructor. | |
| ~SaveOptions() | Destructor. |
Fields
| Field | Description |
|---|---|
| _impl | The implementation object. |
See Also
- Class HtmlSaveOptions
- Namespace Aspose::Cells::Saving
- Library Aspose.Cells for C++