Assembly: EPiServer (in EPiServer.dll) Version: 10.10.5.0 (10.10.5.0)
public class GuiPlugInAttribute : PlugInAttribute
Settings for plugins in graphical modes
|GuiPlugInAttribute Constructor||Initializes a new instance of the GuiPlugInAttribute class.||public|
|Match||Returns a value indicating whether this instance equals a specified object.||public|
|ResolvePathInternal||Resolves the path to plug-in resources.||protected|
|SetPlugInType||Sets the type of the plug-in.||public|
|ToString||Returns athat represents this instance.||public|
|Area||The area this plugin supports.||public|
|Category||The category of the plugin (currently only supported by Report and Visitor Group Criterion).||public|
|Description||Description of the plugin||public|
|DisplayName||The display name for the plugin.||public|
|LanguagePath||Path to node in language files where translation can be found.||public|
|PlugInType||Gets or sets the plug-in type that is decorated with this attribute. This property is normally set by plug-in system during runtime, but can be overriden explicitly by plug-in developer.||public, private|
|RequiredAccess||The required page access to view plugin (currently only supported by EditPanel).||public|
|RequireLicenseForLoad||Determine if the plugin requires a valid license to be loaded.||public|
|SortIndex||The sort index compared to other plugins||public|
|Url||The url to the resource defined by Area.||public|
|UrlFromModuleFolder||Gets or sets the URL relative the folder of EPiServer Shell module that plug-in belongs to. ModuleType property must be defined to resolve the path to module folder.||public|
|UrlFromUi||Gets and sets the url relative the UI directory to the resource||public|
|UrlFromUtil||Sets the URL relative the util directory to the resource||public|
To translate DisplayName and Description of a plug-in you have to add your own xml file in the â€œlang/â€ directory and set the property LanguagePath. If you for example set LanguagePath to /myplugin/sample the xml paths you add should be /myplugin/sample/displayname and /myplugin/sample/description.
There may be some plug-ins that requires special security roles or other circumstances that the plug-in framework doesnâ€™t have knowledge of, in these cases you may implement ICustomPlugInLoader on you plug-in. This will allow you to control loading of the plug-in yourself.
Some plug-ins need to store some kind of internal settings or state, there are different approaches to this. If you only need to store simple system settings, for example the mail server name in your brand new mail plug-in you probably want to use web.config. If you have large amout of data the obvious choice is to store it in a database. When your need fits in between these two, you need to store small sets of relational data and donâ€™t want to use your own database for this simple purpose you have PlugInSettings. PlugInSettings is used to store plug-in settings and information in a DataSet, these will be persisted as xml together will the plug-in definition in the EpiServer database.
See PlugInAttribute class for more information on how the plug-ins are located and matched.
Sample plug-in that will show up in the administration menu.