Class GadgetComponentDefinition
Used for providing gadgets to the opa framework by wrapping it.
Implements
Inherited Members
Namespace: EPiServer.Shell.Gadgets
Assembly: EPiServer.Shell.dll
Version: 8.11.0Syntax
public class GadgetComponentDefinition : PluggableComponentDefinitionBase, IComponentDefinition, IPluggableComponentDefinition, IContainerMatcher, IEquatable<IComponentDefinition>Constructors
GadgetComponentDefinition(Gadget)
Initializes a new instance of the GadgetComponentDefinition class.
Declaration
public GadgetComponentDefinition(Gadget gadget)Parameters
| Type | Name | Description |
|---|---|---|
| Gadget | gadget | The gadget. |
Properties
Categories
Gets the category for this component. If no category is set in the definition then "dashboard" is returned.
Declaration
public IEnumerable<string> Categories { get; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<System.String> | Returns the category definied in gadget definition; else returns "dashboard". |
DefinitionName
Unique name of the component definition.
Declaration
public string DefinitionName { get; }Property Value
| Type | Description |
|---|---|
| System.String | The unique name of the component definition. |
Remarks
This is used when creating component from a IComponentProvider. For instance, it can use the System.Type.FullName of the type of the IComponentDefinition.
Description
Description of the component. Should be localized.
Declaration
public string Description { get; }Property Value
| Type | Description |
|---|---|
| System.String | The description. |
Title
Title used in the UI both for listings and as default for component instances. Should be localized.
Declaration
public string Title { get; }Property Value
| Type | Description |
|---|---|
| System.String | The title. |
WidgetType
Name of the widget type to use for displaying the component.
Declaration
public string WidgetType { get; }Property Value
| Type | Description |
|---|---|
| System.String | epi.shell.widget.GadgetWrapper |
Methods
CreateComponent()
This implementation does not create any component. It's instead the GadgetComponentProvider that's creating gadget components.
Declaration
public override IComponent CreateComponent()Returns
| Type | Description |
|---|---|
| IComponent | Always null. |
Overrides
Equals(IComponentDefinition)
Equalses the specified other.
Declaration
public bool Equals(IComponentDefinition other)Parameters
| Type | Name | Description |
|---|---|---|
| IComponentDefinition | other | The other. |
Returns
| Type | Description |
|---|---|
| System.Boolean |
