DocxSaveOptions

DocxSaveOptions class

Represents options of saving .docx file.

class DocxSaveOptions extends PaginatedSaveOptions;

Constructors

Constructor	Description
constructor()	Represents options of saving .docx file.
constructor(PaginatedSaveOptions)	Constructs from a parent object convertible to this.
constructor(boolean)	Represents options of saving .docx file.

Properties

Property	Type	Description
saveAsEditableShaps	boolean	Save all drawing objecgts as editable shapes in word file.So you can edit them in Word.
saveAsEditableShapes	boolean	Save all drawing objects as editable shapes in the word file, so you can edit them in Word.
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.
defaultFont	string	When characters in the Excel are Unicode and not be set with correct font in cell style, They may appear as block in pdf,image. Set the DefaultFont such as MingLiu or MS Gothic to show these characters. If this property is not set, Aspose.Cells will use system default font to show these unicode characters.
checkWorkbookDefaultFont	boolean	When characters in the Excel are Unicode and not be set with correct font in cell style, They may appear as block in pdf,image. Set this to true to try to use workbook’s default font to show these characters first.
checkFontCompatibility	boolean	Indicates whether to check font compatibility for every character in text.
isFontSubstitutionCharGranularity	boolean	Indicates whether to only substitute the font of character when the cell font is not compatibility for it.
onePagePerSheet	boolean	If OnePagePerSheet is true , all content of one sheet will output to only one page in result. The paper size of pagesetup will be invalid, and the other settings of pagesetup will still take effect.
allColumnsInOnePagePerSheet	boolean	If AllColumnsInOnePagePerSheet is true , all column content of one sheet will output to only one page in result. The width of paper size of pagesetup will be ignored, and the other settings of pagesetup will still take effect.
ignoreError	boolean	Indicates if you need to hide the error while rendering. The error can be error in shape, image, chart rendering, etc.
outputBlankPageWhenNothingToPrint	boolean	Indicates whether to output a blank page when there is nothing to print.
pageIndex	number	Gets or sets the 0-based index of the first page to save.
pageCount	number	Gets or sets the number of pages to save.
printingPageType	PrintingPageType	Indicates which pages will not be printed.
gridlineType	GridlineType	Gets or sets gridline type.
gridlineColor	Color	Gets or sets gridline color.
textCrossType	TextCrossType	Gets or sets displaying text type when the text width is larger than cell width.
defaultEditLanguage	DefaultEditLanguage	Gets or sets default edit language.
sheetSet	SheetSet	Gets or sets the sheets to render. Default is all visible sheets in the workbook: Aspose.Cells.Rendering.SheetSet.Visible.
drawObjectEventHandler	DrawObjectEventHandler	Implements this interface to get DrawObject and Bound when rendering.
pageSavingCallback	IPageSavingCallback	Control/Indicate progress of page saving process.
emfRenderSetting	EmfRenderSetting	Setting for rendering Emf metafile.
customRenderSettings	CustomRenderSettings	Gets or sets custom settings during rendering.

Methods

Method	Description
getSaveAsEditableShaps()	@deprecated. Please use the ‘saveAsEditableShaps’ property instead. Save all drawing objecgts as editable shapes in word file.So you can edit them in Word.
setSaveAsEditableShaps(boolean)	@deprecated. Please use the ‘saveAsEditableShaps’ property instead. Save all drawing objecgts as editable shapes in word file.So you can edit them in Word.
getSaveAsEditableShapes()	@deprecated. Please use the ‘saveAsEditableShapes’ property instead. Save all drawing objects as editable shapes in the word file, so you can edit them in Word.
setSaveAsEditableShapes(boolean)	@deprecated. Please use the ‘saveAsEditableShapes’ property instead. Save all drawing objects as editable shapes in the word file, so you can edit them in Word.
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.
getDefaultFont()	@deprecated. Please use the ‘defaultFont’ property instead. When characters in the Excel are Unicode and not be set with correct font in cell style, They may appear as block in pdf,image. Set the DefaultFont such as MingLiu or MS Gothic to show these characters. If this property is not set, Aspose.Cells will use system default font to show these unicode characters.
setDefaultFont(string)	@deprecated. Please use the ‘defaultFont’ property instead. When characters in the Excel are Unicode and not be set with correct font in cell style, They may appear as block in pdf,image. Set the DefaultFont such as MingLiu or MS Gothic to show these characters. If this property is not set, Aspose.Cells will use system default font to show these unicode characters.
getCheckWorkbookDefaultFont()	@deprecated. Please use the ‘checkWorkbookDefaultFont’ property instead. When characters in the Excel are Unicode and not be set with correct font in cell style, They may appear as block in pdf,image. Set this to true to try to use workbook’s default font to show these characters first.
setCheckWorkbookDefaultFont(boolean)	@deprecated. Please use the ‘checkWorkbookDefaultFont’ property instead. When characters in the Excel are Unicode and not be set with correct font in cell style, They may appear as block in pdf,image. Set this to true to try to use workbook’s default font to show these characters first.
setCheckFontCompatibility(boolean)	@deprecated. Please use the ‘checkFontCompatibility’ property instead. Indicates whether to check font compatibility for every character in text.
getCheckFontCompatibility()	@deprecated. Please use the ‘checkFontCompatibility’ property instead. Indicates whether to check font compatibility for every character in text.
setIsFontSubstitutionCharGranularity(boolean)	@deprecated. Please use the ‘isFontSubstitutionCharGranularity’ property instead. Indicates whether to only substitute the font of character when the cell font is not compatibility for it.
isFontSubstitutionCharGranularity()	@deprecated. Please use the ‘isFontSubstitutionCharGranularity’ property instead. Indicates whether to only substitute the font of character when the cell font is not compatibility for it.
getOnePagePerSheet()	@deprecated. Please use the ‘onePagePerSheet’ property instead. If OnePagePerSheet is true , all content of one sheet will output to only one page in result. The paper size of pagesetup will be invalid, and the other settings of pagesetup will still take effect.
setOnePagePerSheet(boolean)	@deprecated. Please use the ‘onePagePerSheet’ property instead. If OnePagePerSheet is true , all content of one sheet will output to only one page in result. The paper size of pagesetup will be invalid, and the other settings of pagesetup will still take effect.
getAllColumnsInOnePagePerSheet()	@deprecated. Please use the ‘allColumnsInOnePagePerSheet’ property instead. If AllColumnsInOnePagePerSheet is true , all column content of one sheet will output to only one page in result. The width of paper size of pagesetup will be ignored, and the other settings of pagesetup will still take effect.
setAllColumnsInOnePagePerSheet(boolean)	@deprecated. Please use the ‘allColumnsInOnePagePerSheet’ property instead. If AllColumnsInOnePagePerSheet is true , all column content of one sheet will output to only one page in result. The width of paper size of pagesetup will be ignored, and the other settings of pagesetup will still take effect.
getIgnoreError()	@deprecated. Please use the ‘ignoreError’ property instead. Indicates if you need to hide the error while rendering. The error can be error in shape, image, chart rendering, etc.
setIgnoreError(boolean)	@deprecated. Please use the ‘ignoreError’ property instead. Indicates if you need to hide the error while rendering. The error can be error in shape, image, chart rendering, etc.
getOutputBlankPageWhenNothingToPrint()	@deprecated. Please use the ‘outputBlankPageWhenNothingToPrint’ property instead. Indicates whether to output a blank page when there is nothing to print.
setOutputBlankPageWhenNothingToPrint(boolean)	@deprecated. Please use the ‘outputBlankPageWhenNothingToPrint’ property instead. Indicates whether to output a blank page when there is nothing to print.
setPageIndex(number)	@deprecated. Please use the ‘pageIndex’ property instead. Gets or sets the 0-based index of the first page to save.
getPageIndex()	@deprecated. Please use the ‘pageIndex’ property instead. Gets or sets the 0-based index of the first page to save.
setPageCount(number)	@deprecated. Please use the ‘pageCount’ property instead. Gets or sets the number of pages to save.
getPageCount()	@deprecated. Please use the ‘pageCount’ property instead. Gets or sets the number of pages to save.
getPrintingPageType()	@deprecated. Please use the ‘printingPageType’ property instead. Indicates which pages will not be printed.
setPrintingPageType(PrintingPageType)	@deprecated. Please use the ‘printingPageType’ property instead. Indicates which pages will not be printed.
getGridlineType()	@deprecated. Please use the ‘gridlineType’ property instead. Gets or sets gridline type.
setGridlineType(GridlineType)	@deprecated. Please use the ‘gridlineType’ property instead. Gets or sets gridline type.
getGridlineColor()	@deprecated. Please use the ‘gridlineColor’ property instead. Gets or sets gridline color.
setGridlineColor(Color)	@deprecated. Please use the ‘gridlineColor’ property instead. Gets or sets gridline color.
getTextCrossType()	@deprecated. Please use the ’textCrossType’ property instead. Gets or sets displaying text type when the text width is larger than cell width.
setTextCrossType(TextCrossType)	@deprecated. Please use the ’textCrossType’ property instead. Gets or sets displaying text type when the text width is larger than cell width.
getDefaultEditLanguage()	@deprecated. Please use the ‘defaultEditLanguage’ property instead. Gets or sets default edit language.
setDefaultEditLanguage(DefaultEditLanguage)	@deprecated. Please use the ‘defaultEditLanguage’ property instead. Gets or sets default edit language.
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.Visible.
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.Visible.
getDrawObjectEventHandler()	@deprecated. Please use the ‘drawObjectEventHandler’ property instead. Implements this interface to get DrawObject and Bound when rendering.
setDrawObjectEventHandler(DrawObjectEventHandler)	@deprecated. Please use the ‘drawObjectEventHandler’ property instead. Implements this interface to get DrawObject and Bound when rendering.
getPageSavingCallback()	@deprecated. Please use the ‘pageSavingCallback’ property instead. Control/Indicate progress of page saving process.
setPageSavingCallback(IPageSavingCallback)	@deprecated. Please use the ‘pageSavingCallback’ property instead. Control/Indicate progress of page saving process.
getEmfRenderSetting()	@deprecated. Please use the ’emfRenderSetting’ property instead. Setting for rendering Emf metafile.
setEmfRenderSetting(EmfRenderSetting)	@deprecated. Please use the ’emfRenderSetting’ property instead. Setting for rendering Emf metafile.
getCustomRenderSettings()	@deprecated. Please use the ‘customRenderSettings’ property instead. Gets or sets custom settings during rendering.
setCustomRenderSettings(CustomRenderSettings)	@deprecated. Please use the ‘customRenderSettings’ property instead. Gets or sets custom settings during rendering.

constructor()

Represents options of saving .docx file.

constructor();

constructor(PaginatedSaveOptions)

Constructs from a parent object convertible to this.

constructor(obj: PaginatedSaveOptions);

Parameters:

Parameter	Type	Description
obj	PaginatedSaveOptions	The parent object.

constructor(boolean)

Represents options of saving .docx file.

constructor(saveAsImage: boolean);

Parameters:

Parameter	Type	Description
saveAsImage	boolean	If True, the workbook will be converted into some pictures of .docx file. ///If False, the workbook will be converted into some tables of .docx file.

saveAsEditableShaps

Save all drawing objecgts as editable shapes in word file.So you can edit them in Word.

saveAsEditableShaps : boolean;

Remarks

NOTE: This member is now obsolete. Instead, please use SaveAsEditableShapes property. This property will be removed 6 months later since May 2025. Aspose apologizes for any inconvenience you may have experienced.

saveAsEditableShapes

Save all drawing objects as editable shapes in the word file, so you can edit them in Word.

saveAsEditableShapes : boolean;

Remarks

Only for charts.

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 it is 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.

defaultFont

When characters in the Excel are Unicode and not be set with correct font in cell style, They may appear as block in pdf,image. Set the DefaultFont such as MingLiu or MS Gothic to show these characters. If this property is not set, Aspose.Cells will use system default font to show these unicode characters.

defaultFont : string;

checkWorkbookDefaultFont

When characters in the Excel are Unicode and not be set with correct font in cell style, They may appear as block in pdf,image. Set this to true to try to use workbook’s default font to show these characters first.

checkWorkbookDefaultFont : boolean;

Remarks

Default is true.

checkFontCompatibility

Indicates whether to check font compatibility for every character in text.

checkFontCompatibility : boolean;

Remarks

The default value is true. Disable this property may give better performance. But when the default or specified font of text/character cannot be used to render it, unreadable characters(such as block) maybe occur in the generated pdf. For such situation user should keep this property as true so that alternative font can be searched and used to render the text instead;

isFontSubstitutionCharGranularity

Indicates whether to only substitute the font of character when the cell font is not compatibility for it.

isFontSubstitutionCharGranularity : boolean;

Remarks

Default is false. We will try default font of Workbook and PdfSaveOption/system for cell font first.

onePagePerSheet

If OnePagePerSheet is true , all content of one sheet will output to only one page in result. The paper size of pagesetup will be invalid, and the other settings of pagesetup will still take effect.

onePagePerSheet : boolean;

allColumnsInOnePagePerSheet

If AllColumnsInOnePagePerSheet is true , all column content of one sheet will output to only one page in result. The width of paper size of pagesetup will be ignored, and the other settings of pagesetup will still take effect.

allColumnsInOnePagePerSheet : boolean;

ignoreError

Indicates if you need to hide the error while rendering. The error can be error in shape, image, chart rendering, etc.

ignoreError : boolean;

outputBlankPageWhenNothingToPrint

Indicates whether to output a blank page when there is nothing to print.

outputBlankPageWhenNothingToPrint : boolean;

Remarks

Default is true.

pageIndex

Gets or sets the 0-based index of the first page to save.

pageIndex : number;

Remarks

Default is 0.

pageCount

Gets or sets the number of pages to save.

pageCount : number;

Remarks

Default is System.Int32.MaxValue which means all pages will be rendered..

printingPageType

Indicates which pages will not be printed.

printingPageType : PrintingPageType;

Remarks

If content in the sheet is sparse, there will be some pages are totally blank in the output pdf file. If you don’t want these blank pages, you can use this option to omit them.

gridlineType

Gets or sets gridline type.

gridlineType : GridlineType;

Remarks

Default is Dotted type.

gridlineColor

Gets or sets gridline color.

gridlineColor : Color;

Remarks

It will ignore the gridline color settings in the source file.

textCrossType

Gets or sets displaying text type when the text width is larger than cell width.

textCrossType : TextCrossType;

defaultEditLanguage

Gets or sets default edit language.

defaultEditLanguage : DefaultEditLanguage;

Remarks

It may display/render different layouts for text paragraph when different edit languages is set. Default is Aspose.Cells.DefaultEditLanguage.Auto.

sheetSet

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

sheetSet : SheetSet;

drawObjectEventHandler

Implements this interface to get DrawObject and Bound when rendering.

drawObjectEventHandler : DrawObjectEventHandler;

pageSavingCallback

Control/Indicate progress of page saving process.

pageSavingCallback : IPageSavingCallback;

emfRenderSetting

Setting for rendering Emf metafile.

emfRenderSetting : EmfRenderSetting;

Remarks

EMF metafiles identified as “EMF+ Dual” can contain both EMF+ records and EMF records. Either type of record can be used to render the image, only EMF+ records, or only EMF records. When Aspose.Cells.EmfRenderSetting.EmfPlusPrefer is set, then EMF+ records will be parsed while rendering to page, otherwise only EMF records will be parsed. Default value is Aspose.Cells.EmfRenderSetting.EmfOnly.

customRenderSettings

Gets or sets custom settings during rendering.

customRenderSettings : CustomRenderSettings;

getSaveAsEditableShaps()

@deprecated. Please use the ‘saveAsEditableShaps’ property instead. Save all drawing objecgts as editable shapes in word file.So you can edit them in Word.

getSaveAsEditableShaps() : boolean;

Remarks

setSaveAsEditableShaps(boolean)

@deprecated. Please use the ‘saveAsEditableShaps’ property instead. Save all drawing objecgts as editable shapes in word file.So you can edit them in Word.

setSaveAsEditableShaps(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

getSaveAsEditableShapes()

@deprecated. Please use the ‘saveAsEditableShapes’ property instead. Save all drawing objects as editable shapes in the word file, so you can edit them in Word.

getSaveAsEditableShapes() : boolean;

Remarks

Only for charts.

setSaveAsEditableShapes(boolean)

@deprecated. Please use the ‘saveAsEditableShapes’ property instead. Save all drawing objects as editable shapes in the word file, so you can edit them in Word.

setSaveAsEditableShapes(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

Only for charts.

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

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

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

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

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.

getDefaultFont()

@deprecated. Please use the ‘defaultFont’ property instead. When characters in the Excel are Unicode and not be set with correct font in cell style, They may appear as block in pdf,image. Set the DefaultFont such as MingLiu or MS Gothic to show these characters. If this property is not set, Aspose.Cells will use system default font to show these unicode characters.

getDefaultFont() : string;

setDefaultFont(string)

setDefaultFont(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getCheckWorkbookDefaultFont()

@deprecated. Please use the ‘checkWorkbookDefaultFont’ property instead. When characters in the Excel are Unicode and not be set with correct font in cell style, They may appear as block in pdf,image. Set this to true to try to use workbook’s default font to show these characters first.

getCheckWorkbookDefaultFont() : boolean;

Remarks

Default is true.

setCheckWorkbookDefaultFont(boolean)

setCheckWorkbookDefaultFont(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

Default is true.

setCheckFontCompatibility(boolean)

@deprecated. Please use the ‘checkFontCompatibility’ property instead. Indicates whether to check font compatibility for every character in text.

setCheckFontCompatibility(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

getCheckFontCompatibility()

@deprecated. Please use the ‘checkFontCompatibility’ property instead. Indicates whether to check font compatibility for every character in text.

getCheckFontCompatibility() : boolean;

Remarks

setIsFontSubstitutionCharGranularity(boolean)

@deprecated. Please use the ‘isFontSubstitutionCharGranularity’ property instead. Indicates whether to only substitute the font of character when the cell font is not compatibility for it.

setIsFontSubstitutionCharGranularity(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

Default is false. We will try default font of Workbook and PdfSaveOption/system for cell font first.

isFontSubstitutionCharGranularity()

@deprecated. Please use the ‘isFontSubstitutionCharGranularity’ property instead. Indicates whether to only substitute the font of character when the cell font is not compatibility for it.

isFontSubstitutionCharGranularity() : boolean;

Remarks

Default is false. We will try default font of Workbook and PdfSaveOption/system for cell font first.

getOnePagePerSheet()

@deprecated. Please use the ‘onePagePerSheet’ property instead. If OnePagePerSheet is true , all content of one sheet will output to only one page in result. The paper size of pagesetup will be invalid, and the other settings of pagesetup will still take effect.

getOnePagePerSheet() : boolean;

setOnePagePerSheet(boolean)

setOnePagePerSheet(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getAllColumnsInOnePagePerSheet()

@deprecated. Please use the ‘allColumnsInOnePagePerSheet’ property instead. If AllColumnsInOnePagePerSheet is true , all column content of one sheet will output to only one page in result. The width of paper size of pagesetup will be ignored, and the other settings of pagesetup will still take effect.

getAllColumnsInOnePagePerSheet() : boolean;

setAllColumnsInOnePagePerSheet(boolean)

setAllColumnsInOnePagePerSheet(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getIgnoreError()

@deprecated. Please use the ‘ignoreError’ property instead. Indicates if you need to hide the error while rendering. The error can be error in shape, image, chart rendering, etc.

getIgnoreError() : boolean;

setIgnoreError(boolean)

@deprecated. Please use the ‘ignoreError’ property instead. Indicates if you need to hide the error while rendering. The error can be error in shape, image, chart rendering, etc.

setIgnoreError(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getOutputBlankPageWhenNothingToPrint()

@deprecated. Please use the ‘outputBlankPageWhenNothingToPrint’ property instead. Indicates whether to output a blank page when there is nothing to print.

getOutputBlankPageWhenNothingToPrint() : boolean;

Remarks

Default is true.

setOutputBlankPageWhenNothingToPrint(boolean)

@deprecated. Please use the ‘outputBlankPageWhenNothingToPrint’ property instead. Indicates whether to output a blank page when there is nothing to print.

setOutputBlankPageWhenNothingToPrint(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

Default is true.

setPageIndex(number)

@deprecated. Please use the ‘pageIndex’ property instead. Gets or sets the 0-based index of the first page to save.

setPageIndex(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

Default is 0.

getPageIndex()

@deprecated. Please use the ‘pageIndex’ property instead. Gets or sets the 0-based index of the first page to save.

getPageIndex() : number;

Remarks

Default is 0.

setPageCount(number)

@deprecated. Please use the ‘pageCount’ property instead. Gets or sets the number of pages to save.

setPageCount(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

Default is System.Int32.MaxValue which means all pages will be rendered..

getPageCount()

@deprecated. Please use the ‘pageCount’ property instead. Gets or sets the number of pages to save.

getPageCount() : number;

Remarks

Default is System.Int32.MaxValue which means all pages will be rendered..

getPrintingPageType()

@deprecated. Please use the ‘printingPageType’ property instead. Indicates which pages will not be printed.

getPrintingPageType() : PrintingPageType;

Returns

PrintingPageType

Remarks

If content in the sheet is sparse, there will be some pages are totally blank in the output pdf file. If you don’t want these blank pages, you can use this option to omit them.

setPrintingPageType(PrintingPageType)

@deprecated. Please use the ‘printingPageType’ property instead. Indicates which pages will not be printed.

setPrintingPageType(value: PrintingPageType) : void;

Parameters:

Parameter	Type	Description
value	PrintingPageType	The value to set.

Remarks

If content in the sheet is sparse, there will be some pages are totally blank in the output pdf file. If you don’t want these blank pages, you can use this option to omit them.

getGridlineType()

@deprecated. Please use the ‘gridlineType’ property instead. Gets or sets gridline type.

getGridlineType() : GridlineType;

Returns

GridlineType

Remarks

Default is Dotted type.

setGridlineType(GridlineType)

@deprecated. Please use the ‘gridlineType’ property instead. Gets or sets gridline type.

setGridlineType(value: GridlineType) : void;

Parameters:

Parameter	Type	Description
value	GridlineType	The value to set.

Remarks

Default is Dotted type.

getGridlineColor()

@deprecated. Please use the ‘gridlineColor’ property instead. Gets or sets gridline color.

getGridlineColor() : Color;

Returns

Color

Remarks

It will ignore the gridline color settings in the source file.

setGridlineColor(Color)

@deprecated. Please use the ‘gridlineColor’ property instead. Gets or sets gridline color.

setGridlineColor(value: Color) : void;

Parameters:

Parameter	Type	Description
value	Color	The value to set.

Remarks

It will ignore the gridline color settings in the source file.

getTextCrossType()

@deprecated. Please use the ’textCrossType’ property instead. Gets or sets displaying text type when the text width is larger than cell width.

getTextCrossType() : TextCrossType;

Returns

TextCrossType

setTextCrossType(TextCrossType)

@deprecated. Please use the ’textCrossType’ property instead. Gets or sets displaying text type when the text width is larger than cell width.

setTextCrossType(value: TextCrossType) : void;

Parameters:

Parameter	Type	Description
value	TextCrossType	The value to set.

getDefaultEditLanguage()

@deprecated. Please use the ‘defaultEditLanguage’ property instead. Gets or sets default edit language.

getDefaultEditLanguage() : DefaultEditLanguage;

Returns

DefaultEditLanguage

Remarks

It may display/render different layouts for text paragraph when different edit languages is set. Default is Aspose.Cells.DefaultEditLanguage.Auto.

setDefaultEditLanguage(DefaultEditLanguage)

@deprecated. Please use the ‘defaultEditLanguage’ property instead. Gets or sets default edit language.

setDefaultEditLanguage(value: DefaultEditLanguage) : void;

Parameters:

Parameter	Type	Description
value	DefaultEditLanguage	The value to set.

Remarks

It may display/render different layouts for text paragraph when different edit languages is set. Default is Aspose.Cells.DefaultEditLanguage.Auto.

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.Visible.

getSheetSet() : SheetSet;

Returns

SheetSet

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.Visible.

setSheetSet(value: SheetSet) : void;

Parameters:

Parameter	Type	Description
value	SheetSet	The value to set.

getDrawObjectEventHandler()

@deprecated. Please use the ‘drawObjectEventHandler’ property instead. Implements this interface to get DrawObject and Bound when rendering.

getDrawObjectEventHandler() : DrawObjectEventHandler;

Returns

DrawObjectEventHandler

setDrawObjectEventHandler(DrawObjectEventHandler)

@deprecated. Please use the ‘drawObjectEventHandler’ property instead. Implements this interface to get DrawObject and Bound when rendering.

setDrawObjectEventHandler(value: DrawObjectEventHandler) : void;

Parameters:

Parameter	Type	Description
value	DrawObjectEventHandler	The value to set.

getPageSavingCallback()

@deprecated. Please use the ‘pageSavingCallback’ property instead. Control/Indicate progress of page saving process.

getPageSavingCallback() : IPageSavingCallback;

Returns

IPageSavingCallback

setPageSavingCallback(IPageSavingCallback)

@deprecated. Please use the ‘pageSavingCallback’ property instead. Control/Indicate progress of page saving process.

setPageSavingCallback(value: IPageSavingCallback) : void;

Parameters:

Parameter	Type	Description
value	IPageSavingCallback	The value to set.

getEmfRenderSetting()

@deprecated. Please use the ’emfRenderSetting’ property instead. Setting for rendering Emf metafile.

getEmfRenderSetting() : EmfRenderSetting;

Returns

EmfRenderSetting

Remarks

setEmfRenderSetting(EmfRenderSetting)

@deprecated. Please use the ’emfRenderSetting’ property instead. Setting for rendering Emf metafile.

setEmfRenderSetting(value: EmfRenderSetting) : void;

Parameters:

Parameter	Type	Description
value	EmfRenderSetting	The value to set.

Remarks

getCustomRenderSettings()

@deprecated. Please use the ‘customRenderSettings’ property instead. Gets or sets custom settings during rendering.

getCustomRenderSettings() : CustomRenderSettings;

Returns

CustomRenderSettings

setCustomRenderSettings(CustomRenderSettings)

@deprecated. Please use the ‘customRenderSettings’ property instead. Gets or sets custom settings during rendering.

setCustomRenderSettings(value: CustomRenderSettings) : void;

Parameters:

Parameter	Type	Description
value	CustomRenderSettings	The value to set.