Five New Optimizely Certifications are Here! Validate your expertise and advance your career with our latest certification exams. Click here to find out more

AI OnAI Off

Class PagePlugInAttribute

The attribute class used to identify page extensions.

Inheritance
System.Object
PlugInAttribute
PagePlugInAttribute
Inherited Members
Namespace: EPiServer.PlugIn
Assembly: EPiServer.dll
Version: 12.0.3
Syntax
public sealed class PagePlugInAttribute : PlugInAttribute
Remarks

Page extensions are plug-ins that are automatically instantiated and used for all ASP.NET pages that derive (directly or indirectly) from the EPiServer.PageBase class. All EPiServers system pages derive from PageBase and this is a way to hook in custom code to basically any user / editor / admin page and add new functionality.

Constructors

PagePlugInAttribute()

Initializes a new instance of the PagePlugInAttribute class.

Declaration
public PagePlugInAttribute()

PagePlugInAttribute(String, String)

Initializes a new instance of the PagePlugInAttribute class.

Declaration
public PagePlugInAttribute(string name, string description)
Parameters
Type Name Description
System.String name

The name of the page extension.
System.String description

The description for the page extension.
Remarks

Initializes the DisplayName and Description properties as part of the initialization process. Unless you manually set the LanguagePath property you will not benefit from the automatic translation support in EPiServer.

PagePlugInAttribute(String, String, String)

Initializes a new instance of the PagePlugInAttribute class.

Declaration
public PagePlugInAttribute(string name, string description, string languagePath)
Parameters
Type Name Description
System.String name

The name of the page extension.
System.String description

The description for the page extension.
System.String languagePath

The language path to use when trying to look up translations for the DisplayName and Description properties.

Methods

GetOptionFlag()

Gets the option flag.

Declaration
public static int GetOptionFlag()
Returns
Type Description
System.Int32

An System.Int32 with the next available bit for Page Extension use.
Remarks

Note that this is used as a bitmap to determine which page extensions to enable. This effectively limits the number of installed page extensions to 32.

Start()

Initialization method called by the plug-in system.

Declaration
public static void Start()
Remarks

This method is called to set up all page extensions by invoking the static Initialize method on the class that the PagePlugInAttribute is applied to.

Extension Methods