Class Skin

Skin is the base for the Skins.

Inheritance

System.Object

UserControlBase

Skin

Inherited Members

UserControlBase.IsHostMenu

UserControlBase.PortalSettings

Namespace: DotNetNuke.UI.Skins

Assembly: DotNetNuke.dll

Syntax

public class Skin : UserControlBase

Constructors

| Improve this Doc View Source

Skin()

Initializes a new instance of the Skin class.

Declaration

public Skin()

Fields

| Improve this Doc View Source

CONTAINERLOAD_ERROR

Skin is the base for the Skins.

Declaration

public static string CONTAINERLOAD_ERROR

Field Value

Type	Description
System.String

| Improve this Doc View Source

MODULEADD_ERROR

Skin is the base for the Skins.

Declaration

public static string MODULEADD_ERROR

Field Value

Type	Description
System.String

| Improve this Doc View Source

MODULELOAD_ERROR

Skin is the base for the Skins.

Declaration

public static string MODULELOAD_ERROR

Field Value

Type	Description
System.String

| Improve this Doc View Source

OnInitMessage

Skin is the base for the Skins.

Declaration

public const string OnInitMessage = null

Field Value

Type	Description
System.String

| Improve this Doc View Source

OnInitMessageType

Skin is the base for the Skins.

Declaration

public const string OnInitMessageType = null

Field Value

Type	Description
System.String

Properties

| Improve this Doc View Source

ActionEventListeners

Gets or sets an ArrayList of ActionEventListeners.

Declaration

public ArrayList ActionEventListeners { get; set; }

Property Value

Type	Description
ArrayList

| Improve this Doc View Source

ModuleControlPipeline

Skin is the base for the Skins.

Declaration

protected IModuleControlPipeline ModuleControlPipeline { get; }

Property Value

Type	Description
IModuleControlPipeline

| Improve this Doc View Source

NavigationManager

Skin is the base for the Skins.

Declaration

protected INavigationManager NavigationManager { get; }

Property Value

Type	Description
INavigationManager

| Improve this Doc View Source

Panes

Gets a Dictionary of Panes.

Declaration

public Dictionary<string, Pane> Panes { get; }

Property Value

Type	Description
Dictionary<System.String, Pane>

| Improve this Doc View Source

SkinPath

Gets the Path for this skin.

Declaration

public string SkinPath { get; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

SkinSrc

Gets or sets the Source for this skin.

Declaration

public string SkinSrc { get; set; }

Property Value

Type	Description
System.String

Methods

| Improve this Doc View Source

AddModuleMessage(Control, String, ModuleMessage.ModuleMessageType)

AddModuleMessage adds a Module Message control to the Skin.

Declaration

public static void AddModuleMessage(Control control, string message, ModuleMessage.ModuleMessageType moduleMessageType)

Parameters

Type	Name	Description
Control	control	The current control.
System.String	message	The Message Text.
ModuleMessage.ModuleMessageType	moduleMessageType	The type of the message.

| Improve this Doc View Source

AddModuleMessage(Control, String, String, ModuleMessage.ModuleMessageType)

AddModuleMessage adds a Module Message control to the Skin.

Declaration

public static void AddModuleMessage(Control control, string heading, string message, ModuleMessage.ModuleMessageType moduleMessageType)

Parameters

Type	Name	Description
Control	control	The current control.
System.String	heading	The Message Heading.
System.String	message	The Message Text.
ModuleMessage.ModuleMessageType	moduleMessageType	The type of the message.

| Improve this Doc View Source

AddModuleMessage(PortalModuleBase, String, ModuleMessage.ModuleMessageType)

Skin is the base for the Skins.

Declaration

public static void AddModuleMessage(PortalModuleBase control, string message, ModuleMessage.ModuleMessageType moduleMessageType)

Parameters

Type	Name	Description
PortalModuleBase	control
System.String	message
ModuleMessage.ModuleMessageType	moduleMessageType

| Improve this Doc View Source

AddModuleMessage(PortalModuleBase, String, String, ModuleMessage.ModuleMessageType)

Skin is the base for the Skins.

Declaration

public static void AddModuleMessage(PortalModuleBase control, string heading, string message, ModuleMessage.ModuleMessageType moduleMessageType)

Parameters

Type	Name	Description
PortalModuleBase	control
System.String	heading
System.String	message
ModuleMessage.ModuleMessageType	moduleMessageType

| Improve this Doc View Source

AddPageMessage(Skin, String, String, ModuleMessage.ModuleMessageType)

AddPageMessage adds a Page Message control to the Skin.

Declaration

public static void AddPageMessage(Skin skin, string heading, string message, ModuleMessage.ModuleMessageType moduleMessageType)

Parameters

Type	Name	Description
Skin	skin	The skin.
System.String	heading	The Message Heading.
System.String	message	The Message Text.
ModuleMessage.ModuleMessageType	moduleMessageType	The type of the message.

| Improve this Doc View Source

AddPageMessage(Skin, String, String, String)

AddPageMessage adds a Page Message control to the Skin.

Declaration

public static void AddPageMessage(Skin skin, string heading, string message, string iconSrc)

Parameters

Type	Name	Description
Skin	skin	The skin.
System.String	heading	The Message Heading.
System.String	message	The Message Text.
System.String	iconSrc	The Icon to display.

| Improve this Doc View Source

AddPageMessage(Page, String, String, ModuleMessage.ModuleMessageType)

AddPageMessage adds a Page Message control to the Skin.

Declaration

public static void AddPageMessage(Page page, string heading, string message, ModuleMessage.ModuleMessageType moduleMessageType)

Parameters

Type	Name	Description
Page	page	The Page.
System.String	heading	The Message Heading.
System.String	message	The Message Text.
ModuleMessage.ModuleMessageType	moduleMessageType	The type of the message.

| Improve this Doc View Source

AddPageMessage(Page, String, String, String)

AddPageMessage adds a Page Message control to the Skin.

Declaration

public static void AddPageMessage(Page page, string heading, string message, string iconSrc)

Parameters

Type	Name	Description
Page	page	The Page.
System.String	heading	The Message Heading.
System.String	message	The Message Text.
System.String	iconSrc	The Icon to display.

| Improve this Doc View Source

GetInstalledSkins()

Skin is the base for the Skins.

Declaration

public static List<InstalledSkinInfo> GetInstalledSkins()

Returns

Type	Description
List<InstalledSkinInfo>

| Improve this Doc View Source

GetModuleMessageControl(String, String, ModuleMessage.ModuleMessageType, String)

GetModuleMessageControl gets an existing Message Control and sets its properties.

Declaration

public static ModuleMessage GetModuleMessageControl(string heading, string message, ModuleMessage.ModuleMessageType moduleMessageType, string iconImage)

Parameters

Type	Name	Description
System.String	heading	The Message Heading.
System.String	message	The Message Text.
ModuleMessage.ModuleMessageType	moduleMessageType	The type of message.
System.String	iconImage	The Message Icon.

Returns

Type	Description
ModuleMessage	The ModuleMessage control.

| Improve this Doc View Source

GetModuleMessageControl(String, String, ModuleMessage.ModuleMessageType)

GetModuleMessageControl gets an existing Message Control and sets its properties.

Declaration

public static ModuleMessage GetModuleMessageControl(string heading, string message, ModuleMessage.ModuleMessageType moduleMessageType)

Parameters

Type	Name	Description
System.String	heading	The Message Heading.
System.String	message	The Message Text.
ModuleMessage.ModuleMessageType	moduleMessageType	The type of message.

Returns

Type	Description
ModuleMessage	The ModuleMessage control.

| Improve this Doc View Source

GetModuleMessageControl(String, String, String)

GetModuleMessageControl gets an existing Message Control and sets its properties.

Declaration

public static ModuleMessage GetModuleMessageControl(string heading, string message, string iconImage)

Parameters

Type	Name	Description
System.String	heading	The Message Heading.
System.String	message	The Message Text.
System.String	iconImage	The Message Icon.

Returns

Type	Description
ModuleMessage	The ModuleMessage control.

| Improve this Doc View Source

GetParentSkin(Control)

GetParentSkin gets the Parent Skin for a control.

Declaration

public static Skin GetParentSkin(Control control)

Parameters

Type	Name	Description
Control	control	The control whose Parent Skin is requested.

Returns

Type	Description
Skin	A Skin instance or null.

| Improve this Doc View Source

GetParentSkin(PortalModuleBase)

GetParentSkin gets the Parent Skin for a control.

Declaration

public static Skin GetParentSkin(PortalModuleBase module)

Parameters

Type	Name	Description
PortalModuleBase	module	The control whose Parent Skin is requested.

Returns

Type	Description
Skin	A Skin instance or null.

| Improve this Doc View Source

GetPopUpSkin(PageBase)

GetPopUpSkin gets the Skin that is used in modal popup.

Declaration

public static Skin GetPopUpSkin(PageBase page)

Parameters

Type	Name	Description
PageBase	page	The Page.

Returns

Type	Description
Skin	A Skin instance.

| Improve this Doc View Source

GetSkin(PageBase)

GetSkin gets the Skin.

Declaration

public static Skin GetSkin(PageBase page)

Parameters

Type	Name	Description
PageBase	page	The Page.

Returns

Type	Description
Skin	A Skin instance.

| Improve this Doc View Source

InjectModule(Pane, ModuleInfo)

InjectModule injects the module into the Pane.

Declaration

public bool InjectModule(Pane pane, ModuleInfo module)

Parameters

Type	Name	Description
Pane	pane	The pane.
ModuleInfo	module	The module to inject.

Returns

Type	Description
System.Boolean	true if the module is successfully injected, otherwise false.

| Improve this Doc View Source

OnInit(EventArgs)

Skin is the base for the Skins.

Declaration

protected override void OnInit(EventArgs e)

Parameters

Type	Name	Description
EventArgs	e

| Improve this Doc View Source

OnLoad(EventArgs)

Skin is the base for the Skins.

Declaration

protected override void OnLoad(EventArgs e)

Parameters

Type	Name	Description
EventArgs	e

| Improve this Doc View Source

OnPreRender(EventArgs)

Skin is the base for the Skins.

Declaration

protected override void OnPreRender(EventArgs e)

Parameters

Type	Name	Description
EventArgs	e

| Improve this Doc View Source

OnUnload(EventArgs)

Skin is the base for the Skins.

Declaration

protected override void OnUnload(EventArgs e)

Parameters

Type	Name	Description
EventArgs	e

| Improve this Doc View Source

RegisterModuleActionEvent(Int32, ActionEventHandler)

RegisterModuleActionEvent registers a Module Action Event.

Declaration

public void RegisterModuleActionEvent(int moduleId, ActionEventHandler e)

Parameters

Type	Name	Description
System.Int32	moduleId	The ID of the module.
ActionEventHandler	e	An Action Event Handler.

Extension Methods

JsonExtensionsWeb.ToJson(Object)