SqlScriptGeneratorOptions Class

Controls the options for Sql Script Generation.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.TransactSql.ScriptDom.SqlScriptGeneratorOptions

Namespace:  Microsoft.SqlServer.TransactSql.ScriptDom
Assembly:  Microsoft.SqlServer.TransactSql.ScriptDom (in Microsoft.SqlServer.TransactSql.ScriptDom.dll)

Syntax

'Declaration
Public Class SqlScriptGeneratorOptions
'Usage
Dim instance As SqlScriptGeneratorOptions

public class SqlScriptGeneratorOptions

public ref class SqlScriptGeneratorOptions

type SqlScriptGeneratorOptions =  class end

public class SqlScriptGeneratorOptions

The SqlScriptGeneratorOptions type exposes the following members.

Constructors

	Name	Description
	SqlScriptGeneratorOptions	Initializes a new instance of the SqlScriptGeneratorOptions class.

Top

Properties

	Name	Description
	AlignClauseBodies	Gets or sets a value that indicates whether the bodies of FROM, WHERE, GROUP BY, clauses are aligned.
	AlignColumnDefinitionFields	Gets or sets a value that indicates whether column definition fields (column name, data type, constraints) are aligned into alignment columns.
	AlignSetClauseItem	Gets or sets a value that indicates whether the SET clause items in an UPDATE statement is aligned.
	AsKeywordOnOwnLine	Gets or sets a value that indicates whether the AS keyword is written on its own line.
	IncludeSemicolons	Gets or sets a value that indicates whether a semi colon is included after each statement.
	IndentationSize	Gets or sets the number of spaces to use when indenting text.
	IndentSetClause	Gets or sets a value that indicates whether the SET clause for an UPDATE statement is indented.
	IndentViewBody	Gets or sets a value that indicates whether the view statement body is indented.
	KeywordCasing	Gets or sets the keyword casing option to use during script generation.
	MultilineInsertSourcesList	Gets or sets a value that indicates whether the INSERT column sources list is spread across multiple lines.
	MultilineInsertTargetsList	Gets or sets a value that indicates whether the INSERT column targets list is spread across multiple lines.
	MultilineSelectElementsList	Gets or sets a value that indicates whether select elements are listed as multi-line list.
	MultilineSetClauseItems	Gets or sets a value that indicates whether the SET clause items are listed on multiple lines.
	MultilineViewColumnsList	Gets or sets a value that indicates whether the view statement columns are listed as a multi-line list.
	MultilineWherePredicatesList	Gets or sets a value that indicates whether WHERE predicates (expressions separated by AND, and OR) are written on multiple lines.
	NewLineBeforeCloseParenthesisInMultilineList	Gets or sets a value that indicates whether a newline is placed before a close parenthesis when writing a multi-line list in parenthesis.
	NewLineBeforeFromClause	Gets or sets a value that indicates whether a newline exists before the FROM clause in a SELECT statement.
	NewLineBeforeGroupByClause	Gets or sets a value that indicates whether a newline exists before the GROUP BY clause in a SELECT statement.
	NewLineBeforeHavingClause	Gets or sets a value that indicates whether a newline exists before the HAVING clause in a SELECT statement.
	NewLineBeforeJoinClause	Gets or sets a value that indicates whether a newline exists before the JOIN clause in a SELECT statement.
	NewLineBeforeOffsetClause	Gets or sets a value that indicates whether a newline exists before the OFFSET clause.
	NewLineBeforeOpenParenthesisInMultilineList	Gets or sets a value that indicates whether a newline is placed before an open parenthesis when writing a multi-line list in parenthesis.
	NewLineBeforeOrderByClause	Gets or sets a value that indicates whether a newline exists before the ORDER BY clause in a SELECT statement.
	NewLineBeforeOutputClause	Gets or sets a value that indicates whether a newline exists before the OUTPUT clause.
	NewLineBeforeWhereClause	Gets or sets a value that indicates whether a newline exists before the WHERE clause in a SELECT statement.
	SqlVersion	Gets or sets the Sql version to generate script for.

Top

Methods

	Name	Description
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	MemberwiseClone	(Inherited from Object.)
	Reset	Resets the options to their default value.
	ToString	(Inherited from Object.)

Top

Thread Safety

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

See Also

Reference

Microsoft.SqlServer.TransactSql.ScriptDom Namespace