Class SkinController

Handles the Business Control Layer for Skins.

Inheritance

System.Object

SkinController

Namespace: DotNetNuke.UI.Skins

Assembly: DotNetNuke.dll

Syntax

public class SkinController : object

Properties

RootContainer

Handles the Business Control Layer for Skins.

Declaration

public static string RootContainer { get; }

Property Value

Type	Description
System.String

RootSkin

Handles the Business Control Layer for Skins.

Declaration

public static string RootSkin { get; }

Property Value

Type	Description
System.String

Methods

AddSkin(Int32, String)

Handles the Business Control Layer for Skins.

Declaration

public static int AddSkin(int skinPackageID, string skinSrc)

Parameters

Type	Name	Description
System.Int32	skinPackageID
System.String	skinSrc

Returns

Type	Description
System.Int32

AddSkinPackage(SkinPackageInfo)

Handles the Business Control Layer for Skins.

Declaration

public static int AddSkinPackage(SkinPackageInfo skinPackage)

Parameters

Type	Name	Description
SkinPackageInfo	skinPackage

Returns

Type	Description
System.Int32

CanDeleteSkin(String, String)

Handles the Business Control Layer for Skins.

Declaration

public static bool CanDeleteSkin(string folderPath, string portalHomeDirMapPath)

Parameters

Type	Name	Description
System.String	folderPath
System.String	portalHomeDirMapPath

Returns

Type	Description
System.Boolean

DeleteSkin(Int32)

Handles the Business Control Layer for Skins.

Declaration

public static void DeleteSkin(int skinID)

Parameters

Type	Name	Description
System.Int32	skinID

DeleteSkinPackage(SkinPackageInfo)

Handles the Business Control Layer for Skins.

Declaration

public static void DeleteSkinPackage(SkinPackageInfo skinPackage)

Parameters

Type	Name	Description
SkinPackageInfo	skinPackage

FormatMessage(String, String, Int32, Boolean)

Handles the Business Control Layer for Skins.

Declaration

public static string FormatMessage(string title, string body, int level, bool isError)

Parameters

Type	Name	Description
System.String	title
System.String	body
System.Int32	level
System.Boolean	isError

Returns

Type	Description
System.String

FormatSkinPath(String)

Handles the Business Control Layer for Skins.

Declaration

public static string FormatSkinPath(string skinSrc)

Parameters

Type	Name	Description
System.String	skinSrc

Returns

Type	Description
System.String

FormatSkinSrc(String, PortalSettings)

Handles the Business Control Layer for Skins.

Declaration

public static string FormatSkinSrc(string skinSrc, PortalSettings portalSettings)

Parameters

Type	Name	Description
System.String	skinSrc
PortalSettings	portalSettings

Returns

Type	Description
System.String

GetDefaultAdminContainer()

Handles the Business Control Layer for Skins.

Declaration

public static string GetDefaultAdminContainer()

Returns

Type	Description
System.String

GetDefaultAdminSkin()

Handles the Business Control Layer for Skins.

Declaration

public static string GetDefaultAdminSkin()

Returns

Type	Description
System.String

GetDefaultPortalContainer()

Handles the Business Control Layer for Skins.

Declaration

public static string GetDefaultPortalContainer()

Returns

Type	Description
System.String

GetDefaultPortalSkin()

Handles the Business Control Layer for Skins.

Declaration

public static string GetDefaultPortalSkin()

Returns

Type	Description
System.String

GetSkinByPackageID(Int32)

Handles the Business Control Layer for Skins.

Declaration

public static SkinPackageInfo GetSkinByPackageID(int packageID)

Parameters

Type	Name	Description
System.Int32	packageID

Returns

Type	Description
SkinPackageInfo

GetSkinPackage(Int32, String, String)

Handles the Business Control Layer for Skins.

Declaration

public static SkinPackageInfo GetSkinPackage(int portalId, string skinName, string skinType)

Parameters

Type	Name	Description
System.Int32	portalId
System.String	skinName
System.String	skinType

Returns

Type	Description
SkinPackageInfo

GetSkins(PortalInfo, String, SkinScope)

Handles the Business Control Layer for Skins.

Declaration

public static List<KeyValuePair<string, string>> GetSkins(PortalInfo portalInfo, string skinRoot, SkinScope scope)

Parameters

Type	Name	Description
PortalInfo	portalInfo
System.String	skinRoot
SkinScope	scope

Returns

Type	Description
List<KeyValuePair<System.String, System.String>>

IsGlobalSkin(String)

Determines if a given skin is defined as a global skin.

Declaration

public static bool IsGlobalSkin(string skinSrc)

Parameters

Type	Name	Description
System.String	skinSrc	This is the app relative path and filename of the skin to be checked.

Returns

Type	Description
System.Boolean	True if the skin is located in the HostPath child directories.

Remarks

This function performs a quick check to detect the type of skin that is passed as a parameter. Using this method abstracts knowledge of the actual location of skins in the file system.

SetSkin(String, Int32, SkinType, String)

Handles the Business Control Layer for Skins.

Declaration

public static void SetSkin(string skinRoot, int portalId, SkinType skinType, string skinSrc)

Parameters

Type	Name	Description
System.String	skinRoot
System.Int32	portalId
SkinType	skinType
System.String	skinSrc

UpdateSkin(Int32, String)

Handles the Business Control Layer for Skins.

Declaration

public static void UpdateSkin(int skinID, string skinSrc)

Parameters

Type	Name	Description
System.Int32	skinID
System.String	skinSrc

UpdateSkinPackage(SkinPackageInfo)

Handles the Business Control Layer for Skins.

Declaration

public static void UpdateSkinPackage(SkinPackageInfo skinPackage)

Parameters

Type	Name	Description
SkinPackageInfo	skinPackage

UploadLegacySkin(String, String, String, Stream)

Handles the Business Control Layer for Skins.

Declaration

public static string UploadLegacySkin(string rootPath, string skinRoot, string skinName, Stream inputStream)

Parameters

Type	Name	Description
System.String	rootPath
System.String	skinRoot
System.String	skinName
Stream	inputStream

Returns

Type	Description
System.String

Extension Methods

JsonExtensionsWeb.ToJson(Object)