Class DNNClientAPI

Inheritance

object

DNNClientAPI

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: DotNetNuke.UI.Utilities

Assembly: DotNetNuke.dll

Syntax

public class DNNClientAPI

Constructors

DNNClientAPI()

Declaration

public DNNClientAPI()

Methods

EnableClientPersonalization(string, string, Page)

Declaration

public static bool EnableClientPersonalization(string strNamingContainer, string strKey, Page objPage)

Parameters

Type	Name	Description
string	strNamingContainer
string	strKey
Page	objPage

Returns

Type	Description
bool

EnableContainerDragAndDrop(Control, Control, int)

Declaration

public static void EnableContainerDragAndDrop(Control objTitle, Control objContainer, int moduleID)

Parameters

Type	Name	Description
Control	objTitle
Control	objContainer
int	moduleID

EnableDragDrop(Page)

Declaration

public static void EnableDragDrop(Page objPage)

Parameters

Type	Name	Description
Page	objPage

EnableMinMax(Control, Control, bool, MinMaxPersistanceType)

Declaration

public static void EnableMinMax(Control objButton, Control objContent, bool blnDefaultMin, DNNClientAPI.MinMaxPersistanceType ePersistanceType)

Parameters

Type	Name	Description
Control	objButton
Control	objContent
bool	blnDefaultMin
DNNClientAPI.MinMaxPersistanceType	ePersistanceType

EnableMinMax(Control, Control, bool, string, string, MinMaxPersistanceType)

Declaration

public static void EnableMinMax(Control objButton, Control objContent, bool blnDefaultMin, string strMinIconLoc, string strMaxIconLoc, DNNClientAPI.MinMaxPersistanceType ePersistanceType)

Parameters

Type	Name	Description
Control	objButton
Control	objContent
bool	blnDefaultMin
string	strMinIconLoc
string	strMaxIconLoc
DNNClientAPI.MinMaxPersistanceType	ePersistanceType

EnableMinMax(Control, Control, bool, string, string, MinMaxPersistanceType, string, string)

Declaration

public static void EnableMinMax(Control objButton, Control objContent, bool blnDefaultMin, string strMinIconLoc, string strMaxIconLoc, DNNClientAPI.MinMaxPersistanceType ePersistanceType, string strPersonalizationNamingCtr, string strPersonalizationKey)

Parameters

Type	Name	Description
Control	objButton
Control	objContent
bool	blnDefaultMin
string	strMinIconLoc
string	strMaxIconLoc
DNNClientAPI.MinMaxPersistanceType	ePersistanceType
string	strPersonalizationNamingCtr
string	strPersonalizationKey

EnableMinMax(Control, Control, int, bool, MinMaxPersistanceType)

Declaration

public static void EnableMinMax(Control objButton, Control objContent, int intModuleId, bool blnDefaultMin, DNNClientAPI.MinMaxPersistanceType ePersistanceType)

Parameters

Type	Name	Description
Control	objButton
Control	objContent
int	intModuleId
bool	blnDefaultMin
DNNClientAPI.MinMaxPersistanceType	ePersistanceType

EnableMinMax(Control, Control, int, bool, string, string, MinMaxPersistanceType)

Declaration

public static void EnableMinMax(Control objButton, Control objContent, int intModuleId, bool blnDefaultMin, string strMinIconLoc, string strMaxIconLoc, DNNClientAPI.MinMaxPersistanceType ePersistanceType)

Parameters

Type	Name	Description
Control	objButton
Control	objContent
int	intModuleId
bool	blnDefaultMin
string	strMinIconLoc
string	strMaxIconLoc
DNNClientAPI.MinMaxPersistanceType	ePersistanceType

EnableMinMax(Control, Control, int, bool, string, string, MinMaxPersistanceType, int)

Declaration

public static void EnableMinMax(Control objButton, Control objContent, int intModuleId, bool blnDefaultMin, string strMinIconLoc, string strMaxIconLoc, DNNClientAPI.MinMaxPersistanceType ePersistanceType, int intAnimationFrames)

Parameters

Type	Name	Description
Control	objButton
Control	objContent
int	intModuleId
bool	blnDefaultMin
string	strMinIconLoc
string	strMaxIconLoc
DNNClientAPI.MinMaxPersistanceType	ePersistanceType
int	intAnimationFrames

EnableMinMax(Control, Control, int, bool, string, string, MinMaxPersistanceType, int, string, string)

Declaration

public static void EnableMinMax(Control objButton, Control objContent, int intModuleId, bool blnDefaultMin, string strMinIconLoc, string strMaxIconLoc, DNNClientAPI.MinMaxPersistanceType ePersistanceType, int intAnimationFrames, string strPersonalizationNamingCtr, string strPersonalizationKey)

Parameters

Type	Name	Description
Control	objButton
Control	objContent
int	intModuleId
bool	blnDefaultMin
string	strMinIconLoc
string	strMaxIconLoc
DNNClientAPI.MinMaxPersistanceType	ePersistanceType
int	intAnimationFrames
string	strPersonalizationNamingCtr
string	strPersonalizationKey

InitFileManager(Page)

Declaration

public static void InitFileManager(Page objPage)

Parameters

Type	Name	Description
Page	objPage

IsPersonalizationKeyRegistered(string)

Declaration

public static bool IsPersonalizationKeyRegistered(string strKey)

Parameters

Type	Name	Description
string	strKey

Returns

Type	Description
bool

MinMaxContentVisibile(Control, bool, MinMaxPersistanceType)

Declaration

public static bool MinMaxContentVisibile(Control objButton, bool blnDefaultMin, DNNClientAPI.MinMaxPersistanceType ePersistanceType)

Parameters

Type	Name	Description
Control	objButton
bool	blnDefaultMin
DNNClientAPI.MinMaxPersistanceType	ePersistanceType

Returns

Type	Description
bool

MinMaxContentVisibile(Control, bool, MinMaxPersistanceType, bool)

Declaration

public static void MinMaxContentVisibile(Control objButton, bool blnDefaultMin, DNNClientAPI.MinMaxPersistanceType ePersistanceType, bool value)

Parameters

Type	Name	Description
Control	objButton
bool	blnDefaultMin
DNNClientAPI.MinMaxPersistanceType	ePersistanceType
bool	value

MinMaxContentVisibile(Control, int, bool, MinMaxPersistanceType)

Declaration

public static bool MinMaxContentVisibile(Control objButton, int intModuleId, bool blnDefaultMin, DNNClientAPI.MinMaxPersistanceType ePersistanceType)

Parameters

Type	Name	Description
Control	objButton
int	intModuleId
bool	blnDefaultMin
DNNClientAPI.MinMaxPersistanceType	ePersistanceType

Returns

Type	Description
bool

MinMaxContentVisibile(Control, int, bool, MinMaxPersistanceType, bool)

Declaration

public static void MinMaxContentVisibile(Control objButton, int intModuleId, bool blnDefaultMin, DNNClientAPI.MinMaxPersistanceType ePersistanceType, bool value)

Parameters

Type	Name	Description
Control	objButton
int	intModuleId
bool	blnDefaultMin
DNNClientAPI.MinMaxPersistanceType	ePersistanceType
bool	value

SetInitialFocus(Page, Control)

Declaration

public static void SetInitialFocus(Page objPage, Control control)

Parameters

Type	Name	Description
Page	objPage
Control	control

SetScrollTop(Page)

Declaration

public static void SetScrollTop(Page objPage)

Parameters

Type	Name	Description
Page	objPage

ShowModalPage(Page, string)

Declaration

public static void ShowModalPage(Page objPage, string url)

Parameters

Type	Name	Description
Page	objPage
string	url

Extension Methods

JsonExtensionsWeb.ToJson(object)