SqlScriptGeneratorOptions Class

SQL Server 2012

Controls the options for Sql Script Generation.

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

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

C#
C++
F#
JScript
VB
Copy 
public class SqlScriptGeneratorOptions

The SqlScriptGeneratorOptions type exposes the following members.

  NameDescription
Public methodSqlScriptGeneratorOptionsInitializes a new instance of the SqlScriptGeneratorOptions class.
Top

  NameDescription
Public propertyAlignClauseBodiesGets or sets a value that indicates whether the bodies of FROM, WHERE, GROUP BY, clauses are aligned.
Public propertyAlignColumnDefinitionFieldsGets or sets a value that indicates whether column definition fields (column name, data type, constraints) are aligned into alignment columns.
Public propertyAlignSetClauseItemGets or sets a value that indicates whether the SET clause items in an UPDATE statement is aligned.
Public propertyAsKeywordOnOwnLineGets or sets a value that indicates whether the AS keyword is written on its own line.
Public propertyIncludeSemicolonsGets or sets a value that indicates whether a semi colon is included after each statement.
Public propertyIndentationSizeGets or sets the number of spaces to use when indenting text.
Public propertyIndentSetClauseGets or sets a value that indicates whether the SET clause for an UPDATE statement is indented.
Public propertyIndentViewBodyGets or sets a value that indicates whether the view statement body is indented.
Public propertyKeywordCasingGets or sets the keyword casing option to use during script generation.
Public propertyMultilineInsertSourcesListGets or sets a value that indicates whether the INSERT column sources list is spread across multiple lines.
Public propertyMultilineInsertTargetsListGets or sets a value that indicates whether the INSERT column targets list is spread across multiple lines.
Public propertyMultilineSelectElementsListGets or sets a value that indicates whether select elements are listed as multi-line list.
Public propertyMultilineSetClauseItemsGets or sets a value that indicates whether the SET clause items are listed on multiple lines.
Public propertyMultilineViewColumnsListGets or sets a value that indicates whether the view statement columns are listed as a multi-line list.
Public propertyMultilineWherePredicatesListGets or sets a value that indicates whether WHERE predicates (expressions separated by AND, and OR) are written on multiple lines.
Public propertyNewLineBeforeCloseParenthesisInMultilineListGets or sets a value that indicates whether a newline is placed before a close parenthesis when writing a multi-line list in parenthesis.
Public propertyNewLineBeforeFromClauseGets or sets a value that indicates whether a newline exists before the FROM clause in a SELECT statement.
Public propertyNewLineBeforeGroupByClauseGets or sets a value that indicates whether a newline exists before the GROUP BY clause in a SELECT statement.
Public propertyNewLineBeforeHavingClauseGets or sets a value that indicates whether a newline exists before the HAVING clause in a SELECT statement.
Public propertyNewLineBeforeJoinClauseGets or sets a value that indicates whether a newline exists before the JOIN clause in a SELECT statement.
Public propertyNewLineBeforeOffsetClauseGets or sets a value that indicates whether a newline exists before the OFFSET clause.
Public propertyNewLineBeforeOpenParenthesisInMultilineListGets or sets a value that indicates whether a newline is placed before an open parenthesis when writing a multi-line list in parenthesis.
Public propertyNewLineBeforeOrderByClauseGets or sets a value that indicates whether a newline exists before the ORDER BY clause in a SELECT statement.
Public propertyNewLineBeforeOutputClauseGets or sets a value that indicates whether a newline exists before the OUTPUT clause.
Public propertyNewLineBeforeWhereClauseGets or sets a value that indicates whether a newline exists before the WHERE clause in a SELECT statement.
Public propertySqlVersionGets or sets the Sql version to generate script for.
Top

  NameDescription
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodResetResets the options to their default value.
Public methodToString (Inherited from Object.)
Top

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

Community Additions

ADD
Show: