Five New Optimizely Certifications are Here! Validate your expertise and advance your career with our latest certification exams. Click here to find out more

AI OnAI Off

Class PropertyControlClassFactory

Repository for IPropertyControlFactory

Inheritance
System.Object
PropertyControlClassFactory
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.Core
Assembly: EPiServer.Cms.AspNet.dll
Version: 11.20.7
Syntax
[ServiceConfiguration(typeof(IPropertyControlFactory), Lifecycle = ServiceInstanceScope.Singleton, IncludeServiceAccessor = false, FactoryMember = "Instance")]
public class PropertyControlClassFactory : IPropertyControlFactory

Constructors

PropertyControlClassFactory()

Initializes a new instance of the PropertyControlClassFactory class.

Declaration
public PropertyControlClassFactory()

Properties

Instance

Gets the global instance of PropertyControlClassFactory.

Declaration
public static PropertyControlClassFactory Instance { get; }
Property Value
Type Description
PropertyControlClassFactory

PropertyDataSettingsHelper

Gets or sets the template control loaderk.

Declaration
public virtual Injected<IPropertyDataSettingsHelper> PropertyDataSettingsHelper { get; set; }
Property Value
Type Description
Injected<IPropertyDataSettingsHelper>

PropertyDefinitionRepository

Gets or sets the property definition repository.

Declaration
public Injected<IPropertyDefinitionRepository> PropertyDefinitionRepository { get; set; }
Property Value
Type Description
Injected<IPropertyDefinitionRepository>

The property definition repository.

TemplateControlLoaderService

Gets or sets the template control loaderk.

Declaration
public virtual Injected<ITemplateControlLoader> TemplateControlLoaderService { get; set; }
Property Value
Type Description
Injected<ITemplateControlLoader>

Methods

ClearRegistrations()

This member supports the EPiServer infrastructure and is not intended to be used directly from your code.

Declaration
public virtual void ClearRegistrations()

CreateInstance(Type, Object[])

Declaration
[Obsolete("Method is no longer supported, use Activator.CreateInstance to create instances of types")]
public object CreateInstance(Type baseType, params object[] constructorArguments)
Parameters
Type Name Description
System.Type baseType
System.Object[] constructorArguments
Returns
Type Description
System.Object

CreatePropertyControl(PropertyData)

Creates an IPropertyControl for a given PropertyData.

Declaration
public virtual IPropertyControl CreatePropertyControl(PropertyData propertyData)
Parameters
Type Name Description
PropertyData propertyData

The PropertyData.
Returns
Type Description
IPropertyControl

A IPropertyControl that can be used to render an user interface for the PropertyData.

CreatePropertyControl(PropertyData, HttpContextBase, TemplateControl, String)

Creates an IPropertyControl for a given PropertyData.

Declaration
public virtual IPropertyControl CreatePropertyControl(PropertyData propertyData, HttpContextBase httpContext, TemplateControl templateControl, string tag)
Parameters
Type Name Description
PropertyData propertyData

The PropertyData.
System.Web.HttpContextBase httpContext

The HTTP context.
System.Web.UI.TemplateControl templateControl

The template control.
System.String tag

The tag used to resolve the template.
Returns
Type Description
IPropertyControl

A IPropertyControl that can be used to render an user interface for the PropertyData.

GetControls(Type)

Declaration
public ReadOnlyCollection<Type> GetControls(Type propertyType)
Parameters
Type Name Description
System.Type propertyType
Returns
Type Description
System.Collections.ObjectModel.ReadOnlyCollection<System.Type>

IsRegistered(Type)

This member supports the EPiServer infrastructure and is not intended to be used directly from your code.

Declaration
public virtual bool IsRegistered(Type baseType)
Parameters
Type Name Description
System.Type baseType
Returns
Type Description
System.Boolean

IsRegistered<TPropertyData>()

Check if a PropertyData type has registered controls.

Declaration
public bool IsRegistered<TPropertyData>()
    where TPropertyData : PropertyData
Returns
Type Description
System.Boolean
Type Parameters
Name Description
TPropertyData

The PropertyData

Register<TPropertyData>(Func<IPropertyControl>)

Registers an IPropertyControl factory with a PropertyData type.

Declaration
public IPropertyControlFactory Register<TPropertyData>(Func<IPropertyControl> controlFactory)
    where TPropertyData : PropertyData
Parameters
Type Name Description
System.Func<IPropertyControl> controlFactory

The control factory to register with the property data instance
Returns
Type Description
IPropertyControlFactory
Type Parameters
Name Description
TPropertyData

The PropertyData

Register<TPropertyData, TPropertyControl>()

Registers an IPropertyControl with a PropertyData type.

Declaration
public IPropertyControlFactory Register<TPropertyData, TPropertyControl>()
    where TPropertyData : PropertyData where TPropertyControl : IPropertyControl
Returns
Type Description
IPropertyControlFactory
Type Parameters
Name Description
TPropertyData

The PropertyData
TPropertyControl

The property control

RegisterClass(Type, Type)

Registers a class mapping (this legacy method never overrides existing registrations)

Declaration
public virtual void RegisterClass(Type baseType, Type mappedType)
Parameters
Type Name Description
System.Type baseType

Type of the base class.
System.Type mappedType

Type of the mapped class.
Remarks

The first registered control always wins, use Unregister to unregister an existing registration

TypeStringFromArguments(Object[])

Declaration
[Obsolete("Method is no longer supported")]
public static string TypeStringFromArguments(params object[] constructorArguments)
Parameters
Type Name Description
System.Object[] constructorArguments
Returns
Type Description
System.String

Unregister<TPropertyData>()

Unregister a PropertyData type.

Declaration
public IPropertyControlFactory Unregister<TPropertyData>()
    where TPropertyData : PropertyData
Returns
Type Description
IPropertyControlFactory
Type Parameters
Name Description
TPropertyData

The PropertyData

Implements

Extension Methods