ScriptingOptions.EnforceScriptingOptions Property

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

'Declaration
Public Property EnforceScriptingOptions As Boolean 
    Get 
    Set
'Usage
Dim instance As ScriptingOptions 
Dim value As Boolean 

value = instance.EnforceScriptingOptions

instance.EnforceScriptingOptions = value

public bool EnforceScriptingOptions { get; set; }

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

member EnforceScriptingOptions : bool with get, set

function get EnforceScriptingOptions () : boolean 
function set EnforceScriptingOptions (value : 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

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

See Also

Reference

ScriptingOptions Class

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Scripting