• DXC Service
  • Products
    • Episerver CMS
    • Episerver Commerce
    • Episerver Campaign
    • Episerver Find
    • Episerver Personalization
      • Advance
      • Perform
      • Insight
      • Reach
      • Personalized Find
    • Episerver Social API
    • Episerver apps & integrations
    • Ektron CMS
  • Documentation
    • Get started
      • DXC Service
      • CMS
      • Commerce
      • Campaign
      • Find
      • Personalization
      • Insight
      • Social API
      • Service API
    • Developer guides
      • DXC Service
      • CMS
      • Commerce
      • Campaign
      • Find
      • Advance
      • Perform
      • Reach
      • Personalized Find
      • Insight
      • Tracking
      • Profile Store
      • Content Delivery API
      • Social API
      • Service API
      • Forms
      • MA connectors
    • UI feature list
    • Technical overview
    • System requirements
    • Installation
    • User guide
    • APIs and libraries
      • CMS
      • Commerce
      • Campaign
      • Find
      • Social
      • REST APIs
    • Video tutorials
    • Releases
    • Upgrading
      • CMS
      • Commerce
      • Find
      • Forms
      • Service API
      • Personalization
  • Blogs
  • Forum
  • Support
  • EMVPs
  • Register
  • Log in
All Content Documentation Forum User Guide Support Help Center Blogs Articles Releases Bug List SDK Documents
People
Home / Documentation /
  • Framework reference
  • EPiServer.Shell.Gadgets
  • Gadget
    • Gadget Methods
    • Gadget Properties

Gadget Class

Assembly: EPiServer.Shell (in EPiServer.Shell.dll) Version: 8.0.0

Syntax:

C#
[DataContractAttribute]
[EPiServerDataTableAttribute(TableName = "tblSystemBigTable")]
[EPiServerDataStoreAttribute(StoreName = "GadgetStore")]
public class Gadget : ICloneable

A gadget, used for instance on the dashboard.

Methods

Name Summary Status
Clone Creates a new object that is a copy of the current instance. public
Gadget Constructor Initializes a new instance of the Gadget class. public
Gadget Constructor (GadgetDefinition) Initializes a new instance of the Gadget class. public
GetIdentity Extracts the identity from the object if it has one. public, static
GetOriginalType Gets the Type of the current object, ensuring that the eventual type that could be generated by a proxy interceptor is ignored. public, static
GetRouteValues Gets the route values. public
SetIdentity Sets the identity into the object if supported public, static
ToPropertyBag(Object) Create a PropertyBag instance and populates it with its properties The algorith for extracting properties is as follows: 1) Property must a have a getter and setter 2a) Getter must be public OR 2b) The class must be marked either with the DataContractAttribute or EPiServerDataContractAttribute and the property must be marked either with the DataMemberAttribute or EPiServerDataMemberAttribute public, static
ToPropertyBag(Object, IEnumerable(String)) Create a PropertyBag instance and populates it with its properties public, static

Properties

Name Summary Status
ControllerTypeName Type type of controller that serves the gadget interface. public
Definition The definition used by this gadget. public
IconUrl The URL to the icon image. public
Id Obsolete. Use the Id property of the wrapping component instead. public
IsDeleted Gets or sets a value indicating whether this instance is deleted. public
Name Name for this gadget public
TemplateId Id of the template for this gadget type. public
Title The title of the gadget, used for ui puroses. public

Inheritance

  • System.Object
  • EPiServer.Shell.Gadgets.Gadget

About Episerver

  • episerver.com
  • Episerver certification
  • Job openings
  • License center
  • Privacy statement

Community

  • Blogs
  • Forums
  • Articles
  • Terms of use
  • EMVP program

Learning resources

  • Technical overview
  • Learning path Episerver CMS
  • Developer guides
  • User guide
  • Video tutorials
  • Episerver GitHub
  • Episerver Education

Contact

Episerver Support

See the Support page for contact information.

Feedback on Episerver World

If you’d like to give feedback about this site, please click here. Thank you very much!
© Episerver 2019 │ About Episerver World