DocxSaveOptions
DocxSaveOptions class
Represents options of saving .docx file.
class DocxSaveOptions extends PaginatedSaveOptions;
Constructors
| Name | 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. |
| embedXlsxAsChartDataSource | boolean | Indicates whether embedding an xlsx file as data source of the chart. |
| asFlatOpc | boolean | Indicates whether saving as a flat opc file which can be generated by Open XML SDK |
| saveElementType | SaveElementType | Indicates which elements should be saved. |
| asNormalView | boolean | Exporting Excel file to docx fiel as normal view. If this property is true , one Area will be output, and no scale will take effect. The default value is false. |
| 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. |
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.
embedXlsxAsChartDataSource
Indicates whether embedding an xlsx file as data source of the chart.
embedXlsxAsChartDataSource : boolean;
Remarks
The default value is true.
asFlatOpc
Indicates whether saving as a flat opc file which can be generated by Open XML SDK
asFlatOpc : boolean;
saveElementType
Indicates which elements should be saved.
saveElementType : SaveElementType;
asNormalView
Exporting Excel file to docx fiel as normal view. If this property is true , one Area will be output, and no scale will take effect. The default value is false.
asNormalView : boolean;
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.
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;