ScriptingOptions.EnforceScriptingOptions Property

Article
07/16/2015

Applies To: SQL Server 2016 Preview

Gets or sets the Boolean property value that specifies whether the application of all scripting options is enforced for text-based objects, such as SchemaQualify.

Namespace: Microsoft.SqlServer.Management.Smo
Assembly: Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

public bool EnforceScriptingOptions { get; set; }

public:
property bool EnforceScriptingOptions {
    bool get();
    void set(bool value);
}

member EnforceScriptingOptions : bool with get, set

Public Property EnforceScriptingOptions As Boolean

Property Value

Type: System.Boolean

A Boolean value that specifies whether the application of all scripting options is enforced for text-based objects.

If True, the application of all scripting options is enforced for text-based objects.

If False (default), object text is scripted without any modification.

Remarks

Text-based objects will lose any comments and formatting, because the object will be constructed based on metadata.

Examples

Legacy Code Example

The following code example specifies that the application of scripting options will be enforced for text-based objects.

Visual Basic

Dim scOps As New ScriptingOptions()
scOps.EnforceScriptingOptions = true

PowerShell

$scOps = New-Object Microsoft.SqlServer.Management.Smo.ScriptingOptions
$scOps.EnforceScriptingOptions = $TRUE