DocumentId.IsAssignmentEnabled Method (SPSite)

Determines whether the DocumentId object assignment is enabled on a SPSite object.

Namespace:  Microsoft.Office.DocumentManagement
Assembly:  Microsoft.Office.DocumentManagement (in Microsoft.Office.DocumentManagement.dll)

Syntax

'Declaration
Public Shared Function IsAssignmentEnabled ( _
    site As SPSite _
) As Boolean
'Usage
Dim site As SPSite
Dim returnValue As Boolean

returnValue = DocumentId.IsAssignmentEnabled(site)

public static bool IsAssignmentEnabled(
    SPSite site
)

Parameters

• site
  Type: Microsoft.SharePoint.SPSite

  SPSite object to test for DocumentId object assignment.

Return Value

Type: System.Boolean
true if assignment is enabled; otherwise false.

Exceptions

Exception	Condition
ArgumentException	SPSite object orthe properties of its root SPWeb properties are set to a null reference (Nothing in Visual Basic).

See Also

Reference

DocumentId Class

DocumentId Members

IsAssignmentEnabled Overload

Microsoft.Office.DocumentManagement Namespace

EnableAssignment(SPSite, Boolean)

EnableAssignment(SPSite, Boolean, Boolean, Boolean)

EnableAssignment(SPSite, String, Boolean, Boolean, Boolean, Boolean)