asposecells.api

Classes

Constants

Class SqlScriptSaveOptions

Represents the options of saving sql.

Constructor Summary
`SqlScriptSaveOptions()` Creates options for saving sql file.

Property Getters/Setters Summary
`method`	`getAddBlankLineBetweenRows()`
`method`	`setAddBlankLineBetweenRows(value)`
	Insert blank line between each data.
`method`	`getCachedFileFolder()`
`method`	`setCachedFileFolder(value)`
	The cached file folder is used to store some large data.
`method`	`getCheckAllDataForColumnType()`
`method`	`setCheckAllDataForColumnType(value)`
	Check all data to find columns' data type.
`method`	`getCheckIfTableExists()`
`method`	`setCheckIfTableExists(value)`
	Check if the table name exists before creating
`method`	`getClearData()`
`method`	`setClearData(value)`
	Make the workbook empty after saving the file.
`method`	`getColumnTypeMap()`
`method`	`setColumnTypeMap(value)`
	Gets and sets the map of column type for different database.
`method`	`getCreateDirectory()`
`method`	`setCreateDirectory(value)`
	If true and the directory does not exist, the directory will be automatically created before saving the file.
`method`	`getCreateTable()`
`method`	`setCreateTable(value)`
	Indicates whether exporting sql of creating table.
`method`	`getExportArea()`
`method`	`setExportArea(value)`
	Gets or sets the exporting range.
`method`	`getExportAsString()`
`method`	`setExportAsString(value)`
	Indicates whether exporting all data as string value.
`method`	`hasHeaderRow()`
`method`	`setHasHeaderRow(value)`
	Indicates whether the range contains header row.
`method`	`getIdName()`
`method`	`setIdName(value)`
	Gets and sets the name of id column.
`method`	`getMergeAreas()`
`method`	`setMergeAreas(value)`
	Indicates whether merge the areas of conditional formatting and validation before saving the file.
`method`	`getOperatorType()`
`method`	`setOperatorType(value)`
	Gets and sets the operator type of sql. The value of the property is SqlScriptOperatorType integer constant.
`method`	`getPrimaryKey()`
`method`	`setPrimaryKey(value)`
	Represents which column is primary key of the data table.
`method`	`getRefreshChartCache()`
`method`	`setRefreshChartCache(value)`
	Indicates whether refreshing chart cache data
`method`	`getSaveFormat()`
	Gets the save file format. The value of the property is SaveFormat integer constant.
`method`	`getSeparator()`
`method`	`setSeparator(value)`
	Gets and sets character separator of sql script.
`method`	`getSheetIndexes()`
`method`	`setSheetIndexes(value)`
	Represents the indexes of exported sheets.
`method`	`getSortExternalNames()`
`method`	`setSortExternalNames(value)`
	Indicates whether sorting external defined names before saving file.
`method`	`getSortNames()`
`method`	`setSortNames(value)`
	Indicates whether sorting defined names before saving file.
`method`	`getStartId()`
`method`	`setStartId(value)`
	Gets and sets the start id.
`method`	`getTableName()`
`method`	`setTableName(value)`
	Gets and sets the table name.
`method`	`getUpdateSmartArt()`
`method`	`setUpdateSmartArt(value)`
	Indicates whether updating smart art setting. The default value is false.
`method`	`getValidateMergedAreas()`
`method`	`setValidateMergedAreas(value)`
	Indicates whether validate merged cells before saving the file.
`method`	`getWarningCallback()`
`method`	`setWarningCallback(value)`
	Gets or sets warning callback.

- Constructor Detail
  - SqlScriptSaveOptions
```
SqlScriptSaveOptions()
```
    Creates options for saving sql file.
- Property Getters/Setters Detail
  - getCheckIfTableExists/setCheckIfTableExists : boolean
```
boolean getCheckIfTableExists() / setCheckIfTableExists(value)
```
    Check if the table name exists before creating
  - getColumnTypeMap/setColumnTypeMap : SqlScriptColumnTypeMap
```
SqlScriptColumnTypeMap getColumnTypeMap() / setColumnTypeMap(value)
```
    Gets and sets the map of column type for different database.
  - getCheckAllDataForColumnType/setCheckAllDataForColumnType : boolean
```
boolean getCheckAllDataForColumnType() / setCheckAllDataForColumnType(value)
```
    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.
  - getAddBlankLineBetweenRows/setAddBlankLineBetweenRows : boolean
```
boolean getAddBlankLineBetweenRows() / setAddBlankLineBetweenRows(value)
```
    Insert blank line between each data.
    If Separator is '\n' , it's better to set this property as true to increase readability.
  - getSeparator/setSeparator : char
```
char getSeparator() / setSeparator(value)
```
    Gets and sets character separator of sql script.
    Only can be ' ' or '\n'. If the
  - getOperatorType/setOperatorType : int
```
int getOperatorType() / setOperatorType(value)
```
    Gets and sets the operator type of sql. The value of the property is SqlScriptOperatorType integer constant.
  - getPrimaryKey/setPrimaryKey : int
```
int getPrimaryKey() / setPrimaryKey(value)
```
    Represents which column is primary key of the data table.
  - getCreateTable/setCreateTable : boolean
```
boolean getCreateTable() / setCreateTable(value)
```
    Indicates whether exporting sql of creating table.
  - getIdName/setIdName : String
```
String getIdName() / setIdName(value)
```
    Gets and sets the name of id column.
    If this property is set , a column will be inserted with automatical increment int value.
  - getStartId/setStartId : int
```
int getStartId() / setStartId(value)
```
    Gets and sets the start id.
    Only works when IdName is set.
  - getTableName/setTableName : String
```
String getTableName() / setTableName(value)
```
    Gets and sets the table name.
  - getExportAsString/setExportAsString : boolean
```
boolean getExportAsString() / setExportAsString(value)
```
    Indicates whether exporting all data as string value.
  - getSheetIndexes/setSheetIndexes : int[]
```
int[] getSheetIndexes() / setSheetIndexes(value)
```
    Represents the indexes of exported sheets.
  - getExportArea/setExportArea : CellArea
```
CellArea getExportArea() / setExportArea(value)
```
    Gets or sets the exporting range.
  - hasHeaderRow/setHasHeaderRow : boolean
```
boolean hasHeaderRow() / setHasHeaderRow(value)
```
    Indicates whether the range contains header row.
  - getSaveFormat : int
```
int getSaveFormat()
```
    Gets the save file format. The value of the property is SaveFormat integer constant.
  - getClearData/setClearData : boolean
```
boolean getClearData() / setClearData(value)
```
    Make the workbook empty after saving the file.
  - getCachedFileFolder/setCachedFileFolder : String
```
String getCachedFileFolder() / setCachedFileFolder(value)
```
    The cached file folder is used to store some large data.
  - getValidateMergedAreas/setValidateMergedAreas : boolean
```
boolean getValidateMergedAreas() / setValidateMergedAreas(value)
```
    Indicates whether validate merged cells before saving the file.
    The default value is false.
  - getMergeAreas/setMergeAreas : boolean
```
boolean getMergeAreas() / setMergeAreas(value)
```
    Indicates whether merge the areas of conditional formatting and validation before saving the file.
    The default value is false.
  - getCreateDirectory/setCreateDirectory : boolean
```
boolean getCreateDirectory() / setCreateDirectory(value)
```
    If true and the directory does not exist, the directory will be automatically created before saving the file.
    The default value is false.
  - getSortNames/setSortNames : boolean
```
boolean getSortNames() / setSortNames(value)
```
    Indicates whether sorting defined names before saving file.
  - getSortExternalNames/setSortExternalNames : boolean
```
boolean getSortExternalNames() / setSortExternalNames(value)
```
    Indicates whether sorting external defined names before saving file.
  - getRefreshChartCache/setRefreshChartCache : boolean
```
boolean getRefreshChartCache() / setRefreshChartCache(value)
```
    Indicates whether refreshing chart cache data
  - getWarningCallback/setWarningCallback : IWarningCallback
```
IWarningCallback getWarningCallback() / setWarningCallback(value)
```
    Gets or sets warning callback.
  - getUpdateSmartArt/setUpdateSmartArt : boolean
```
boolean getUpdateSmartArt() / setUpdateSmartArt(value)
```
    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.

asposecells.api

Classes

Constants

Class SqlScriptSaveOptions

Constructor Detail

SqlScriptSaveOptions

Property Getters/Setters Detail

getCheckIfTableExists/setCheckIfTableExists : boolean

getColumnTypeMap/setColumnTypeMap : SqlScriptColumnTypeMap

getCheckAllDataForColumnType/setCheckAllDataForColumnType : boolean

getAddBlankLineBetweenRows/setAddBlankLineBetweenRows : boolean

getSeparator/setSeparator : char

getOperatorType/setOperatorType : int

getPrimaryKey/setPrimaryKey : int

getCreateTable/setCreateTable : boolean

getIdName/setIdName : String

getStartId/setStartId : int

getTableName/setTableName : String

getExportAsString/setExportAsString : boolean

getSheetIndexes/setSheetIndexes : int[]

getExportArea/setExportArea : CellArea

hasHeaderRow/setHasHeaderRow : boolean

getSaveFormat : int

getClearData/setClearData : boolean

getCachedFileFolder/setCachedFileFolder : String

getValidateMergedAreas/setValidateMergedAreas : boolean

getMergeAreas/setMergeAreas : boolean

getCreateDirectory/setCreateDirectory : boolean

getSortNames/setSortNames : boolean

getSortExternalNames/setSortExternalNames : boolean

getRefreshChartCache/setRefreshChartCache : boolean

getWarningCallback/setWarningCallback : IWarningCallback

getUpdateSmartArt/setUpdateSmartArt : boolean