MarkdownSaveOptions

MarkdownSaveOptions class

Represents the save options for markdown.

class MarkdownSaveOptions extends SaveOptions;

Constructors

Constructor	Description
constructor()	Creates options for saving markdown document
constructor(SaveOptions)	Constructs from a parent object convertible to this.

Properties

Property	Type	Description
encoding	EncodingType	Gets and sets the default encoding.
formatStrategy	CellValueFormatStrategy	Gets and sets the format strategy when exporting the cell value as string.
lightCellsDataProvider	LightCellsDataProvider	The Data provider to provide cells data for saving workbook in light mode.
lineSeparator	string	Gets and sets the line separator.
tableHeaderType	MarkdownTableHeaderType	Gets and sets how set the header of the table.
sheetSet	SheetSet	Gets or sets the sheets to render. Default is all visible sheets in the workbook: Aspose.Cells.Rendering.SheetSet.Active.
imageOptions	ImageOrPrintOptions	Readonly. Get the ImageOrPrintOptions object before exporting
exportImagesAsBase64	boolean	Specifies whether images are saved in Base64 format to Markdown. The default value is true.
calculateFormula	boolean	Indicates whether to calculate formulas before saving markdown file.
saveFormat	SaveFormat	Readonly. Gets the save file format.
clearData	boolean	Make the workbook empty after saving the file.
cachedFileFolder	string	The folder for temporary files that may be used as data cache.
validateMergedAreas	boolean	Indicates whether validate merged cells before saving the file.
mergeAreas	boolean	Indicates whether merge the areas of conditional formatting and validation before saving the file.
createDirectory	boolean	If true and the directory does not exist, the directory will be automatically created before saving the file.
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	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.
updateSmartArt	boolean	Indicates whether updating smart art setting. The default value is false.
encryptDocumentProperties	boolean	Indicates whether encrypt document properties when saving as .xls file. The default value is true.

Methods

Method	Description
getEncoding()	@deprecated. Please use the ’encoding’ property instead. Gets and sets the default encoding.
setEncoding(EncodingType)	@deprecated. Please use the ’encoding’ property instead. Gets and sets the default encoding.
getFormatStrategy()	@deprecated. Please use the ‘formatStrategy’ property instead. Gets and sets the format strategy when exporting the cell value as string.
setFormatStrategy(CellValueFormatStrategy)	@deprecated. Please use the ‘formatStrategy’ property instead. Gets and sets the format strategy when exporting the cell value as string.
getLightCellsDataProvider()	@deprecated. Please use the ’lightCellsDataProvider’ property instead. The Data provider to provide cells data for saving workbook in light mode.
setLightCellsDataProvider(LightCellsDataProvider)	@deprecated. Please use the ’lightCellsDataProvider’ property instead. The Data provider to provide cells data for saving workbook in light mode.
getLineSeparator()	@deprecated. Please use the ’lineSeparator’ property instead. Gets and sets the line separator.
setLineSeparator(string)	@deprecated. Please use the ’lineSeparator’ property instead. Gets and sets the line separator.
getTableHeaderType()	@deprecated. Please use the ’tableHeaderType’ property instead. Gets and sets how set the header of the table.
setTableHeaderType(MarkdownTableHeaderType)	@deprecated. Please use the ’tableHeaderType’ property instead. Gets and sets how set the header of the table.
getSheetSet()	@deprecated. Please use the ‘sheetSet’ property instead. Gets or sets the sheets to render. Default is all visible sheets in the workbook: Aspose.Cells.Rendering.SheetSet.Active.
setSheetSet(SheetSet)	@deprecated. Please use the ‘sheetSet’ property instead. Gets or sets the sheets to render. Default is all visible sheets in the workbook: Aspose.Cells.Rendering.SheetSet.Active.
getImageOptions()	@deprecated. Please use the ‘imageOptions’ property instead. Get the ImageOrPrintOptions object before exporting
getExportImagesAsBase64()	@deprecated. Please use the ’exportImagesAsBase64’ property instead. Specifies whether images are saved in Base64 format to Markdown. The default value is true.
setExportImagesAsBase64(boolean)	@deprecated. Please use the ’exportImagesAsBase64’ property instead. Specifies whether images are saved in Base64 format to Markdown. The default value is true.
getCalculateFormula()	@deprecated. Please use the ‘calculateFormula’ property instead. Indicates whether to calculate formulas before saving markdown file.
setCalculateFormula(boolean)	@deprecated. Please use the ‘calculateFormula’ property instead. Indicates whether to calculate formulas before saving markdown file.
isNull()	Checks whether the implementation object is null.
getSaveFormat()	@deprecated. Please use the ‘saveFormat’ property instead. Gets the save file format.
getClearData()	@deprecated. Please use the ‘clearData’ property instead. Make the workbook empty after saving the file.
setClearData(boolean)	@deprecated. Please use the ‘clearData’ property instead. Make the workbook empty after saving the file.
getCachedFileFolder()	@deprecated. Please use the ‘cachedFileFolder’ property instead. The folder for temporary files that may be used as data cache.
setCachedFileFolder(string)	@deprecated. Please use the ‘cachedFileFolder’ property instead. The folder for temporary files that may be used as data cache.
getValidateMergedAreas()	@deprecated. Please use the ‘validateMergedAreas’ property instead. Indicates whether validate merged cells before saving the file.
setValidateMergedAreas(boolean)	@deprecated. Please use the ‘validateMergedAreas’ property instead. Indicates whether validate merged cells before saving the file.
getMergeAreas()	@deprecated. Please use the ‘mergeAreas’ property instead. Indicates whether merge the areas of conditional formatting and validation before saving the file.
setMergeAreas(boolean)	@deprecated. Please use the ‘mergeAreas’ property instead. Indicates whether merge the areas of conditional formatting and validation before saving the file.
getCreateDirectory()	@deprecated. Please use the ‘createDirectory’ property instead. If true and the directory does not exist, the directory will be automatically created before saving the file.
setCreateDirectory(boolean)	@deprecated. Please use the ‘createDirectory’ property instead. If true and the directory does not exist, the directory will be automatically created before saving the file.
getSortNames()	@deprecated. Please use the ‘sortNames’ property instead. Indicates whether sorting defined names before saving file.
setSortNames(boolean)	@deprecated. Please use the ‘sortNames’ property instead. Indicates whether sorting defined names before saving file.
getSortExternalNames()	@deprecated. Please use the ‘sortExternalNames’ property instead. Indicates whether sorting external defined names before saving file.
setSortExternalNames(boolean)	@deprecated. Please use the ‘sortExternalNames’ property instead. Indicates whether sorting external defined names before saving file.
getRefreshChartCache()	@deprecated. Please use the ‘refreshChartCache’ property instead. Indicates whether refreshing chart cache data
setRefreshChartCache(boolean)	@deprecated. Please use the ‘refreshChartCache’ property instead. Indicates whether refreshing chart cache data
setWarningCallback(IWarningCallback)	@deprecated. Please use the ‘warningCallback’ property instead. Gets or sets warning callback.
getWarningCallback()	@deprecated. Please use the ‘warningCallback’ property instead. Gets or sets warning callback.
getCheckExcelRestriction()	@deprecated. Please use the ‘checkExcelRestriction’ property instead. 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(boolean)	@deprecated. Please use the ‘checkExcelRestriction’ property instead. 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()	@deprecated. Please use the ‘updateSmartArt’ property instead. Indicates whether updating smart art setting. The default value is false.
setUpdateSmartArt(boolean)	@deprecated. Please use the ‘updateSmartArt’ property instead. Indicates whether updating smart art setting. The default value is false.
getEncryptDocumentProperties()	@deprecated. Please use the ’encryptDocumentProperties’ property instead. Indicates whether encrypt document properties when saving as .xls file. The default value is true.
setEncryptDocumentProperties(boolean)	@deprecated. Please use the ’encryptDocumentProperties’ property instead. Indicates whether encrypt document properties when saving as .xls file. The default value is true.

constructor()

Creates options for saving markdown document

constructor();

constructor(SaveOptions)

Constructs from a parent object convertible to this.

constructor(obj: SaveOptions);

Parameters:

Parameter	Type	Description
obj	SaveOptions	The parent object.

encoding

Gets and sets the default encoding.

encoding : EncodingType;

formatStrategy

Gets and sets the format strategy when exporting the cell value as string.

formatStrategy : CellValueFormatStrategy;

lightCellsDataProvider

The Data provider to provide cells data for saving workbook in light mode.

lightCellsDataProvider : LightCellsDataProvider;

lineSeparator

Gets and sets the line separator.

lineSeparator : string;

tableHeaderType

Gets and sets how set the header of the table.

tableHeaderType : MarkdownTableHeaderType;

sheetSet

Gets or sets the sheets to render. Default is all visible sheets in the workbook: Aspose.Cells.Rendering.SheetSet.Active.

sheetSet : SheetSet;

Remarks

The set is ignored when it is used in SheetRender

imageOptions

Readonly. Get the ImageOrPrintOptions object before exporting

imageOptions : ImageOrPrintOptions;

exportImagesAsBase64

Specifies whether images are saved in Base64 format to Markdown. The default value is true.

exportImagesAsBase64 : boolean;

Remarks

When this property is set to true image data is exported directly on the img elements and separate files are not created.

calculateFormula

Indicates whether to calculate formulas before saving markdown file.

calculateFormula : boolean;

Remarks

The default value is false.

saveFormat

Readonly. Gets the save file format.

saveFormat : SaveFormat;

clearData

Make the workbook empty after saving the file.

clearData : boolean;

cachedFileFolder

The folder for temporary files that may be used as data cache.

cachedFileFolder : string;

Remarks

If the folder has not been specified, the default value for it is CellsHelper.GetCacheFolder(). If its default value is null or empty, or has been specified as null or empty, then no cache file will be used when saving the workbook.

validateMergedAreas

Indicates whether validate merged cells before saving the file.

validateMergedAreas : boolean;

Remarks

The default value is false.

mergeAreas

Indicates whether merge the areas of conditional formatting and validation before saving the file.

mergeAreas : boolean;

Remarks

The default value is false.

createDirectory

If true and the directory does not exist, the directory will be automatically created before saving the file.

createDirectory : boolean;

Remarks

The default value is false.

sortNames

Indicates whether sorting defined names before saving file.

sortNames : boolean;

sortExternalNames

Indicates whether sorting external defined names before saving file.

sortExternalNames : boolean;

refreshChartCache

Indicates whether refreshing chart cache data

refreshChartCache : boolean;

warningCallback

Gets or sets warning callback.

warningCallback : IWarningCallback;

checkExcelRestriction

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.

checkExcelRestriction : boolean;

updateSmartArt

Indicates whether updating smart art setting. The default value is false.

updateSmartArt : boolean;

Remarks

Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.

encryptDocumentProperties

Indicates whether encrypt document properties when saving as .xls file. The default value is true.

encryptDocumentProperties : boolean;

Remarks

Only for .xls,xlsx,xlsb and xlsm file.

getEncoding()

@deprecated. Please use the ’encoding’ property instead. Gets and sets the default encoding.

getEncoding() : EncodingType;

Returns

EncodingType

setEncoding(EncodingType)

@deprecated. Please use the ’encoding’ property instead. Gets and sets the default encoding.

setEncoding(value: EncodingType) : void;

Parameters:

Parameter	Type	Description
value	EncodingType	The value to set.

getFormatStrategy()

@deprecated. Please use the ‘formatStrategy’ property instead. Gets and sets the format strategy when exporting the cell value as string.

getFormatStrategy() : CellValueFormatStrategy;

Returns

CellValueFormatStrategy

setFormatStrategy(CellValueFormatStrategy)

@deprecated. Please use the ‘formatStrategy’ property instead. Gets and sets the format strategy when exporting the cell value as string.

setFormatStrategy(value: CellValueFormatStrategy) : void;

Parameters:

Parameter	Type	Description
value	CellValueFormatStrategy	The value to set.

getLightCellsDataProvider()

@deprecated. Please use the ’lightCellsDataProvider’ property instead. The Data provider to provide cells data for saving workbook in light mode.

getLightCellsDataProvider() : LightCellsDataProvider;

Returns

LightCellsDataProvider

setLightCellsDataProvider(LightCellsDataProvider)

@deprecated. Please use the ’lightCellsDataProvider’ property instead. The Data provider to provide cells data for saving workbook in light mode.

setLightCellsDataProvider(value: LightCellsDataProvider) : void;

Parameters:

Parameter	Type	Description
value	LightCellsDataProvider	The value to set.

getLineSeparator()

@deprecated. Please use the ’lineSeparator’ property instead. Gets and sets the line separator.

getLineSeparator() : string;

setLineSeparator(string)

@deprecated. Please use the ’lineSeparator’ property instead. Gets and sets the line separator.

setLineSeparator(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getTableHeaderType()

@deprecated. Please use the ’tableHeaderType’ property instead. Gets and sets how set the header of the table.

getTableHeaderType() : MarkdownTableHeaderType;

Returns

MarkdownTableHeaderType

setTableHeaderType(MarkdownTableHeaderType)

@deprecated. Please use the ’tableHeaderType’ property instead. Gets and sets how set the header of the table.

setTableHeaderType(value: MarkdownTableHeaderType) : void;

Parameters:

Parameter	Type	Description
value	MarkdownTableHeaderType	The value to set.

getSheetSet()

@deprecated. Please use the ‘sheetSet’ property instead. Gets or sets the sheets to render. Default is all visible sheets in the workbook: Aspose.Cells.Rendering.SheetSet.Active.

getSheetSet() : SheetSet;

Returns

SheetSet

Remarks

The set is ignored when it is used in SheetRender

setSheetSet(SheetSet)

@deprecated. Please use the ‘sheetSet’ property instead. Gets or sets the sheets to render. Default is all visible sheets in the workbook: Aspose.Cells.Rendering.SheetSet.Active.

setSheetSet(value: SheetSet) : void;

Parameters:

Parameter	Type	Description
value	SheetSet	The value to set.

Remarks

The set is ignored when it is used in SheetRender

getImageOptions()

@deprecated. Please use the ‘imageOptions’ property instead. Get the ImageOrPrintOptions object before exporting

getImageOptions() : ImageOrPrintOptions;

Returns

ImageOrPrintOptions

getExportImagesAsBase64()

@deprecated. Please use the ’exportImagesAsBase64’ property instead. Specifies whether images are saved in Base64 format to Markdown. The default value is true.

getExportImagesAsBase64() : boolean;

Remarks

When this property is set to true image data is exported directly on the img elements and separate files are not created.

setExportImagesAsBase64(boolean)

@deprecated. Please use the ’exportImagesAsBase64’ property instead. Specifies whether images are saved in Base64 format to Markdown. The default value is true.

setExportImagesAsBase64(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

When this property is set to true image data is exported directly on the img elements and separate files are not created.

getCalculateFormula()

@deprecated. Please use the ‘calculateFormula’ property instead. Indicates whether to calculate formulas before saving markdown file.

getCalculateFormula() : boolean;

Remarks

The default value is false.

setCalculateFormula(boolean)

@deprecated. Please use the ‘calculateFormula’ property instead. Indicates whether to calculate formulas before saving markdown file.

setCalculateFormula(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

The default value is false.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;

getSaveFormat()

@deprecated. Please use the ‘saveFormat’ property instead. Gets the save file format.

getSaveFormat() : SaveFormat;

Returns

SaveFormat

getClearData()

@deprecated. Please use the ‘clearData’ property instead. Make the workbook empty after saving the file.

getClearData() : boolean;

setClearData(boolean)

@deprecated. Please use the ‘clearData’ property instead. Make the workbook empty after saving the file.

setClearData(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getCachedFileFolder()

@deprecated. Please use the ‘cachedFileFolder’ property instead. The folder for temporary files that may be used as data cache.

getCachedFileFolder() : string;

Remarks

setCachedFileFolder(string)

@deprecated. Please use the ‘cachedFileFolder’ property instead. The folder for temporary files that may be used as data cache.

setCachedFileFolder(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

Remarks

getValidateMergedAreas()

@deprecated. Please use the ‘validateMergedAreas’ property instead. Indicates whether validate merged cells before saving the file.

getValidateMergedAreas() : boolean;

Remarks

The default value is false.

setValidateMergedAreas(boolean)

@deprecated. Please use the ‘validateMergedAreas’ property instead. Indicates whether validate merged cells before saving the file.

setValidateMergedAreas(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

The default value is false.

getMergeAreas()

@deprecated. Please use the ‘mergeAreas’ property instead. Indicates whether merge the areas of conditional formatting and validation before saving the file.

getMergeAreas() : boolean;

Remarks

The default value is false.

setMergeAreas(boolean)

@deprecated. Please use the ‘mergeAreas’ property instead. Indicates whether merge the areas of conditional formatting and validation before saving the file.

setMergeAreas(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

The default value is false.

getCreateDirectory()

@deprecated. Please use the ‘createDirectory’ property instead. If true and the directory does not exist, the directory will be automatically created before saving the file.

getCreateDirectory() : boolean;

Remarks

The default value is false.

setCreateDirectory(boolean)

@deprecated. Please use the ‘createDirectory’ property instead. If true and the directory does not exist, the directory will be automatically created before saving the file.

setCreateDirectory(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

The default value is false.

getSortNames()

@deprecated. Please use the ‘sortNames’ property instead. Indicates whether sorting defined names before saving file.

getSortNames() : boolean;

setSortNames(boolean)

@deprecated. Please use the ‘sortNames’ property instead. Indicates whether sorting defined names before saving file.

setSortNames(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getSortExternalNames()

@deprecated. Please use the ‘sortExternalNames’ property instead. Indicates whether sorting external defined names before saving file.

getSortExternalNames() : boolean;

setSortExternalNames(boolean)

@deprecated. Please use the ‘sortExternalNames’ property instead. Indicates whether sorting external defined names before saving file.

setSortExternalNames(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getRefreshChartCache()

@deprecated. Please use the ‘refreshChartCache’ property instead. Indicates whether refreshing chart cache data

getRefreshChartCache() : boolean;

setRefreshChartCache(boolean)

@deprecated. Please use the ‘refreshChartCache’ property instead. Indicates whether refreshing chart cache data

setRefreshChartCache(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

setWarningCallback(IWarningCallback)

@deprecated. Please use the ‘warningCallback’ property instead. Gets or sets warning callback.

setWarningCallback(value: IWarningCallback) : void;

Parameters:

Parameter	Type	Description
value	IWarningCallback	The value to set.

getWarningCallback()

@deprecated. Please use the ‘warningCallback’ property instead. Gets or sets warning callback.

getWarningCallback() : IWarningCallback;

Returns

IWarningCallback

getCheckExcelRestriction()

@deprecated. Please use the ‘checkExcelRestriction’ property instead. 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.

getCheckExcelRestriction() : boolean;

setCheckExcelRestriction(boolean)

setCheckExcelRestriction(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getUpdateSmartArt()

@deprecated. Please use the ‘updateSmartArt’ property instead. Indicates whether updating smart art setting. The default value is false.

getUpdateSmartArt() : boolean;

Remarks

Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.

setUpdateSmartArt(boolean)

@deprecated. Please use the ‘updateSmartArt’ property instead. Indicates whether updating smart art setting. The default value is false.

setUpdateSmartArt(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.

getEncryptDocumentProperties()

@deprecated. Please use the ’encryptDocumentProperties’ property instead. Indicates whether encrypt document properties when saving as .xls file. The default value is true.

getEncryptDocumentProperties() : boolean;

Remarks

Only for .xls,xlsx,xlsb and xlsm file.

setEncryptDocumentProperties(boolean)

@deprecated. Please use the ’encryptDocumentProperties’ property instead. Indicates whether encrypt document properties when saving as .xls file. The default value is true.

setEncryptDocumentProperties(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

Only for .xls,xlsx,xlsb and xlsm file.