HtmlSaveOptions Class

HtmlSaveOptions class

Represents the options for saving html file.


type HtmlSaveOptions struct  {
	ptr unsafe.Pointer
}

Constructors

Method	Description
NewHtmlSaveOptions	Creates options for saving html file.
NewHtmlSaveOptions_SaveFormat	Creates options for saving htm file.
NewHtmlSaveOptions_SaveOptions	Constructs from a parent object.

Methods

Method	Description
IsNull	Checks whether the implementation object is nullptr.
GetIgnoreInvisibleShapes	Indicate whether exporting those not visible shapes
SetIgnoreInvisibleShapes	Indicate whether exporting those not visible shapes
GetPageTitle	The title of the html page.Only for saving to html stream.
SetPageTitle	The title of the html page.Only for saving to html stream.
GetAttachedFilesDirectory	The directory that the attached files will be saved to.Only for saving to html stream.
SetAttachedFilesDirectory	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.
SetAttachedFilesUrlPrefix	Specify the Url prefix of attached files such as image in the html file.Only for saving to html stream.
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.
SetDefaultFontName	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.
GetAddGenericFont	Indicates whether to add a generic font to CSS font-family.The default value is true
SetAddGenericFont	Indicates whether to add a generic font to CSS font-family.The default value is true
GetWorksheetScalable	Indicates if zooming in or out the html via worksheet zoom level when saving file to html, the default value is false.
SetWorksheetScalable	Indicates if zooming in or out the html via worksheet zoom level when saving file to html, the default value is false.
IsExportComments	Indicates if exporting comments when saving file to html, the default value is false.
SetIsExportComments	Indicates if exporting comments when saving file to html, the default value is false.
GetExportCommentsType	Represents type of exporting comments to html files.
SetExportCommentsType	Represents type of exporting comments to html files.
GetDisableDownlevelRevealedComments	Indicates if disable Downlevel-revealed conditional comments when exporting file to html, the default value is false.
SetDisableDownlevelRevealedComments	Indicates if disable Downlevel-revealed conditional comments when exporting file to html, the default value is false.
IsExpImageToTempDir	Indicates whether exporting image files to temp directory.Only for saving to html stream.
SetIsExpImageToTempDir	Indicates whether exporting image files to temp directory.Only for saving to html stream.
GetImageScalable	Indicates whether using scalable unit to describe the image widthwhen using scalable unit to describe the column width.The default value is true.
SetImageScalable	Indicates whether using scalable unit to describe the image widthwhen using scalable unit to describe the column width.The default value is true.
GetWidthScalable	Indicates whether exporting column width in unit of scale to html.The default value is false.
SetWidthScalable	Indicates whether exporting column width in unit of scale to html.The default value is false.
GetExportSingleTab	Indicates whether exporting the single tab when the file only has one worksheet.The default value is false.
SetExportSingleTab	Indicates whether exporting the single tab when the file only has one worksheet.The default value is false.
GetExportImagesAsBase64	Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB.
SetExportImagesAsBase64	Specifies whether images are saved in Base64 format to HTML, MHTML or EPUB.
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.
SetExportActiveWorksheetOnly	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.
GetExportPrintAreaOnly	Indicates if only exporting the print area to html file. The default value is false.
SetExportPrintAreaOnly	Indicates if only exporting the print area 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.
SetExportArea	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.
GetParseHtmlTagInCell	Indicates 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.
SetParseHtmlTagInCell	Indicates 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.
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.
SetHtmlCrossStringType	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.
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”
SetHiddenColDisplayType	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”
SetHiddenRowDisplayType	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”
GetEncoding	If not set,use Encoding.UTF8 as default enconding type.
SetEncoding	If not set,use Encoding.UTF8 as default enconding type.
GetImageOptions	Get the ImageOrPrintOptions object before exporting
GetSaveAsSingleFile	Indicates whether save the html as single file.The default value is false.
SetSaveAsSingleFile	Indicates whether save the html as single file.The default value is false.
GetShowAllSheets	Indicates whether showing all sheets when saving as a single html file.
SetShowAllSheets	Indicates whether showing all sheets when saving as a single html file.
GetExportPageHeaders	Indicates whether exporting page headers.
SetExportPageHeaders	Indicates whether exporting page headers.
GetExportPageFooters	Indicates whether exporting page headers.
SetExportPageFooters	Indicates whether exporting page headers.
GetExportHiddenWorksheet	Indicating if exporting the hidden worksheet content.The default value is true.
SetExportHiddenWorksheet	Indicating if exporting the hidden worksheet content.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.
SetPresentationPreference	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.
GetCellCssPrefix	Gets and sets the prefix of the css name,the default value is “”.
SetCellCssPrefix	Gets and sets the prefix of the css name,the default value is “”.
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 elementwhich has the specific TableCssId attribute. The default value is “”.
SetTableCssId	Gets 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 “”.
IsFullPathLink	Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm.The default value is false.
SetIsFullPathLink	Indicating whether using full path link in sheet00x.htm,filelist.xml and tabstrip.htm.The default value is false.
GetExportWorksheetCSSSeparately	Indicating whether export the worksheet css separately.The default value is false.
SetExportWorksheetCSSSeparately	Indicating whether export the worksheet css separately.The default value is false.
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.
SetExportSimilarBorderStyle	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.
GetMergeEmptyTdType	The option to merge contiguous empty cells(empty td elements)The default value is MergeEmptyTdType.Default.
SetMergeEmptyTdType	The option to merge contiguous empty cells(empty td elements)The default value is MergeEmptyTdType.Default.
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.
SetExportCellCoordinate	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.
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.
SetExportExtraHeadings	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.
GetExportRowColumnHeadings	Indicates whether exports sheet’s row and column headings when saving to HTML files.
SetExportRowColumnHeadings	Indicates whether exports sheet’s row and column headings when saving to HTML files.
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.
SetExportFormula	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.
GetAddTooltipText	Indicates whether adding tooltip text when the data can’t be fully displayed.The default value is false.
SetAddTooltipText	Indicates whether adding tooltip text when the data can’t be fully displayed.The default value is false.
GetExportGridLines	Indicating whether exporting the gridlines.The default value is false.
SetExportGridLines	Indicating whether exporting the gridlines.The default value is false.
GetExportBogusRowData	Indicating 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.
SetExportBogusRowData	Indicating 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.
GetExcludeUnusedStyles	Indicating 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.
SetExcludeUnusedStyles	Indicating 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.
GetExportDocumentProperties	Indicating 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.
SetExportDocumentProperties	Indicating 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.
GetExportWorksheetProperties	Indicating 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.
SetExportWorksheetProperties	Indicating 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.
GetExportWorkbookProperties	Indicating 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.
SetExportWorkbookProperties	Indicating 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.
GetExportFrameScriptsAndProperties	Indicating 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.
SetExportFrameScriptsAndProperties	Indicating 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.
GetExportDataOptions	Indicating the rule of exporting html file data.The default value is All.
SetExportDataOptions	Indicating the rule of exporting html file data.The default value is All.
GetLinkTargetType	Indicating the type of target attribute in <a> link. The default value is HtmlLinkTargetType.Parent.
SetLinkTargetType	Indicating the type of target attribute in <a> link. The default value is HtmlLinkTargetType.Parent.
IsIECompatible	Indicating whether the output HTML is compatible with IE browser.The defalut value is false
SetIsIECompatible	Indicating whether the output HTML is compatible with IE browser.The defalut value is false
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.
SetFormatDataIgnoreColumnWidth	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.
GetCalculateFormula	Indicates whether to calculate formulas before saving html file.
SetCalculateFormula	Indicates whether to calculate formulas before saving html file.
IsJsBrowserCompatible	Indicates whether JavaScript is compatible with browsers that do not support JavaScript.The default value is true.
SetIsJsBrowserCompatible	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.
SetIsMobileCompatible	Indicates whether the output HTML is compatible with mobile devices.The default value is false.
GetCssStyles	Gets or sets the additional css styles for the formatter.Only works when is True.
SetCssStyles	Gets or sets the additional css styles for the formatter.Only works when is True.
GetHideOverflowWrappedText	Indicates whether to hide overflow text when the cell format is set to wrap text.The default value is false
SetHideOverflowWrappedText	Indicates whether to hide overflow text when the cell format is set to wrap text.The default value is false
IsBorderCollapsed	Indicates whether the table borders are collapsed.The default value is true.
SetIsBorderCollapsed	Indicates whether the table borders are collapsed.The default value is true.
GetEncodeEntityAsCode	Indicates whether the html character entities are replaced with decimal code.(e.g. “ ” is replaced with “ ”).The default value is false.
SetEncodeEntityAsCode	Indicates whether the html character entities are replaced with decimal code.(e.g. “ ” is replaced with “ ”).The default value is false.
GetOfficeMathOutputMode	Indicates how export OfficeMath objects to HTML, Default value is Image.
SetOfficeMathOutputMode	Indicates how export OfficeMath objects to HTML, Default value is Image.
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:<td id=‘A1’>).The default value is null.
SetCellNameAttribute	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:<td id=‘A1’>).The default value is null.
GetDisableCss	Indicates whether only inline styles are applied, without relying on CSS.The default value is false.
SetDisableCss	Indicates whether only inline styles are applied, without relying on CSS.The default value is false.
GetSaveFormat	Gets the save file format.
GetClearData	Make the workbook empty after saving the file.
SetClearData	Make the workbook empty after saving the file.
GetCachedFileFolder	The cached file folder is used to store some large data.
SetCachedFileFolder	The cached file folder is used to store some large data.
GetValidateMergedAreas	Indicates whether validate merged cells before saving the file.
SetValidateMergedAreas	Indicates whether validate merged cells before saving the file.
GetMergeAreas	Indicates whether merge the areas of conditional formatting and validation before saving the file.
SetMergeAreas	Indicates whether merge the areas of conditional formatting and validation before saving the file.
GetCreateDirectory	If true and the directory does not exist, the directory will be automatically created before saving the file.
SetCreateDirectory	If true and the directory does not exist, the directory will be automatically created before saving the file.
GetSortNames	Indicates whether sorting defined names before saving file.
SetSortNames	Indicates whether sorting defined names before saving file.
GetSortExternalNames	Indicates whether sorting external defined names before saving file.
SetSortExternalNames	Indicates whether sorting external defined names before saving file.
GetRefreshChartCache	Indicates whether refreshing chart cache data
SetRefreshChartCache	Indicates whether refreshing chart cache data
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.
SetCheckExcelRestriction	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.
GetUpdateSmartArt	Indicates whether updating smart art setting.The default value is false.
SetUpdateSmartArt	Indicates whether updating smart art setting.The default value is false.
GetEncryptDocumentProperties	Indicates whether encrypt document properties when saving as .xls file.The default value is true.
SetEncryptDocumentProperties	Indicates whether encrypt document properties when saving as .xls file.The default value is true.