SqlScriptSaveOptions
SqlScriptSaveOptions class
Represents the options of saving sql.
Constructors
| Name | Description |
|---|---|
| SqlScriptSaveOptions | Creates options for saving sql file. |
Properties
| Name | Type | Description |
|---|---|---|
| CheckIfTableExists | boolean | Check if the table name exists before creating |
| ColumnTypeMap | SqlScriptColumnTypeMap | Gets and sets the map of column type for different database. |
| CheckAllDataForColumnType | boolean | Check all data to find columns’ data type. The default value is false, we only check the first row for performance. If t |
| AddBlankLineBetweenRows | boolean | Insert blank line between each data. If Separator is ‘\n’ , it’s better to set this property as true to increase readabi |
| Separator | char | Gets and sets character separator of sql script. Only can be ’ ’ or ‘\n’. If the |
| OperatorType | int | Gets and sets the operator type of sql. The value of the property is SqlScriptOperatorType integer constant. |
| PrimaryKey | int | Represents which column is primary key of the data table. |
| CreateTable | boolean | Indicates whether exporting sql of creating table. |
| IdName | String | Gets and sets the name of id column. If this property is set , a column will be inserted with automatical increment int |
| StartId | int | Gets and sets the start id. Only works when IdName is set. |
| TableName | String | Gets and sets the table name. |
| ExportAsString | boolean | Indicates whether exporting all data as string value. |
| SheetIndexes | int[] | Represents the indexes of exported sheets. |
| ExportArea | CellArea | Gets or sets the exporting range. |
| HasHeaderRow | boolean | Indicates whether the range contains header row. |
| 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 |
| WarningCallback | IWarningCallback | Gets or sets warning callback. |
| CheckExcelRestriction | boolean | |
| UpdateSmartArt | boolean | Indicates whether updating smart art setting. The default value is false. Only effects after calling Shape.GetResultOfSm |
| EncryptDocumentProperties | boolean |
SqlScriptSaveOptions()
Creates options for saving sql file.
SqlScriptSaveOptions.CheckIfTableExists property
Check if the table name exists before creating
Type: boolean
SqlScriptSaveOptions.ColumnTypeMap property
Gets and sets the map of column type for different database.
Type: SqlScriptColumnTypeMap
SqlScriptSaveOptions.CheckAllDataForColumnType property
Check all data to find columns’ data type. The default value is false, we only check the first row for performance. If this property is true and the columns contains mixed value type, the columns’ type will be text.
Type: boolean
SqlScriptSaveOptions.AddBlankLineBetweenRows property
Insert blank line between each data. If Separator is ‘\n’ , it’s better to set this property as true to increase readability.
Type: boolean
SqlScriptSaveOptions.Separator property
Gets and sets character separator of sql script. Only can be ’ ’ or ‘\n’. If the
Type: char
SqlScriptSaveOptions.OperatorType property
Gets and sets the operator type of sql. The value of the property is SqlScriptOperatorType integer constant.
Type: int
SqlScriptSaveOptions.PrimaryKey property
Represents which column is primary key of the data table.
Type: int
SqlScriptSaveOptions.CreateTable property
Indicates whether exporting sql of creating table.
Type: boolean
SqlScriptSaveOptions.IdName property
Gets and sets the name of id column. If this property is set , a column will be inserted with automatical increment int value.
Type: String
SqlScriptSaveOptions.StartId property
Gets and sets the start id. Only works when IdName is set.
Type: int
SqlScriptSaveOptions.TableName property
Gets and sets the table name.
Type: String
SqlScriptSaveOptions.ExportAsString property
Indicates whether exporting all data as string value.
Type: boolean
SqlScriptSaveOptions.SheetIndexes property
Represents the indexes of exported sheets.
Type: int[]
SqlScriptSaveOptions.ExportArea property
Gets or sets the exporting range.
Type: CellArea
SqlScriptSaveOptions.HasHeaderRow property
Indicates whether the range contains header row.
Type: boolean
SqlScriptSaveOptions.SaveFormat property
Gets the save file format. The value of the property is SaveFormat integer constant.
Type: int
SqlScriptSaveOptions.ClearData property
Make the workbook empty after saving the file.
Type: boolean
SqlScriptSaveOptions.CachedFileFolder property
The cached file folder is used to store some large data.
Type: String
SqlScriptSaveOptions.ValidateMergedAreas property
Indicates whether validate merged cells before saving the file. The default value is false.
Type: boolean
SqlScriptSaveOptions.MergeAreas property
Indicates whether merge the areas of conditional formatting and validation before saving the file. The default value is false.
Type: boolean
SqlScriptSaveOptions.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
SqlScriptSaveOptions.SortNames property
Indicates whether sorting defined names before saving file.
Type: boolean
SqlScriptSaveOptions.SortExternalNames property
Indicates whether sorting external defined names before saving file.
Type: boolean
SqlScriptSaveOptions.RefreshChartCache property
Indicates whether refreshing chart cache data
Type: boolean
SqlScriptSaveOptions.WarningCallback property
Gets or sets warning callback.
Type: IWarningCallback
SqlScriptSaveOptions.CheckExcelRestriction property
Type: boolean
SqlScriptSaveOptions.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
SqlScriptSaveOptions.EncryptDocumentProperties property
Type: boolean