ScriptingOptions.ExtendedProperties Property

Gets or sets the Boolean property value that specifies whether extended object properties are included in the generated script.

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

Syntax

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

value = instance.ExtendedProperties

instance.ExtendedProperties = value
public bool ExtendedProperties { get; set; }
public:
property bool ExtendedProperties {
    bool get ();
    void set (bool value);
}
member ExtendedProperties : bool with get, set
function get ExtendedProperties () : boolean
function set ExtendedProperties (value : boolean)

Property Value

Type: System.Boolean
A Boolean value that specifies whether extended object properties are included in the generated script.
If True, extended object properties are included in the generated script. Otherwise, False (default).

Examples

The following code example specifies that extended object properties will be included in the script.

Visual Basic

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

PowerShell

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