Class ActionBase
ActionBase is an abstract base control for Action objects that inherit from UserControl.
Implements
Namespace: DotNetNuke.UI.Containers
Assembly: DotNetNuke.dll
Syntax
public abstract class ActionBase : UserControl, IActionControl
Remarks
ActionBase inherits from UserControl, and implements the IActionControl Interface.
Fields
| Improve this Doc View Sourcem_supportsIcons
Defines if the action supports icons.
Declaration
protected bool m_supportsIcons
Field Value
Type | Description |
---|---|
System.Boolean |
Remarks
ActionBase inherits from UserControl, and implements the IActionControl Interface.
Properties
| Improve this Doc View SourceActionManager
Gets the ActionManager instance for this Action control.
Declaration
public ActionManager ActionManager { get; }
Property Value
Type | Description |
---|---|
ActionManager | An ActionManager object. |
Remarks
ActionBase inherits from UserControl, and implements the IActionControl Interface.
ActionRoot
Gets the ActionRoot.
Declaration
protected ModuleAction ActionRoot { get; }
Property Value
Type | Description |
---|---|
ModuleAction | A ModuleActionCollection. |
Remarks
ActionBase inherits from UserControl, and implements the IActionControl Interface.
Actions
Gets the Actions Collection.
Declaration
protected ModuleActionCollection Actions { get; }
Property Value
Type | Description |
---|---|
ModuleActionCollection | A ModuleActionCollection. |
Remarks
ActionBase inherits from UserControl, and implements the IActionControl Interface.
EditMode
Gets a value indicating whether the page is in edit mode.
Declaration
public bool EditMode { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
Remarks
ActionBase inherits from UserControl, and implements the IActionControl Interface.
ModuleContext
Gets the ModuleContext.
Declaration
protected ModuleInstanceContext ModuleContext { get; }
Property Value
Type | Description |
---|---|
ModuleInstanceContext | A ModuleInstanceContext. |
Remarks
ActionBase inherits from UserControl, and implements the IActionControl Interface.
ModuleControl
Gets or sets the ModuleControl instance for this Action control.
Declaration
public IModuleControl ModuleControl { get; set; }
Property Value
Type | Description |
---|---|
IModuleControl | An IModuleControl object. |
Remarks
ActionBase inherits from UserControl, and implements the IActionControl Interface.
PortalSettings
Gets the PortalSettings.
Declaration
protected PortalSettings PortalSettings { get; }
Property Value
Type | Description |
---|---|
PortalSettings | A PortalSettings object. |
Remarks
ActionBase inherits from UserControl, and implements the IActionControl Interface.
SupportsIcons
Gets a value indicating whether the action supports icons.
Declaration
public bool SupportsIcons { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
Remarks
ActionBase inherits from UserControl, and implements the IActionControl Interface.
Methods
| Improve this Doc View SourceDisplayControl(DNNNodeCollection)
DisplayControl determines whether the control should be displayed.
Declaration
protected bool DisplayControl(DNNNodeCollection objNodes)
Parameters
Type | Name | Description |
---|---|---|
DNNNodeCollection | objNodes | A collection of Dnn nodes, |
Returns
Type | Description |
---|---|
System.Boolean | A value indicating whether the control should be displayed. |
Remarks
ActionBase inherits from UserControl, and implements the IActionControl Interface.
OnAction(ActionEventArgs)
OnAction raises the Action Event for this control.
Declaration
protected virtual void OnAction(ActionEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
ActionEventArgs | e | The action event arguments. |
Remarks
ActionBase inherits from UserControl, and implements the IActionControl Interface.
OnLoad(EventArgs)
Page_Load runs when the class is loaded.
Declaration
protected override void OnLoad(EventArgs e)
Parameters
Type | Name | Description |
---|---|---|
EventArgs | e | The event arguments. |
Remarks
ActionBase inherits from UserControl, and implements the IActionControl Interface.
ProcessAction(String)
ProcessAction processes the action event.
Declaration
protected void ProcessAction(string actionID)
Parameters
Type | Name | Description |
---|---|---|
System.String | actionID | The id of the action. |
Remarks
ActionBase inherits from UserControl, and implements the IActionControl Interface.
Events
| Improve this Doc View SourceAction
The eventhandler for the action.
Declaration
public event ActionEventHandler Action
Event Type
Type | Description |
---|---|
ActionEventHandler |
Remarks
ActionBase inherits from UserControl, and implements the IActionControl Interface.