Class ControlPanelBase

The ControlPanel class defines a custom base class inherited by all ControlPanel controls.

Inheritance

System.Object

ControlPanelBase

Namespace: DotNetNuke.UI.ControlPanels

Assembly: DotNetNuke.dll

Syntax

public class ControlPanelBase : UserControl

Properties

| Improve this Doc View Source

IncludeInControlHierarchy

The ControlPanel class defines a custom base class inherited by all ControlPanel controls.

Declaration

public virtual bool IncludeInControlHierarchy { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsDockable

The ControlPanel class defines a custom base class inherited by all ControlPanel controls.

Declaration

public virtual bool IsDockable { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IsVisible

Gets a value indicating whether the ControlPanel is Visible.

Declaration

protected bool IsVisible { get; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

LocalResourceFile

Gets or sets the Local ResourceFile for the Control Panel.

Declaration

public string LocalResourceFile { get; set; }

Property Value

Type	Description
System.String	A String.

| Improve this Doc View Source

PortalSettings

Gets the current Portal Settings.

Declaration

protected PortalSettings PortalSettings { get; }

Property Value

Type	Description
PortalSettings

| Improve this Doc View Source

UserMode

Gets the User mode of the Control Panel.

Declaration

protected PortalSettings.Mode UserMode { get; }

Property Value

Type	Description
PortalSettings.Mode	A Boolean.

Methods

| Improve this Doc View Source

AddExistingModule(Int32, Int32, String, Int32, String)

Adds an Existing Module to a Pane.

Declaration

protected void AddExistingModule(int moduleId, int tabId, string paneName, int position, string align)

Parameters

Type	Name	Description
System.Int32	moduleId	The Id of the existing module.
System.Int32	tabId	The id of the tab.
System.String	paneName	The pane to add the module to.
System.Int32	position	The relative position within the pane for the module.
System.String	align	The alignment for the Module.

| Improve this Doc View Source

AddNewModule(String, Int32, String, Int32, ControlPanelBase.ViewPermissionType, String)

Adds a New Module to a Pane.

Declaration

protected void AddNewModule(string title, int desktopModuleId, string paneName, int position, ControlPanelBase.ViewPermissionType permissionType, string align)

Parameters

Type	Name	Description
System.String	title	The Title for the resulting module.
System.Int32	desktopModuleId	The Id of the DesktopModule.
System.String	paneName	The pane to add the module to.
System.Int32	position	The relative position within the pane for the module.
ControlPanelBase.ViewPermissionType	permissionType	The View Permission Type for the Module.
System.String	align	The alignment for the Module.

| Improve this Doc View Source

BuildURL(Int32, String)

Builds a URL to a page with a module matching the given definition friendlyName.

Declaration

protected string BuildURL(int portalID, string friendlyName)

Parameters

Type	Name	Description
System.Int32	portalID	The ID of the portal.
System.String	friendlyName	The friendly name of the Module.

Returns

Type	Description
System.String	A formatted URL.

| Improve this Doc View Source

GetModulePermission(Int32, String)

The ControlPanel class defines a custom base class inherited by all ControlPanel controls.

Declaration

protected bool GetModulePermission(int portalID, string friendlyName)

Parameters

Type	Name	Description
System.Int32	portalID
System.String	friendlyName

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

IsModuleAdmin()

The ControlPanel class defines a custom base class inherited by all ControlPanel controls.

Declaration

protected bool IsModuleAdmin()

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

IsPageAdmin()

The ControlPanel class defines a custom base class inherited by all ControlPanel controls.

Declaration

protected bool IsPageAdmin()

Returns

Type	Description
System.Boolean

| Improve this Doc View Source

OnInit(EventArgs)

The ControlPanel class defines a custom base class inherited by all ControlPanel controls.

Declaration

protected override void OnInit(EventArgs e)

Parameters

Type	Name	Description
EventArgs	e

| Improve this Doc View Source

SetUserMode(String)

Sets the UserMode.

Declaration

protected void SetUserMode(string userMode)

Parameters

Type	Name	Description
System.String	userMode	The userMode to set.

| Improve this Doc View Source

SetVisibleMode(Boolean)

Sets the current Visible Mode.

Declaration

protected void SetVisibleMode(bool isVisible)

Parameters

Type	Name	Description
System.Boolean	isVisible	A flag indicating whether the Control Panel should be visible.

Extension Methods

JsonExtensionsWeb.ToJson(Object)