DNN Community Blog

The Community Blog is a personal opinion of community members and by no means the official standpoint of DNN Corp or DNN Platform. This is a place to express personal thoughts about DNNPlatform, the community and its ecosystem. Do you have useful information that you would like to share with the DNN Community in a featured article or blog? If so, please contact .

The use of the Community Blog is covered by our Community Blog Guidelines - please read before commenting or posting.


IActionable: Add Items to Your DotNetNuke® Module Menu

The DotNetNuke Survey module displays an Add Question option on the module's menu (and in the footer of the module) for any user that has Edit access to the module (usually the Administrator).

What IActionable Will Do For You

If you are familiar with the NavigateURL function (see: NavigateURL: How to make A DotNetNuke® link) you know how to provide navigation from one user control to another in your modules. To add items to the modules menu, you use the IActionable interface.

Implementing IActionable

To implement IActionable in the Survey.ascx.vb file, this code is used:

Implements Entities.Modules.IActionable

Public ReadOnly Property ModuleActions() As DotNetNuke.Entities.Modules.Actions.ModuleActionCollection Implements DotNetNuke.Entities.Modules.IActionable.ModuleActions
Get

Dim
Actions As New Entities.Modules.Actions.ModuleActionCollection
    Actions.Add(
    GetNextActionID,
    Localization.GetString(Entities.Modules.Actions.ModuleActionType.AddContent, LocalResourceFile),    
    Entities.Modules.Actions.ModuleActionType.AddContent,

    ""
,
    ""
,
    EditUrl(),

    False
,
    SecurityAccessLevel.Edit,

    True
,
    False
    )

Return Actions
End Get
End
Property

What Did We Just Do?

When we Implement the IActionable interface we communicate to the DotNetNuke framework that we will create a property that will return a ModuleActionCollection object. We can see in the class diagram below that ModuleActionCollection is a collection of ModuleAction objects.

 

To create a ModuleActionCollection collection you add a ModuleAction object to it using the Add method of ModuleActionCollection. The Add method of ModuleActionCollection contains a number of overloads. The overload we used is:

Add(
ByVal ID As
Integer,
ByVal Title As
String,
ByVal CmdName As
String,
Optional ByVal CmdArg As
String = "",
Optional ByVal Icon As
String = "",
Optional ByVal Url As
String = "",
Optional ByVal UseActionEvent As
Boolean = False,
Optional ByVal Secure As
DotNetNuke.Security.SecurityAccessLevel = Anonymous,
Optional ByVal Visible As
Boolean = True,
Optional ByVal NewWindow As
Boolean = False
) As
DotNetNuke.Entities.Modules.Actions.ModuleAction

This overload creates a ModuleAction object and adds it to the ModuleActionCollection collection.

The following table explains the meaning of each field and shows sample values and data:

Property Value Sample Data
ID As Integer
[Each module action must have a unique ID. Use the
GetNextActionID method to generate a unique id]
GetNextActionID    3
Title As String
[
Sets the text displayed on the menu]
Localization.GetString(Entities.Modules.Actions.ModuleActionType.AddContent, LocalResourceFile)    "Add Question"
CmdName As String
[The command name passed to the client when this action is clicked. Used for JavaScript
]
Entities.Modules.Actions.ModuleActionType.AddContent    "AddContent.Action"
CmdArg As String
[The command argument passed to the client when this action is clicked. Used for additional parameters passed to JavaScript]
"" ""
Icon As String
[The URL of the Icon to place next to this action]
"" ""
Url As String
[The destination URL to redirect the client browser when this action is clicked.]
EditUrl()   "http://localhost/DotNetNuke/Home/tabid/36/ctl/Edit/mid/423/Default.aspx"
UseActionEvent As Boolean
[Determines whether client will receive an event notification]
False  
Secure As DotNetNuke.Security.SecurityAccessLevel
[The security access level required for access to this action]
SecurityAccessLevel.Edit 1
Visible As Boolean
[Whether this action will be displayed]
True True
NewWindow As Boolean
[Whether this action will be displayed in a new window]
False False

 

Comments

Christopher Schoeder
dead link NavigateURL: How to make A DotNetNuke® link

should go to http://www.adefwebserver.com/dotnetnukehelp/NavigateURL/
Christopher Schoeder Wednesday, May 25, 2016 2:12 PM (link)

Comment Form

Only registered users may post comments.

NewsArchives


Aderson Oliveira (15)
Alec Whittington (11)
Alex Shirley (10)
Andrew Nurse (30)
Andy Tryba (1)
Anthony Glenwright (5)
Antonio Chagoury (28)
Ash Prasad (32)
Ben Schmidt (1)
Benjamin Hermann (25)
Benoit Sarton (9)
Beth Firebaugh (12)
Bill Walker (36)
Bob Kruger (5)
Bogdan Litescu (1)
Brian Dukes (2)
Brice Snow (1)
Bruce Chapman (20)
Bryan Andrews (1)
cathal connolly (55)
Charles Nurse (163)
Chris Hammond (209)
Chris Paterra (55)
Clinton Patterson (40)
Cuong Dang (21)
Daniel Bartholomew (2)
Daniel Mettler (154)
Dave Buckner (2)
David Poindexter (4)
David Rodriguez (3)
Doug Howell (11)
Erik van Ballegoij (30)
Ernst Peter Tamminga (74)
Geoff Barlow (10)
George Alatrash (6)
Gifford Watkins (3)
Gilles Le Pigocher (3)
Ian Robinson (7)
Israel Martinez (17)
Jan Blomquist (2)
Jan Jonas (3)
Jaspreet Bhatia (1)
Jenni Merrifield (6)
Joe Brinkman (274)
John Mitchell (1)
Jon Henning (14)
Jonathan Sheely (4)
Jordan Coopersmith (1)
Joseph Craig (2)
Kan Ma (1)
Keivan Beigi (3)
Ken Grierson (10)
Kevin Schreiner (6)
Leigh Pointer (31)
Lorraine Young (60)
Malik Khan (1)
Matthias Schlomann (15)
Mauricio Márquez (5)
Michael Doxsey (7)
Michael Tobisch (3)
Michael Washington (202)
Miguel Gatmaytan (3)
Mike Horton (19)
Mitchel Sellers (28)
Nathan Rover (3)
Navin V Nagiah (14)
Néstor Sánchez (31)
Nik Kalyani (14)
Peter Donker (54)
Philip Beadle (135)
Philipp Becker (4)
Richard Dumas (22)
Robert J Collins (5)
Roger Selwyn (8)
Ruben Lopez (1)
Ryan Martinez (1)
Salar Golestanian (4)
Sanjay Mehrotra (9)
Scott McCulloch (1)
Scott S (11)
Scott Wilkinson (3)
Scott Willhite (97)
Sebastian Leupold (80)
Shaun Walker (237)
Shawn Mehaffie (17)
Stefan Cullmann (12)
Stefan Kamphuis (12)
Steve Fabian (31)
Timo Breumelhof (24)
Tony Henrich (3)
Torsten Weggen (2)
Vicenç Masanas (27)
Vincent Nguyen (3)
Vitaly Kozadayev (6)
Will Morgenweck (40)
Will Strohl (165)
William Severance (5)

Content Layout

Subscribe to DNN Digest

DNN Digest is our monthly email newsletter. It highlights news and content from around the DNN ecosystem, such as new modules and themes, messages from leadership, blog posts and notable tweets. Keep your finger on the pulse of the ecosystem by subscribing.  


Copyright 2017 by DNN Corp Terms of Use Privacy
What is Liquid Content?
Find Out
What is Liquid Content?
Find Out
What is Liquid Content?
Find Out