IScriptingOptions Interface

Provides programmatic options that can be set for scripting operations.

Namespace:  Microsoft.SqlServer.Management.UI.VSIntegration
Assembly:  SqlWorkbench.Interfaces (in SqlWorkbench.Interfaces.dll)

Syntax

'Declaration
Public Interface IScriptingOptions
'Usage
Dim instance As IScriptingOptions
public interface IScriptingOptions
public interface class IScriptingOptions
type IScriptingOptions =  interface end
public interface IScriptingOptions

The IScriptingOptions type exposes the following members.

Properties

  Name Description
Public property BatchSeparator Gets a value that separates script into batches.
Public property ConvertUddtToBaseType Gets a value indicating whether user-defined data types are converted to the most appropriate SQL Server base data types in the generated script.
Public property DelimitStatements Gets the specified limitation of a statement.
Public property GenerateAnsiPadding Gets a value indicating whether the script generates ANSI-PADDING.
Public property IncludeCollation Gets a value indicating whether to include the collation clause in the generated script.
Public property IncludeHeaders Gets a value indicating whether the script contains a header that includes the date and time generation.
Public property IncludeIdentity Gets a value indicating whether the definitions of the identity property seed and increment are included in the generated script.
Public property IncludeIfNotExists Gets a value indicating whether to check if an object doesn't exist before including it in the script.
Public property IncludeVarDecimal Gets a value indicating whether to include the N clause when you create VarDecimal columns in the generated script.
Public property SchemaQualify Gets a value indicating whether the script contains an object with a qualified schema.
Public property SchemaQualifyForeignKeys Gets a value indicating whether an object with no schema that is referenced by a foreign key are included in the generated script.
Public property ScriptBinding Gets a value indicating whether the binding of the script is included.
Public property ScriptChangeTracking Gets a value indicating whether the script includes the change tracking information.
Public property ScriptCheckConstraints Gets a value indicating whether the constraints in the script are checked.
Public property ScriptDataCompressionOptions Gets a value indicating whether to include data compression options in the generated script.
Public property ScriptDefaults Gets a value indicating whether the creation of the referenced object is included in the generated script.
Public property ScriptDependentObjects Gets a value indicating whether a script is generated for the additional objects that are required when the script for the selected object is executed.
Public property ScriptDriIncludeSystemNames Gets a value indicating whether the script includes the system-generated constraint names to enforce declarative referential integrity.
Public property ScriptExtendedProperties Gets a value indicating whether the script includes the extended properties.
Public property ScriptFileGroups Gets a value indicating whether the script specifies the file groups.
Public property ScriptForeignKeys Gets a value indicating whether the script includes the foreign key constraints.
Public property ScriptFullTextCatalogs Gets a value indicating whether the script includes the full-text catalogs.
Public property ScriptFullTextIndexes Gets a value indicating whether the script includes the full-text indexes.
Public property ScriptIndexes Gets a value indicating whether the script includes the clustered, non-clustered, and XML indexes.
Public property ScriptPartitionSchemes Gets a value indicating whether the script includes the table partitioning schemes.
Public property ScriptPermissions Gets a value indicating whether the script includes the permissions on database objects.
Public property ScriptPrimaryKeys Gets a value indicating whether the script includes the primary key constraints.
Public property ScriptStatistics Gets a value indicating whether the script includes the user-defined statistics.
Public property ScriptTriggers Gets a value indicating whether to include the definition for triggers in the generated script.
Public property ScriptUniqueKeys Gets a value indicating whether the script includes the unique constraints.
Public property ScriptUseDatabase Gets a value indicating whether the script adds the use database statement to create database objects in the context of the current object explorer database.
Public property ScriptViewColumns Gets a value indicating whether the script declares view columns in view headers in the script.
Public property TargetDatabaseEngineType Gets the DatabaseEngineType property value.
Public property TargetVersion Gets the version for which the generated script is intended.

Top

Methods

  Name Description
Public method GetSmoScriptingOptions Retrieves the collections of objects from the scripting options.

Top