SqlScriptSaveOptions

Inheritance: java.lang.Object, com.aspose.cells.SaveOptions

public class SqlScriptSaveOptions extends SaveOptions

Represents the options of saving sql.

Constructors

Constructor	Description
SqlScriptSaveOptions()	Creates options for saving sql file.

Methods

Method	Description
equals(Object arg0)
getAddBlankLineBetweenRows()	Insert blank line between each data.
getCachedFileFolder()	The cached file folder is used to store some large data.
getCheckAllDataForColumnType()	Check all data to find columns’ data type.
getCheckExcelRestriction()	Whether check restriction of excel file when user modify cells related objects.
getCheckIfTableExists()	Check if the table name exists before creating
getClass()
getClearData()	Make the workbook empty after saving the file.
getColumnTypeMap()	Gets the map of column type for different database.
getCreateDirectory()	If true and the directory does not exist, the directory will be automatically created before saving the file.
getCreateTable()	Indicates whether exporting sql of creating table.
getEncryptDocumentProperties()	Indicates whether encrypt document properties when saving as .xls file.
getExportArea()	Gets the exporting range.
getExportAsString()	Indicates whether exporting all data as string value.
getIdName()	Gets the name of id column.
getMergeAreas()	Indicates whether merge the areas of conditional formatting and validation before saving the file.
getOperatorType()	Gets the operator type of sql.
getPrimaryKey()	Represents which column is primary key of the data table.
getRefreshChartCache()	Indicates whether refreshing chart cache data
getSaveFormat()	Gets the save file format.
getSeparator()	Gets character separator of sql script.
getSheetIndexes()	Represents the indexes of exported sheets.
getSortExternalNames()	Indicates whether sorting external defined names before saving file.
getSortNames()	Indicates whether sorting defined names before saving file.
getStartId()	Gets the start id.
getTableName()	Gets the table name.
getUpdateSmartArt()	Indicates whether updating smart art setting.
getValidateMergedAreas()	Indicates whether validate merged cells before saving the file.
getWarningCallback()	Gets warning callback.
hasHeaderRow()	Indicates whether the range contains header row.
hashCode()
notify()
notifyAll()
setAddBlankLineBetweenRows(boolean value)	Insert blank line between each data.
setCachedFileFolder(String value)	The cached file folder is used to store some large data.
setCheckAllDataForColumnType(boolean value)	Check all data to find columns’ data type.
setCheckExcelRestriction(boolean value)	Whether check restriction of excel file when user modify cells related objects.
setCheckIfTableExists(boolean value)	Check if the table name exists before creating
setClearData(boolean value)	Make the workbook empty after saving the file.
setColumnTypeMap(SqlScriptColumnTypeMap value)	Sets the map of column type for different database.
setCreateDirectory(boolean value)	If true and the directory does not exist, the directory will be automatically created before saving the file.
setCreateTable(boolean value)	Indicates whether exporting sql of creating table.
setEncryptDocumentProperties(boolean value)	Indicates whether encrypt document properties when saving as .xls file.
setExportArea(CellArea value)	Sets the exporting range.
setExportAsString(boolean value)	Indicates whether exporting all data as string value.
setHasHeaderRow(boolean value)	Indicates whether the range contains header row.
setIdName(String value)	Sets the name of id column.
setMergeAreas(boolean value)	Indicates whether merge the areas of conditional formatting and validation before saving the file.
setOperatorType(int value)	Sets the operator type of sql.
setPrimaryKey(int value)	Represents which column is primary key of the data table.
setRefreshChartCache(boolean value)	Indicates whether refreshing chart cache data
setSeparator(char value)	Sets character separator of sql script.
setSheetIndexes(int[] value)	Represents the indexes of exported sheets.
setSortExternalNames(boolean value)	Indicates whether sorting external defined names before saving file.
setSortNames(boolean value)	Indicates whether sorting defined names before saving file.
setStartId(int value)	Sets the start id.
setTableName(String value)	Sets the table name.
setUpdateSmartArt(boolean value)	Indicates whether updating smart art setting.
setValidateMergedAreas(boolean value)	Indicates whether validate merged cells before saving the file.
setWarningCallback(IWarningCallback value)	Sets warning callback.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

SqlScriptSaveOptions()

public SqlScriptSaveOptions()

Creates options for saving sql file.

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

getAddBlankLineBetweenRows()

public boolean getAddBlankLineBetweenRows()

Insert blank line between each data.

Remarks

If getSeparator() is ‘\n’ , it’s better to set this property as true to increase readability.

Returns: boolean

getCachedFileFolder()

public String getCachedFileFolder()

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

Returns: java.lang.String

getCheckAllDataForColumnType()

public boolean getCheckAllDataForColumnType()

Check all data to find columns’ data type.

Remarks

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.

Returns: boolean

getCheckExcelRestriction()

public boolean getCheckExcelRestriction()

Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K, it will be truncated.

Returns: boolean

getCheckIfTableExists()

public boolean getCheckIfTableExists()

Check if the table name exists before creating

Returns: boolean

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getClearData()

public boolean getClearData()

Make the workbook empty after saving the file.

Returns: boolean

getColumnTypeMap()

public SqlScriptColumnTypeMap getColumnTypeMap()

Gets the map of column type for different database.

Returns: SqlScriptColumnTypeMap

getCreateDirectory()

public boolean getCreateDirectory()

If true and the directory does not exist, the directory will be automatically created before saving the file.

Remarks

The default value is false.

Returns: boolean

getCreateTable()

public boolean getCreateTable()

Indicates whether exporting sql of creating table.

Returns: boolean

getEncryptDocumentProperties()

public boolean getEncryptDocumentProperties()

Indicates whether encrypt document properties when saving as .xls file. The default value is true.

Remarks

Only for .xls,xlsx,xlsb and xlsm file.

Returns: boolean

getExportArea()

public CellArea getExportArea()

Gets the exporting range.

Returns: CellArea

getExportAsString()

public boolean getExportAsString()

Indicates whether exporting all data as string value.

Returns: boolean

getIdName()

public String getIdName()

Gets the name of id column.

Remarks

If this property is set , a column will be inserted with automatical increment int value.

Returns: java.lang.String

getMergeAreas()

public boolean getMergeAreas()

Indicates whether merge the areas of conditional formatting and validation before saving the file.

Remarks

The default value is false.

Returns: boolean

getOperatorType()

public int getOperatorType()

Gets the operator type of sql.

See SqlScriptOperatorType.

Returns: int

getPrimaryKey()

public int getPrimaryKey()

Represents which column is primary key of the data table.

Returns: int

getRefreshChartCache()

public boolean getRefreshChartCache()

Indicates whether refreshing chart cache data

Returns: boolean

getSaveFormat()

public int getSaveFormat()

Gets the save file format.

See SaveFormat.

Returns: int

getSeparator()

public char getSeparator()

Gets character separator of sql script.

Remarks

Only can be ’ ’ or ‘\n’. If the

Returns: char

getSheetIndexes()

public int[] getSheetIndexes()

Represents the indexes of exported sheets.

Returns: int[]

getSortExternalNames()

public boolean getSortExternalNames()

Indicates whether sorting external defined names before saving file.

Returns: boolean

getSortNames()

public boolean getSortNames()

Indicates whether sorting defined names before saving file.

Returns: boolean

getStartId()

public int getStartId()

Gets the start id.

Remarks

Only works when getIdName() is set.

Returns: int

getTableName()

public String getTableName()

Gets the table name.

Returns: java.lang.String

getUpdateSmartArt()

public boolean getUpdateSmartArt()

Indicates whether updating smart art setting. The default value is false.

Remarks

Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.

Returns: boolean

getValidateMergedAreas()

public boolean getValidateMergedAreas()

Indicates whether validate merged cells before saving the file.

Remarks

The default value is false.

Returns: boolean

getWarningCallback()

public IWarningCallback getWarningCallback()

Gets warning callback.

Returns: IWarningCallback

hasHeaderRow()

public boolean hasHeaderRow()

Indicates whether the range contains header row.

Returns: boolean

hashCode()

public native int hashCode()

Returns: int

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setAddBlankLineBetweenRows(boolean value)

public void setAddBlankLineBetweenRows(boolean value)

Insert blank line between each data.

Remarks

If getSeparator() is ‘\n’ , it’s better to set this property as true to increase readability.

Parameters:

Parameter	Type	Description
value	boolean

setCachedFileFolder(String value)

public void setCachedFileFolder(String value)

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

Parameters:

Parameter	Type	Description
value	java.lang.String

setCheckAllDataForColumnType(boolean value)

public void setCheckAllDataForColumnType(boolean value)

Check all data to find columns’ data type.

Remarks

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.

Parameters:

Parameter	Type	Description
value	boolean

setCheckExcelRestriction(boolean value)

public void setCheckExcelRestriction(boolean value)

Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K, it will be truncated.

Parameters:

Parameter	Type	Description
value	boolean

setCheckIfTableExists(boolean value)

public void setCheckIfTableExists(boolean value)

Check if the table name exists before creating

Parameters:

Parameter	Type	Description
value	boolean

setClearData(boolean value)

public void setClearData(boolean value)

Make the workbook empty after saving the file.

Parameters:

Parameter	Type	Description
value	boolean

setColumnTypeMap(SqlScriptColumnTypeMap value)

public void setColumnTypeMap(SqlScriptColumnTypeMap value)

Sets the map of column type for different database.

Parameters:

Parameter	Type	Description
value	SqlScriptColumnTypeMap

setCreateDirectory(boolean value)

public void setCreateDirectory(boolean value)

If true and the directory does not exist, the directory will be automatically created before saving the file.

Remarks

The default value is false.

Parameters:

Parameter	Type	Description
value	boolean

setCreateTable(boolean value)

public void setCreateTable(boolean value)

Indicates whether exporting sql of creating table.

Parameters:

Parameter	Type	Description
value	boolean

setEncryptDocumentProperties(boolean value)

public void setEncryptDocumentProperties(boolean value)

Indicates whether encrypt document properties when saving as .xls file. The default value is true.

Remarks

Only for .xls,xlsx,xlsb and xlsm file.

Parameters:

Parameter	Type	Description
value	boolean

setExportArea(CellArea value)

public void setExportArea(CellArea value)

Sets the exporting range.

Parameters:

Parameter	Type	Description
value	CellArea

setExportAsString(boolean value)

public void setExportAsString(boolean value)

Indicates whether exporting all data as string value.

Parameters:

Parameter	Type	Description
value	boolean

setHasHeaderRow(boolean value)

public void setHasHeaderRow(boolean value)

Indicates whether the range contains header row.

Parameters:

Parameter	Type	Description
value	boolean

setIdName(String value)

public void setIdName(String value)

Sets the name of id column.

Remarks

If this property is set , a column will be inserted with automatical increment int value.

Parameters:

Parameter	Type	Description
value	java.lang.String

setMergeAreas(boolean value)

public void setMergeAreas(boolean value)

Indicates whether merge the areas of conditional formatting and validation before saving the file.

Remarks

The default value is false.

Parameters:

Parameter	Type	Description
value	boolean

setOperatorType(int value)

public void setOperatorType(int value)

Sets the operator type of sql.

See SqlScriptOperatorType.

Parameters:

Parameter	Type	Description
value	int

setPrimaryKey(int value)

public void setPrimaryKey(int value)

Represents which column is primary key of the data table.

Parameters:

Parameter	Type	Description
value	int

setRefreshChartCache(boolean value)

public void setRefreshChartCache(boolean value)

Indicates whether refreshing chart cache data

Parameters:

Parameter	Type	Description
value	boolean

setSeparator(char value)

public void setSeparator(char value)

Sets character separator of sql script.

Remarks

Only can be ’ ’ or ‘\n’. If the

Parameters:

Parameter	Type	Description
value	char

setSheetIndexes(int[] value)

public void setSheetIndexes(int[] value)

Represents the indexes of exported sheets.

Parameters:

Parameter	Type	Description
value	int[]

setSortExternalNames(boolean value)

public void setSortExternalNames(boolean value)

Indicates whether sorting external defined names before saving file.

Parameters:

Parameter	Type	Description
value	boolean

setSortNames(boolean value)

public void setSortNames(boolean value)

Indicates whether sorting defined names before saving file.

Parameters:

Parameter	Type	Description
value	boolean

setStartId(int value)

public void setStartId(int value)

Sets the start id.

Remarks

Only works when getIdName() is set.

Parameters:

Parameter	Type	Description
value	int

setTableName(String value)

public void setTableName(String value)

Sets the table name.

Parameters:

Parameter	Type	Description
value	java.lang.String

setUpdateSmartArt(boolean value)

public void setUpdateSmartArt(boolean value)

Indicates whether updating smart art setting. The default value is false.

Remarks

Only effects after calling Shape.GetResultOfSmartArt() method and the cached shapes exist in the template file.

Parameters:

Parameter	Type	Description
value	boolean

setValidateMergedAreas(boolean value)

public void setValidateMergedAreas(boolean value)

Indicates whether validate merged cells before saving the file.

Remarks

The default value is false.

Parameters:

Parameter	Type	Description
value	boolean

setWarningCallback(IWarningCallback value)

public void setWarningCallback(IWarningCallback value)

Sets warning callback.

Parameters:

Parameter	Type	Description
value	IWarningCallback

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int