Class Gadget
A gadget, used for instance on the dashboard.
Inheritance
System.Object
Gadget
Implements
System.ICloneable
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: 10.10.4Syntax
[EPiServerDataTable(TableName = "tblSystemBigTable")]
[EPiServerDataStore(StoreName = "GadgetStore")]
[Obsolete("The Episerver gadget framework has been deprecated and was replaced by the Episerver Components.")]
public class Gadget : ICloneableConstructors
Gadget()
Initializes a new instance of the Gadget class.
Declaration
public Gadget()Gadget(GadgetDefinition)
Initializes a new instance of the Gadget class.
Declaration
public Gadget(GadgetDefinition definition)Parameters
| Type | Name | Description |
|---|---|---|
| GadgetDefinition | definition | The gadget definition. |
Properties
ControllerTypeName
Type type of controller that serves the gadget interface.
Declaration
public string ControllerTypeName { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
Definition
The definition used by this gadget.
Declaration
public GadgetDefinition Definition { get; set; }Property Value
| Type | Description |
|---|---|
| GadgetDefinition |
IconUrl
The URL to the icon image.
Declaration
public string IconUrl { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Id
Obsolete. Use the Id property of the wrapping component instead.
Declaration
[Obsolete("The Id property should no longer be used since gadgets are wrapped in IComponent instances with a different id hierarchy")]
public Guid Id { get; set; }Property Value
| Type | Description |
|---|---|
| System.Guid |
Remarks
Will always return System.Guid.Empty
IsDeleted
Gets or sets a value indicating whether this instance is deleted.
Declaration
public bool IsDeleted { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
Name
Name for this gadget
Declaration
public string Name { get; set; }Property Value
| Type | Description |
|---|---|
| System.String |
TemplateId
Id of the template for this gadget type.
Declaration
public Guid TemplateId { get; set; }Property Value
| Type | Description |
|---|---|
| System.Guid |
Title
The title of the gadget, used for ui puroses.
Declaration
public string Title { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Methods
Clone()
Creates a new object that is a copy of the current instance.
Declaration
public object Clone()Returns
| Type | Description |
|---|---|
| System.Object | A new object that is a copy of this instance. |
GetRouteValues()
Gets the route values.
Declaration
public RouteValueDictionary GetRouteValues()Returns
| Type | Description |
|---|---|
| System.Web.Routing.RouteValueDictionary |
Implements
System.ICloneable
