Class PagePlugin

Subclass this plugin to customize the behavior of a visible page, for example a grid.

Inheritance
System.Object
System.MarshalByRefObject
Plugin
PagePlugin
Inherited Members
Namespace: Softadmin.Api.Page
Assembly: Softadmin.Api.dll
Syntax
public abstract class PagePlugin : Plugin

Properties

CustomPage

Gets or sets the object used to customize the current page.

Declaration
public ICustomPage CustomPage { get; set; }
Property Value
Type Description
ICustomPage

IsParameterPage

Gets or sets a value indicating whether the current page is a parameter page or a menu item page.

Declaration
public bool IsParameterPage { get; set; }
Property Value
Type Description
System.Boolean

MenuItemId

Gets or sets the current menu item id.

Declaration
public int MenuItemId { get; set; }
Property Value
Type Description
System.Int32
Remarks

Setting this property will not forward the user to another page; the property is only public so that it can be set in unit tests.

Parameters

Gets or sets the passing fields for the current page.

Declaration
public IParameters Parameters { get; set; }
Property Value
Type Description
IParameters

Methods

PageLoad()

Called when the page is loaded.

Declaration
public abstract void PageLoad()
Exceptions
Type Condition
System.Exception

Any exception thrown by this plugin will be caught and logged.

See Also