Class UIDescriptorRegistry

Registry that holds all ui descriptors for entity types.

Inheritance

System.Object

UIDescriptorRegistry

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: EPiServer.Shell

Assembly: EPiServer.Shell.dll

Version: 8.11.0

Syntax

[ServiceConfiguration(typeof(UIDescriptorRegistry), Lifecycle = ServiceInstanceScope.Singleton)]
public class UIDescriptorRegistry

Constructors

UIDescriptorRegistry(UIDescriptor[], IUIDescriptorInitializer[])

Initializes a new instance of the UIDescriptorRegistry class.

Declaration

public UIDescriptorRegistry(UIDescriptor[] uiDescriptors, IUIDescriptorInitializer[] initializers)

Parameters

Type	Name	Description
UIDescriptor[]	uiDescriptors	The UI descriptors.
IUIDescriptorInitializer[]	initializers	The UI descriptor initializers

UIDescriptorRegistry(UIDescriptor[], IUIDescriptorInitializer[], UIDescriptorProvider[])

Initializes a new instance of the UIDescriptorRegistry class.

Declaration

public UIDescriptorRegistry(UIDescriptor[] uiDescriptors, IUIDescriptorInitializer[] initializers, UIDescriptorProvider[] descriptorProviders)

Parameters

Type	Name	Description
UIDescriptor[]	uiDescriptors	The UI descriptors.
IUIDescriptorInitializer[]	initializers	The UI descriptor initializers
UIDescriptorProvider[]	descriptorProviders	A collection of providers queried for additiona descriptors

Properties

UIDescriptors

A collection of the UIDescriptors registered for available content types

Declaration

public virtual IEnumerable<UIDescriptor> UIDescriptors { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<UIDescriptor>

Methods

Add(UIDescriptor)

Adds the specified descriptor.

Declaration

[Obsolete("Inherit UIDescriptorProvider to add new ui descriptors")]
public virtual void Add(UIDescriptor descriptor)

Parameters

Type	Name	Description
UIDescriptor	descriptor	The descriptor.

Remarks

This method is not thread safe. Implement UIDescriptorProvider instead to add ui descriptors.

GetAllRegisteredUIDescriptors()

Gets all registered UI descriptors.

Declaration

[Obsolete("Use the UIDescriptors property instead")]
public virtual IEnumerable<UIDescriptor> GetAllRegisteredUIDescriptors()

Returns

Type	Description
System.Collections.Generic.IEnumerable<UIDescriptor>

GetDescriptorsForType(Type)

Gets a list of ui descriptors registered for a type and its base types.

Declaration

public virtual IEnumerable<UIDescriptor> GetDescriptorsForType(Type type)

Parameters

Type	Name	Description
System.Type	type

Returns

Type	Description
System.Collections.Generic.IEnumerable<UIDescriptor>	A sorted list with the most specific matching type first.

GetTypeIdentifiers(Type)

Gets the type identifiers.

Declaration

public virtual IEnumerable<string> GetTypeIdentifiers(Type type)

Parameters

Type	Name	Description
System.Type	type	The type to find .

Returns

Type	Description
System.Collections.Generic.IEnumerable<System.String>	A sorted list with the most specific matching type first.

HasMatchedTypeIdentifier(Type, IEnumerable<String>)

Determines whether any ui descriptor matching the type has any matching type identifiers in the provided collection.

Declaration

public virtual bool HasMatchedTypeIdentifier(Type type, IEnumerable<string> typeIdentifiers)

Parameters

Type	Name	Description
System.Type	type	The type to get ui descriptors for.
System.Collections.Generic.IEnumerable<System.String>	typeIdentifiers	A collection of type identifier for matching.

Returns

Type	Description
System.Boolean