OfdSaveOptions

OfdSaveOptions class

Constructors

NameDescription
OfdSaveOptions

Properties

NameTypeDescription
DefaultFontStringWhen characters in the Excel are Unicode and not be set with correct font in cell style, They may appear as block in pdf
CheckWorkbookDefaultFontbooleanWhen characters in the Excel are Unicode and not be set with correct font in cell style, They may appear as block in pdf
CheckFontCompatibilitybooleanIndicates whether to check font compatibility for every character in text. The default value is true. Disable this prope
IsFontSubstitutionCharGranularitybooleanIndicates whether to only substitute the font of character when the cell font is not compatibility for it. Default is fa
OnePagePerSheetbooleanIf OnePagePerSheet is true , all content of one sheet will output to only one page in result. The paper size of pagesetu
AllColumnsInOnePagePerSheetbooleanIf AllColumnsInOnePagePerSheet is true , all column content of one sheet will output to only one page in result. The wid
IgnoreErrorbooleanIndicates if you need to hide the error while rendering. The error can be error in shape, image, chart rendering, etc.
OutputBlankPageWhenNothingToPrintbooleanIndicates whether to output a blank page when there is nothing to print. Default is true.
PageIndexintGets or sets the 0-based index of the first page to save. Default is 0.
PageCountintGets or sets the number of pages to save. Default is System.Int32.MaxValue which means all pages will be rendered..
PrintingPageTypeintIndicates which pages will not be printed. The value of the property is PrintingPageType integer constant. If content in
GridlineTypeintGets or sets gridline type. The value of the property is GridlineType integer constant. Default is Dotted type.
GridlineColorColor
TextCrossTypeintGets or sets displaying text type when the text width is larger than cell width. The value of the property is TextCrossT
DefaultEditLanguageintGets or sets default edit language. The value of the property is DefaultEditLanguage integer constant. It may display/re
SheetSetSheetSetGets or sets the sheets to render. Default is all visible sheets in the workbook: SheetSet.Visible .
DrawObjectEventHandlerDrawObjectEventHandlerImplements this interface to get DrawObject and Bound when rendering.
PageSavingCallbackIPageSavingCallbackControl/Indicate progress of page saving process.
EmfRenderSettingintSetting for rendering Emf metafile. The value of the property is EmfRenderSetting integer constant. EMF metafiles identi
CustomRenderSettingsCustomRenderSettings
SaveFormatintGets the save file format. The value of the property is SaveFormat integer constant.
ClearDatabooleanMake the workbook empty after saving the file.
CachedFileFolderStringThe cached file folder is used to store some large data.
ValidateMergedAreasbooleanIndicates whether validate merged cells before saving the file. The default value is false.
MergeAreasbooleanIndicates whether merge the areas of conditional formatting and validation before saving the file. The default value is
CreateDirectorybooleanIf true and the directory does not exist, the directory will be automatically created before saving the file. The defaul
SortNamesbooleanIndicates whether sorting defined names before saving file.
SortExternalNamesbooleanIndicates whether sorting external defined names before saving file.
RefreshChartCachebooleanIndicates whether refreshing chart cache data
WarningCallbackIWarningCallbackGets or sets warning callback.
CheckExcelRestrictionboolean
UpdateSmartArtbooleanIndicates whether updating smart art setting. The default value is false. Only effects after calling Shape.GetResultOfSm
EncryptDocumentPropertiesboolean

OfdSaveOptions()

OfdSaveOptions.DefaultFont property

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.

Type: String

OfdSaveOptions.CheckWorkbookDefaultFont property

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. Default is true.

Type: boolean

OfdSaveOptions.CheckFontCompatibility property

Indicates whether to check font compatibility for every character in text. 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;

Type: boolean

OfdSaveOptions.IsFontSubstitutionCharGranularity property

Indicates whether to only substitute the font of character when the cell font is not compatibility for it. Default is false. We will try default font of Workbook and PdfSaveOption/system for cell font first.

Type: boolean

OfdSaveOptions.OnePagePerSheet property

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.

Type: boolean

OfdSaveOptions.AllColumnsInOnePagePerSheet property

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.

Type: boolean

OfdSaveOptions.IgnoreError property

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

Type: boolean

OfdSaveOptions.OutputBlankPageWhenNothingToPrint property

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

Type: boolean

OfdSaveOptions.PageIndex property

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

Type: int

OfdSaveOptions.PageCount property

Gets or sets the number of pages to save. Default is System.Int32.MaxValue which means all pages will be rendered..

Type: int

OfdSaveOptions.PrintingPageType property

Indicates which pages will not be printed. The value of the property is PrintingPageType integer constant. 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.

Type: int

OfdSaveOptions.GridlineType property

Gets or sets gridline type. The value of the property is GridlineType integer constant. Default is Dotted type.

Type: int

OfdSaveOptions.GridlineColor property

Type: Color

OfdSaveOptions.TextCrossType property

Gets or sets displaying text type when the text width is larger than cell width. The value of the property is TextCrossType integer constant.

Type: int

OfdSaveOptions.DefaultEditLanguage property

Gets or sets default edit language. The value of the property is DefaultEditLanguage integer constant. It may display/render different layouts for text paragraph when different edit languages is set. Default is DefaultEditLanguage.AUTO .

Type: int

OfdSaveOptions.SheetSet property

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

Type: SheetSet

OfdSaveOptions.DrawObjectEventHandler property

Implements this interface to get DrawObject and Bound when rendering.

Type: DrawObjectEventHandler

OfdSaveOptions.PageSavingCallback property

Control/Indicate progress of page saving process.

Type: IPageSavingCallback

OfdSaveOptions.EmfRenderSetting property

Setting for rendering Emf metafile. The value of the property is EmfRenderSetting integer constant. 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 EmfRenderSetting.EMF_PLUS_PREFER is set, then EMF+ records will be parsed while rendering to page, otherwise only EMF records will be parsed. Default value is EmfRenderSetting.EMF_ONLY .

Type: int

OfdSaveOptions.CustomRenderSettings property

Type: CustomRenderSettings

OfdSaveOptions.SaveFormat property

Gets the save file format. The value of the property is SaveFormat integer constant.

Type: int

OfdSaveOptions.ClearData property

Make the workbook empty after saving the file.

Type: boolean

OfdSaveOptions.CachedFileFolder property

The cached file folder is used to store some large data.

Type: String

OfdSaveOptions.ValidateMergedAreas property

Indicates whether validate merged cells before saving the file. The default value is false.

Type: boolean

OfdSaveOptions.MergeAreas property

Indicates whether merge the areas of conditional formatting and validation before saving the file. The default value is false.

Type: boolean

OfdSaveOptions.CreateDirectory property

If true and the directory does not exist, the directory will be automatically created before saving the file. The default value is false.

Type: boolean

OfdSaveOptions.SortNames property

Indicates whether sorting defined names before saving file.

Type: boolean

OfdSaveOptions.SortExternalNames property

Indicates whether sorting external defined names before saving file.

Type: boolean

OfdSaveOptions.RefreshChartCache property

Indicates whether refreshing chart cache data

Type: boolean

OfdSaveOptions.WarningCallback property

Gets or sets warning callback.

Type: IWarningCallback

OfdSaveOptions.CheckExcelRestriction property

Type: boolean

OfdSaveOptions.UpdateSmartArt property

Indicates whether updating smart art setting. The default value is false. Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.

Type: boolean

OfdSaveOptions.EncryptDocumentProperties property

Type: boolean