Share via


SPClaimProvider.SupportsHierarchy property

When implemented in a derived class, determines whether the claims provider supports hierarchical display.

Namespace:  Microsoft.SharePoint.Administration.Claims
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaration
Public MustOverride ReadOnly Property SupportsHierarchy As Boolean
    Get
'Usage
Dim instance As SPClaimProvider
Dim value As Boolean

value = instance.SupportsHierarchy
public abstract bool SupportsHierarchy { get; }

Property value

Type: System.Boolean
A Boolean that represents whether the claims provider supports a hierarchical display. true if the claims provider supports hierarchy information; otherwise false.

Remarks

A People Picker control with claims picking functionality is sometimes referred to as a claim picker. If you want to display hierarchy on the left pane of the claims picker, you must implement this property and the FillHierarchy() method of the SPClaimProvider class.

For more information, see How to: Create a claims provider in SharePoint 2013For more information claims picking and resolution, see How to: Create a claims provider in SharePoint 2013 and Claims provider in SharePoint 2013.

If you want to support hierarchy display in the People Picker control, the SupportsHierarchy property must return true as shown in the following example.

Examples

// Returns true if you support hierarchy display in People Picker control.
        
        public override bool SupportsHierarchy
        {
            get { return true; }
        }

See also

Reference

SPClaimProvider class

SPClaimProvider members

Microsoft.SharePoint.Administration.Claims namespace