aspose.cells

Class SqlScriptSaveOptions

Represents the options of saving sql.

Constructor Summary
SqlScriptSaveOptions()
Creates options for saving sql file.
 
Property Getters/Setters Summary
functiongetAddBlankLineBetweenRows()
function
           Insert blank line between each data.
functiongetCachedFileFolder()
function
           The cached file folder is used to store some large data.
functiongetCheckAllDataForColumnType()
function
           Check all data to find columns' data type.
functiongetCheckIfTableExists()
function
           Check if the table name exists before creating
functiongetClearData()
function
           Make the workbook empty after saving the file.
functiongetColumnTypeMap()
function
           Gets and sets the map of column type for different database.
functiongetCreateDirectory()
function
           If true and the directory does not exist, the directory will be automatically created before saving the file.
functiongetCreateTable()
function
           Indicates whether exporting sql of creating table.
functiongetExportArea()
function
           Gets or sets the exporting range.
functiongetExportAsString()
function
           Indicates whether exporting all data as string value.
functionhasHeaderRow()
function
           Indicates whether the range contains header row.
functiongetIdName()
function
setIdName(value)
           Gets and sets the name of id column.
functiongetMergeAreas()
function
           Indicates whether merge the areas of conditional formatting and validation before saving the file.
functiongetOperatorType()
function
           Gets and sets the operator type of sql. The value of the property is SqlScriptOperatorType integer constant.
functiongetPrimaryKey()
function
           Represents which column is primary key of the data table.
functiongetRefreshChartCache()
function
           Indicates whether refreshing chart cache data
functiongetSaveFormat()
Gets the save file format. The value of the property is SaveFormat integer constant.
functiongetSeparator()
function
           Gets and sets character separator of sql script.
functiongetSheetIndexes()
function
           Represents the indexes of exported sheets.
functiongetSortExternalNames()
function
           Indicates whether sorting external defined names before saving file.
functiongetSortNames()
function
           Indicates whether sorting defined names before saving file.
functiongetStartId()
function
setStartId(value)
           Gets and sets the start id.
functiongetTableName()
function
           Gets and sets the table name.
functiongetUpdateSmartArt()
function
           Indicates whether updating smart art setting. The default value is false.
functiongetValidateMergedAreas()
function
           Indicates whether validate merged cells before saving the file.
functiongetWarningCallback()
function
           Gets or sets warning callback.
 

    • Constructor Detail

      • SqlScriptSaveOptions

        function SqlScriptSaveOptions()
        Creates options for saving sql file.
    • Property Getters/Setters Detail

      • getCheckIfTableExists/setCheckIfTableExists : boolean 

        function getCheckIfTableExists() / function setCheckIfTableExists(value)
        
        Check if the table name exists before creating
      • getColumnTypeMap/setColumnTypeMap : SqlScriptColumnTypeMap 

        function getColumnTypeMap() / function setColumnTypeMap(value)
        
        Gets and sets the map of column type for different database.
      • getCheckAllDataForColumnType/setCheckAllDataForColumnType : boolean 

        function getCheckAllDataForColumnType() / function 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 

        function getAddBlankLineBetweenRows() / function 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 

        function getSeparator() / function setSeparator(value)
        
        Gets and sets character separator of sql script. Only can be ' ' or '\n'. If the
      • getOperatorType/setOperatorType : Number 

        function getOperatorType() / function setOperatorType(value)
        
        Gets and sets the operator type of sql. The value of the property is SqlScriptOperatorType integer constant.
      • getPrimaryKey/setPrimaryKey : Number 

        function getPrimaryKey() / function setPrimaryKey(value)
        
        Represents which column is primary key of the data table.
      • getCreateTable/setCreateTable : boolean 

        function getCreateTable() / function setCreateTable(value)
        
        Indicates whether exporting sql of creating table.
      • getIdName/setIdName : String 

        function getIdName() / function 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 : Number 

        function getStartId() / function setStartId(value)
        
        Gets and sets the start id. Only works when IdName is set.
      • getTableName/setTableName : String 

        function getTableName() / function setTableName(value)
        
        Gets and sets the table name.
      • getExportAsString/setExportAsString : boolean 

        function getExportAsString() / function setExportAsString(value)
        
        Indicates whether exporting all data as string value.
      • getSheetIndexes/setSheetIndexes : int[] 

        function getSheetIndexes() / function setSheetIndexes(value)
        
        Represents the indexes of exported sheets.
      • getExportArea/setExportArea : CellArea 

        function getExportArea() / function setExportArea(value)
        
        Gets or sets the exporting range.
      • hasHeaderRow/setHasHeaderRow : boolean 

        function hasHeaderRow() / function setHasHeaderRow(value)
        
        Indicates whether the range contains header row.
      • getSaveFormat : Number 

        function getSaveFormat()
        
        Gets the save file format. The value of the property is SaveFormat integer constant.
      • getClearData/setClearData : boolean 

        function getClearData() / function setClearData(value)
        
        Make the workbook empty after saving the file.
      • getCachedFileFolder/setCachedFileFolder : String 

        function getCachedFileFolder() / function setCachedFileFolder(value)
        
        The cached file folder is used to store some large data.
      • getValidateMergedAreas/setValidateMergedAreas : boolean 

        function getValidateMergedAreas() / function setValidateMergedAreas(value)
        
        Indicates whether validate merged cells before saving the file. The default value is false.
      • getMergeAreas/setMergeAreas : boolean 

        function getMergeAreas() / function setMergeAreas(value)
        
        Indicates whether merge the areas of conditional formatting and validation before saving the file. The default value is false.
      • getCreateDirectory/setCreateDirectory : boolean 

        function getCreateDirectory() / function 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 

        function getSortNames() / function setSortNames(value)
        
        Indicates whether sorting defined names before saving file.
      • getSortExternalNames/setSortExternalNames : boolean 

        function getSortExternalNames() / function setSortExternalNames(value)
        
        Indicates whether sorting external defined names before saving file.
      • getRefreshChartCache/setRefreshChartCache : boolean 

        function getRefreshChartCache() / function setRefreshChartCache(value)
        
        Indicates whether refreshing chart cache data
      • getWarningCallback/setWarningCallback : IWarningCallback 

        function getWarningCallback() / function setWarningCallback(value)
        
        Gets or sets warning callback.
      • getUpdateSmartArt/setUpdateSmartArt : boolean 

        function getUpdateSmartArt() / function 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.