Aspose::Cells::DocxSaveOptions class
Contents
[
Hide
]DocxSaveOptions class
Represents options of saving .docx file.
class DocxSaveOptions : public Aspose::Cells::PaginatedSaveOptions
Methods
| Method | Description |
|---|---|
| DocxSaveOptions() | Represents options of saving .docx file. |
| explicit DocxSaveOptions(bool saveAsImage) | Represents options of saving .docx file. |
| DocxSaveOptions(DocxSaveOptions_Impl* impl) | Constructs from an implementation object. |
| DocxSaveOptions(const DocxSaveOptions& src) | Copy constructor. |
| DocxSaveOptions(const PaginatedSaveOptions& src) | Constructs from a parent object. |
| GetAllColumnsInOnePagePerSheet() | 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. |
| GetCachedFileFolder() | The cached file folder is used to store some large 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. |
| GetCheckFontCompatibility() | Indicates whether to check font compatibility for every character in text. |
| GetCheckWorkbookDefaultFont() | 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. |
| GetClearData() | Make the workbook empty after saving the file. |
| GetCreateDirectory() | If true and the directory does not exist, the directory will be automatically created before saving the file. |
| GetDefaultEditLanguage() | Gets or sets default edit language. |
| GetDefaultFont() | 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. |
| GetDrawObjectEventHandler() | Implements this interface to get DrawObject and Bound when rendering. |
| GetEmfRenderSetting() | Setting for rendering Emf metafile. |
| GetEncryptDocumentProperties() | Indicates whether encrypt document properties when saving as .xls file. The default value is true. |
| GetGridlineType() | Gets or sets gridline type. |
| GetIgnoreError() | Indicates if you need to hide the error while rendering. The error can be error in shape, image, chart rendering, etc. |
| GetMergeAreas() | Indicates whether merge the areas of conditional formatting and validation before saving the file. |
| GetOnePagePerSheet() | 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. |
| GetOutputBlankPageWhenNothingToPrint() | Indicates whether to output a blank page when there is nothing to print. |
| GetPageCount() | Gets or sets the number of pages to save. |
| GetPageIndex() | Gets or sets the 0-based index of the first page to save. |
| GetPageSavingCallback() | Control/Indicate progress of page saving process. |
| GetPrintingPageType() | Indicates which pages will not be printed. |
| GetRefreshChartCache() | Indicates whether refreshing chart cache data. |
| GetSaveFormat() | Gets the save file format. |
| GetSheetSet() | Gets or sets the sheets to render. Default is all visible sheets in the workbook: Aspose.Cells.Rendering.SheetSet.Visible. |
| GetSortExternalNames() | Indicates whether sorting external defined names before saving file. |
| GetSortNames() | Indicates whether sorting defined names before saving file. |
| GetTextCrossType() | Gets or sets displaying text type when the text width is larger than cell width. |
| GetUpdateSmartArt() | Indicates whether updating smart art setting. The default value is false. |
| GetValidateMergedAreas() | Indicates whether validate merged cells before saving the file. |
| GetWarningCallback() | Gets or sets warning callback. |
| IsFontSubstitutionCharGranularity() | Indicates whether to only substitute the font of character when the cell font is not compatibility for it. |
| IsNull() const | Checks whether the implementation object is nullptr. |
| explicit operator bool() const | operator bool() |
| operator=(const DocxSaveOptions& src) | operator= |
| operator=(const PaginatedSaveOptions& src) | operator= |
| operator=(const SaveOptions& src) | operator= |
| PaginatedSaveOptions(PaginatedSaveOptions_Impl* impl) | Constructs from an implementation object. |
| PaginatedSaveOptions(const PaginatedSaveOptions& src) | Copy constructor. |
| PaginatedSaveOptions(const SaveOptions& src) | Constructs from a parent object. |
| SaveOptions(SaveOptions_Impl* impl) | Constructs from an implementation object. |
| SaveOptions(const SaveOptions& src) | Copy constructor. |
| SetAllColumnsInOnePagePerSheet(bool value) | 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. |
| SetCachedFileFolder(const U16String& value) | The cached file folder is used to store some large data. |
| SetCachedFileFolder(const char16_t* value) | The cached file folder is used to store some large data. |
| SetCheckExcelRestriction(bool value) | Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K, it will be truncated. |
| SetCheckFontCompatibility(bool value) | Indicates whether to check font compatibility for every character in text. |
| SetCheckWorkbookDefaultFont(bool value) | 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. |
| SetClearData(bool value) | Make the workbook empty after saving the file. |
| SetCreateDirectory(bool value) | If true and the directory does not exist, the directory will be automatically created before saving the file. |
| SetDefaultEditLanguage(DefaultEditLanguage value) | Gets or sets default edit language. |
| SetDefaultFont(const U16String& value) | 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(const char16_t* value) | 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. |
| SetDrawObjectEventHandler(DrawObjectEventHandler* value) | Implements this interface to get DrawObject and Bound when rendering. |
| SetEmfRenderSetting(EmfRenderSetting value) | Setting for rendering Emf metafile. |
| SetEncryptDocumentProperties(bool value) | Indicates whether encrypt document properties when saving as .xls file. The default value is true. |
| SetGridlineType(GridlineType value) | Gets or sets gridline type. |
| SetIgnoreError(bool value) | Indicates if you need to hide the error while rendering. The error can be error in shape, image, chart rendering, etc. |
| SetIsFontSubstitutionCharGranularity(bool value) | Indicates whether to only substitute the font of character when the cell font is not compatibility for it. |
| SetMergeAreas(bool value) | Indicates whether merge the areas of conditional formatting and validation before saving the file. |
| SetOnePagePerSheet(bool value) | 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. |
| SetOutputBlankPageWhenNothingToPrint(bool value) | Indicates whether to output a blank page when there is nothing to print. |
| SetPageCount(int32_t value) | Gets or sets the number of pages to save. |
| SetPageIndex(int32_t value) | Gets or sets the 0-based index of the first page to save. |
| SetPageSavingCallback(IPageSavingCallback* value) | Control/Indicate progress of page saving process. |
| SetPrintingPageType(PrintingPageType value) | Indicates which pages will not be printed. |
| SetRefreshChartCache(bool value) | Indicates whether refreshing chart cache data. |
| SetSheetSet(const SheetSet& value) | Gets or sets the sheets to render. Default is all visible sheets in the workbook: Aspose.Cells.Rendering.SheetSet.Visible. |
| SetSortExternalNames(bool value) | Indicates whether sorting external defined names before saving file. |
| SetSortNames(bool value) | Indicates whether sorting defined names before saving file. |
| SetTextCrossType(TextCrossType value) | Gets or sets displaying text type when the text width is larger than cell width. |
| SetUpdateSmartArt(bool value) | Indicates whether updating smart art setting. The default value is false. |
| SetValidateMergedAreas(bool value) | Indicates whether validate merged cells before saving the file. |
| SetWarningCallback(IWarningCallback* value) | Gets or sets warning callback. |
| ~DocxSaveOptions() | Destructor. |
| ~PaginatedSaveOptions() | Destructor. |
| ~SaveOptions() | Destructor. |
Fields
| Field | Description |
|---|---|
| _impl | The implementation object. |
See Also
- Class PaginatedSaveOptions
- Namespace Aspose::Cells
- Library Aspose.Cells for C++