Class GadgetComponentProvider
Provides dashboard gadgets as IComponents.
Inheritance
System.Object
GadgetComponentProvider
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.Gadgets
Assembly: EPiServer.Shell.dll
Version: 8.11.0Syntax
[ComponentProvider]
public class GadgetComponentProvider : IComponentProvider, ISortableConstructors
GadgetComponentProvider(IGadgetFactory)
Initializes a new instance of the GadgetComponentProvider class.
Declaration
public GadgetComponentProvider(IGadgetFactory gadgetFactory)Parameters
| Type | Name | Description |
|---|---|---|
| IGadgetFactory | gadgetFactory | The gadget factory. |
Properties
SortOrder
Used to select the order of execution of the IComponentProviders.
Declaration
public int SortOrder { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 | GadgetComponentProvider has a sort order of 200. |
Methods
CreateComponent(IComponentDefinition)
Creates a component instance corresponding to an IComponentDefinition.
Declaration
public IComponent CreateComponent(IComponentDefinition definition)Parameters
| Type | Name | Description |
|---|---|---|
| IComponentDefinition | definition | The component definition to create a component for. |
Returns
| Type | Description |
|---|---|
| IComponent | A component instance if the definition is provided by this provider; otherwise |
GetComponentDefinitions()
Gets the components.
Declaration
public IEnumerable<IComponentDefinition> GetComponentDefinitions()Returns
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<IComponentDefinition> | An System.Collections.Generic.IEnumerable<T> with the component definitions that this provider handles. |
