Aspose::Cells::Saving::SqlScriptSaveOptions class

SqlScriptSaveOptions class

Represents the options of saving sql.

class SqlScriptSaveOptions : public Aspose::Cells::SaveOptions

Methods

MethodDescription
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. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K, it will be truncated.
GetCheckIfTableExists()Check if the table name exists before creating.
GetClearData()Make the workbook empty after saving the file.
GetColumnTypeMap()Gets and sets 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. The default value is true.
GetExportArea()Gets or sets the exporting range.
GetExportAsString()Indicates whether exporting all data as string value.
GetHasHeaderRow()Indicates whether the range contains header row.
GetIdName()Gets and sets the name of id column.
GetMergeAreas()Indicates whether merge the areas of conditional formatting and validation before saving the file.
GetOperatorType()Gets and sets 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 and sets 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 and sets the start id.
GetTableName()Gets and sets the table name.
GetUpdateSmartArt()Indicates whether updating smart art setting. The default value is false.
GetValidateMergedAreas()Indicates whether validate merged cells before saving the file.
GetWarningCallback()Gets or sets warning callback.
IsNull() constChecks whether the implementation object is nullptr.
explicit operator bool() constoperator bool()
operator=(const SqlScriptSaveOptions& src)operator=
operator=(const SaveOptions& src)operator=
SaveOptions(SaveOptions_Impl* impl)Constructs from an implementation object.
SaveOptions(const SaveOptions& src)Copy constructor.
SetAddBlankLineBetweenRows(bool value)Insert blank line between each data.
SetCachedFileFolder(const U16String& value)The cached file folder is used to store some large data.
SetCachedFileFolder(const char16_t* value)The cached file folder is used to store some large data.
SetCheckAllDataForColumnType(bool value)Check all data to find columns’ data type.
SetCheckExcelRestriction(bool 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.
SetCheckIfTableExists(bool value)Check if the table name exists before creating.
SetClearData(bool value)Make the workbook empty after saving the file.
SetColumnTypeMap(const SqlScriptColumnTypeMap& value)Gets and sets the map of column type for different database.
SetCreateDirectory(bool value)If true and the directory does not exist, the directory will be automatically created before saving the file.
SetCreateTable(bool value)Indicates whether exporting sql of creating table.
SetEncryptDocumentProperties(bool value)Indicates whether encrypt document properties when saving as .xls file. The default value is true.
SetExportArea(const CellArea& value)Gets or sets the exporting range.
SetExportAsString(bool value)Indicates whether exporting all data as string value.
SetHasHeaderRow(bool value)Indicates whether the range contains header row.
SetIdName(const U16String& value)Gets and sets the name of id column.
SetIdName(const char16_t* value)Gets and sets the name of id column.
SetMergeAreas(bool value)Indicates whether merge the areas of conditional formatting and validation before saving the file.
SetOperatorType(SqlScriptOperatorType value)Gets and sets the operator type of sql.
SetPrimaryKey(int32_t value)Represents which column is primary key of the data table.
SetRefreshChartCache(bool value)Indicates whether refreshing chart cache data.
SetSeparator(char16_t value)Gets and sets character separator of sql script.
SetSheetIndexes(const Vector <int32_t>& value)Represents the indexes of exported sheets.
SetSortExternalNames(bool value)Indicates whether sorting external defined names before saving file.
SetSortNames(bool value)Indicates whether sorting defined names before saving file.
SetStartId(int32_t value)Gets and sets the start id.
SetTableName(const U16String& value)Gets and sets the table name.
SetTableName(const char16_t* value)Gets and sets the table name.
SetUpdateSmartArt(bool value)Indicates whether updating smart art setting. The default value is false.
SetValidateMergedAreas(bool value)Indicates whether validate merged cells before saving the file.
SetWarningCallback(IWarningCallback* value)Gets or sets warning callback.
SqlScriptSaveOptions()Creates options for saving sql file.
SqlScriptSaveOptions(SqlScriptSaveOptions_Impl* impl)Constructs from an implementation object.
SqlScriptSaveOptions(const SqlScriptSaveOptions& src)Copy constructor.
SqlScriptSaveOptions(const SaveOptions& src)Constructs from a parent object.
~SaveOptions()Destructor.
~SqlScriptSaveOptions()Destructor.

Fields

FieldDescription
_implThe implementation object.

See Also