ImageSaveOptions
ImageSaveOptions class
Represents image save options. For advanced usage, please use WorkbookRender or SheetRender .
Constructors
| Name | Description |
|---|---|
| ImageSaveOptions | Creates the options for saving image file. The default type is Tiff. |
| ImageSaveOptions | Creates the options for saving image file. |
Properties
| Name | Type | Description |
|---|---|---|
| ImageOrPrintOptions | ImageOrPrintOptions | Additional image creation options. For advanced usage, please use WorkbookRender or SheetRender . |
| StreamProvider | IStreamProvider | Gets or sets the IStreamProvider for exporting objects. If saving as Tiff, this property is ignored. Otherwise, if more |
| SaveFormat | int | Gets the save file format. The value of the property is SaveFormat integer constant. |
| ClearData | boolean | Make the workbook empty after saving the file. |
| CachedFileFolder | String | The cached file folder is used to store some large data. |
| ValidateMergedAreas | boolean | Indicates whether validate merged cells before saving the file. The default value is false. |
| MergeAreas | boolean | Indicates whether merge the areas of conditional formatting and validation before saving the file. The default value is |
| CreateDirectory | boolean | If true and the directory does not exist, the directory will be automatically created before saving the file. The defaul |
| 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 |
| CheckExcelRestriction | boolean | |
| UpdateSmartArt | boolean | Indicates whether updating smart art setting. The default value is false. Only effects after calling Shape.GetResultOfSm |
| EncryptDocumentProperties | boolean |
ImageSaveOptions() (1 of 2)
Creates the options for saving image file. The default type is Tiff.
ImageSaveOptions(saveFormat) (2 of 2)
Creates the options for saving image file.
| Parameter | Type | Description |
|---|---|---|
| saveFormat | int | A SaveFormat value. The file format. It should be one of following types: SaveFormat.TIFF , SaveFormat.SVG , SaveFormat.BMP , SaveFormat.PNG , SaveFormat.JPG , SaveFormat.EMF or SaveFormat.GIF , otherwise the saved format will be set as SaveFormat.TIFF automatically. |
ImageSaveOptions.ImageOrPrintOptions property
Additional image creation options. For advanced usage, please use WorkbookRender or SheetRender .
Type: ImageOrPrintOptions
ImageSaveOptions.StreamProvider property
Gets or sets the IStreamProvider for exporting objects. If saving as Tiff, this property is ignored. Otherwise, if more than one image should be saving, we will write other images by this. For advanced usage, please use WorkbookRender or SheetRender .
Type: IStreamProvider
ImageSaveOptions.SaveFormat property
Gets the save file format. The value of the property is SaveFormat integer constant.
Type: int
ImageSaveOptions.ClearData property
Make the workbook empty after saving the file.
Type: boolean
ImageSaveOptions.CachedFileFolder property
The cached file folder is used to store some large data.
Type: String
ImageSaveOptions.ValidateMergedAreas property
Indicates whether validate merged cells before saving the file. The default value is false.
Type: boolean
ImageSaveOptions.MergeAreas property
Indicates whether merge the areas of conditional formatting and validation before saving the file. The default value is false.
Type: boolean
ImageSaveOptions.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
ImageSaveOptions.SortNames property
Indicates whether sorting defined names before saving file.
Type: boolean
ImageSaveOptions.SortExternalNames property
Indicates whether sorting external defined names before saving file.
Type: boolean
ImageSaveOptions.RefreshChartCache property
Indicates whether refreshing chart cache data
Type: boolean
ImageSaveOptions.CheckExcelRestriction property
Type: boolean
ImageSaveOptions.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
ImageSaveOptions.EncryptDocumentProperties property
Type: boolean