Interface IControlBarController

Namespace: DotNetNuke.Web.Components.Controllers
Assembly: DotNetNuke.Web.dll
Syntax
public interface IControlBarController

Methods

| Improve this Doc View Source

GetBookmarkCategory(Int32)

Get the category name where the bookmarked modules are shown.

Declaration
string GetBookmarkCategory(int portalId)
Parameters
Type Name Description
System.Int32 portalId

Portal Id where modules are installed.
Returns
Type Description
System.String

The name of the bookmark category.
| Improve this Doc View Source

GetBookmarkedDesktopModules(Int32, Int32, String)

Get all desktop modules bookmark by user in Control Bar.

Declaration
IEnumerable<KeyValuePair<string, PortalDesktopModuleInfo>> GetBookmarkedDesktopModules(int portalId, int userId, string searchTerm = "")
Parameters
Type Name Description
System.Int32 portalId

Portal Id where modules are installed.
System.Int32 userId

User Id who has bookmarked the modules.
System.String searchTerm

Search term to filter modules.
Returns
Type Description
IEnumerable<KeyValuePair<System.String, PortalDesktopModuleInfo>>

A list with all matched modules.
| Improve this Doc View Source

GetCategoryDesktopModules(Int32, String, String)

Get all desktop modules that belong to a category.

Declaration
IEnumerable<KeyValuePair<string, PortalDesktopModuleInfo>> GetCategoryDesktopModules(int portalId, string category, string searchTerm = "")
Parameters
Type Name Description
System.Int32 portalId

Portal Id where modules are installed.
System.String category

Catenory name.
System.String searchTerm

Search term to filter modules.
Returns
Type Description
IEnumerable<KeyValuePair<System.String, PortalDesktopModuleInfo>>

A list with all matched desktop modules.
| Improve this Doc View Source

GetControlBarLogoURL()

Get the current Logo URL shown in Control Bar.

Declaration
string GetControlBarLogoURL()
Returns
Type Description
System.String

The URL of the Control Bar Logo.
| Improve this Doc View Source

GetCustomMenuItems()

Gets all custom Menu item available in the system.

Declaration
IEnumerable<MenuItemViewModel> GetCustomMenuItems()
Returns
Type Description
IEnumerable<MenuItemViewModel>

All custom Menu Items.
| Improve this Doc View Source

GetUpgradeIndicator(Version, Boolean, Boolean)

Returns the upgrade indicator model.

Declaration
UpgradeIndicatorViewModel GetUpgradeIndicator(Version version, bool isLocal, bool isSecureConnection)
Parameters
Type Name Description
Version version
System.Boolean isLocal
System.Boolean isSecureConnection
Returns
Type Description
UpgradeIndicatorViewModel

An instance of the view model UpgradeIndicator.
| Improve this Doc View Source

SaveBookMark(Int32, Int32, String, String)

Save a user bookmark.

Declaration
void SaveBookMark(int portalId, int userId, string bookarkTitle, string bookmarkValue)
Parameters
Type Name Description
System.Int32 portalId

Portal Id where save the bookmark.
System.Int32 userId

User Id who is going to create the bookmark.
System.String bookarkTitle

Title for the personalization setting.
System.String bookmarkValue

Value for the personalization setting.

Extension Methods