ScriptOptions Class

Provides programmatic options that can be set for scripting operations.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServerCe.Management.Scripting.ScriptOptions

Namespace:  Microsoft.SqlServerCe.Management.Scripting
Assembly:  Microsoft.SqlServerCe.Management.Scripting (in Microsoft.SqlServerCe.Management.Scripting.dll)

Syntax

'Declaration
Public NotInheritable Class ScriptOptions
'Usage
Dim instance As ScriptOptions

public sealed class ScriptOptions

public ref class ScriptOptions sealed

[<SealedAttribute>]
type ScriptOptions =  class end

public final class ScriptOptions

The ScriptOptions type exposes the following members.

Constructors

	Name	Description
	ScriptOptions()	Initializes a new instance of the ScriptOptions class using default values.
	ScriptOptions(ScriptOptions)	Initializes a new instance of the ScriptOptions class with the specified script options.

Top

Properties

	Name	Description
	AnsiPadding	Gets or sets a value that indicates whether the generated script contains the Transact-SQL statements SET ANSI-PADDING ON and SET ANSI-PADDING OFF, before and after the CREATE TABLE statement, respectively.
	AppendToFile	Gets or sets a value that indicates whether the script is appended to the end of the output file or overwrites it.
	ContinueScriptingOnError	Gets or sets a value that indicates whether the scripting operation continues after an error is encountered.
	ConvertIndexToClusteredIndex	Gets or sets a value that indicates whether to convert an index to a clustered index.
	DriAll	Gets or sets a value that indicates whether all DRI objects are included in the generated script.
	DriAllConstraints	Gets or sets a value that indicates whether all declarative referential integrity constraints are included in the generated script.
	DriAllKeys	Gets or sets a value that indicates whether the dependency relationships defined by all declarative referential integrity keys are included in the generated script.
	DriDefaults	Gets or sets a value that indicates whether dependency relationships defined in defaults with enforced declarative referential integrity are included in the script.
	DriForeignKeys	Gets or sets a value that indicates whether dependency relationships defined in foreign keys with enforced declarative referential integrity are included in the script.
	DriPrimaryKey	Gets or sets a value that indicates whether dependency relationships that are defined in primary keys which have enforced declarative referential integrity are included in the script.
	DriUniqueKeys	Gets or sets a value that indicates whether dependency relationships that are defined in unique keys which have enforced declarative referential integrity are included in the script.
	Encoding	Gets or sets the encoding for the scripting options.
	FileName	Gets or sets the name of the file to which the generated script is output.
	ImageToVarBinaryMax	Gets or sets a value that indicates whether to convert images to VarBinaryMax.
	IncludeDatabaseContext	Gets or sets a value that indicates whether database content is included in the generated script.
	IncludeHeaders	Gets or sets a value that indicates whether the generated script is prefixed with a header that contains information which includes the date and time of generation.
	IncludeIfNotExists	Gets or sets a value that indicates whether to check the existence of an object before including it in the script.
	Indexes	Gets or sets a value that indicates whether indexes are included in the generated script.
	NoCollation	Gets or sets a value that indicates whether to include the collation clause in the generated script.
	NoCommandTerminator	Gets or sets a value that indicates whether individual Transact-SQL statements are delimited in the generated script.
	NoIdentities	Gets or sets a value that indicates whether definitions of identity property seed and increment are included in the generated script.
	NTextToNVarCharMax	Gets or sets a value that indicates whether to convert NText values to NVarCharMax.
	PrefixTableNameToConstraintName	Gets or sets a value that indicates whether to prefix table names to constraint names.
	PrimaryObject	Gets or sets a value that indicates whether the creation of the referenced object is included in the generated script.
	SchemaQualify	Gets or sets a value that indicates whether the schemas associated with objects are included in the generated script.
	SchemaQualifyForeignKeysReferences	Gets or sets a value that indicates whether schema-qualified table references for foreign key constraints are included in the generated script.
	ScriptData	Gets or sets a value that indicates whether the ScriptData property is included in the generated script.
	ScriptDrops	Gets or sets a value that indicates whether the script operation generates a Transact-SQL script to remove the referenced component.
	ScriptSchema	Gets or sets a value that indicates whether the ScriptSchema property is included in the generated script.
	TargetDatabaseEngineType	Gets or sets the target database engine type.
	TargetServerVersion	Gets or sets the version of the instance of SQL Server for which the generated script is intended.
	TimestampToBinary	Gets or sets a value that indicates whether to convert timestamp data types to binary8 data types when scripting the creation of a table or user-defined data type.
	ToFileOnly	Gets or sets a value that indicates whether to output to file only or to also generate string output.
	WithDependencies	Gets or sets a value that indicates whether to include all dependent objects in the generated script.

Top

Methods

	Name	Description
	Equals	(inherited from Object)
	Finalize	(inherited from Object)
	GetHashCode	(inherited from Object)
	GetType	(inherited from Object)
	MemberwiseClone	(inherited from Object)
	ToString	(inherited from Object)

Top

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.SqlServerCe.Management.Scripting Namespace