Class DNNClientAPI

Library responsible for interacting with DNN Client API.

Inheritance

System.Object

DNNClientAPI

Namespace: DotNetNuke.UI.Utilities

Assembly: DotNetNuke.dll

Syntax

public class DNNClientAPI : object

Methods

AddBodyOnloadEventHandler(Page, String)

Adds client side body.onload event handler.

Declaration

public static void AddBodyOnloadEventHandler(Page objPage, string strJSFunction)

Parameters

Type	Name	Description
Page	objPage	Current page rendering content.
System.String	strJSFunction	Javascript function name to execute.

EnableClientPersonalization(String, String, Page)

Library responsible for interacting with DNN Client API.

Declaration

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

Parameters

Type	Name	Description
System.String	strNamingContainer
System.String	strKey
Page	objPage

Returns

Type	Description
System.Boolean

EnableContainerDragAndDrop(Control, Control, Int32)

Allows any module to have drag and drop functionality enabled.

Declaration

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

Parameters

Type	Name	Description
Control	objTitle	Title element that responds to the click and dragged.
Control	objContainer	Container.
System.Int32	moduleID	Module ID.

Remarks

This sub also will send down information to notify the client of the panes that have been defined in the current skin.

EnableDragDrop(Page)

Library responsible for interacting with DNN Client API.

Declaration

public static void EnableDragDrop(Page objPage)

Parameters

Type	Name	Description
Page	objPage

EnableMinMax(Control, Control, Boolean, DNNClientAPI.MinMaxPersistanceType)

Allows a button and a content area to support client side min/max functionality.

Declaration

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

Parameters

Type	Name	Description
Control	objButton	Control that when clicked causes content area to be hidden/shown.
Control	objContent	Content area that is hidden/shown.
System.Boolean	blnDefaultMin	If content area is to be defaulted to minimized pass in true.
DNNClientAPI.MinMaxPersistanceType	ePersistanceType	How to store current state of min/max. Cookie, Page, None.

Remarks

This method's purpose is to provide a higher level of abstraction between the ClientAPI and the module developer.

EnableMinMax(Control, Control, Boolean, String, String, DNNClientAPI.MinMaxPersistanceType, String, String)

Library responsible for interacting with DNN Client API.

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
System.Boolean	blnDefaultMin
System.String	strMinIconLoc
System.String	strMaxIconLoc
DNNClientAPI.MinMaxPersistanceType	ePersistanceType
System.String	strPersonalizationNamingCtr
System.String	strPersonalizationKey

EnableMinMax(Control, Control, Boolean, String, String, DNNClientAPI.MinMaxPersistanceType)

Library responsible for interacting with DNN Client API.

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
System.Boolean	blnDefaultMin
System.String	strMinIconLoc
System.String	strMaxIconLoc
DNNClientAPI.MinMaxPersistanceType	ePersistanceType

EnableMinMax(Control, Control, Int32, Boolean, DNNClientAPI.MinMaxPersistanceType)

Library responsible for interacting with DNN Client API.

Declaration

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

Parameters

Type	Name	Description
Control	objButton
Control	objContent
System.Int32	intModuleId
System.Boolean	blnDefaultMin
DNNClientAPI.MinMaxPersistanceType	ePersistanceType

EnableMinMax(Control, Control, Int32, Boolean, String, String, DNNClientAPI.MinMaxPersistanceType, Int32, String, String)

Library responsible for interacting with DNN Client API.

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
System.Int32	intModuleId
System.Boolean	blnDefaultMin
System.String	strMinIconLoc
System.String	strMaxIconLoc
DNNClientAPI.MinMaxPersistanceType	ePersistanceType
System.Int32	intAnimationFrames
System.String	strPersonalizationNamingCtr
System.String	strPersonalizationKey

EnableMinMax(Control, Control, Int32, Boolean, String, String, DNNClientAPI.MinMaxPersistanceType, Int32)

Library responsible for interacting with DNN Client API.

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
System.Int32	intModuleId
System.Boolean	blnDefaultMin
System.String	strMinIconLoc
System.String	strMaxIconLoc
DNNClientAPI.MinMaxPersistanceType	ePersistanceType
System.Int32	intAnimationFrames

EnableMinMax(Control, Control, Int32, Boolean, String, String, DNNClientAPI.MinMaxPersistanceType)

Allows a button and a content area to support client side min/max functionality.

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 that when clicked causes content area to be hidden/shown.
Control	objContent	Content area that is hidden/shown.
System.Int32	intModuleId	Module id of button/content, used only for persistance type of Cookie.
System.Boolean	blnDefaultMin	If content area is to be defaulted to minimized pass in true.
System.String	strMinIconLoc	Location of minimized icon.
System.String	strMaxIconLoc	Location of maximized icon.
DNNClientAPI.MinMaxPersistanceType	ePersistanceType	How to store current state of min/max. Cookie, Page, None.

Remarks

This method's purpose is to provide a higher level of abstraction between the ClientAPI and the module developer.

InitFileManager(Page)

Library responsible for interacting with DNN Client API.

Declaration

public static void InitFileManager(Page objPage)

Parameters

Type	Name	Description
Page	objPage

IsPersonalizationKeyRegistered(String)

Library responsible for interacting with DNN Client API.

Declaration

public static bool IsPersonalizationKeyRegistered(string strKey)

Parameters

Type	Name	Description
System.String	strKey

Returns

Type	Description
System.Boolean

MinMaxContentVisibile(Control, Boolean, DNNClientAPI.MinMaxPersistanceType, Boolean)

Library responsible for interacting with DNN Client API.

Declaration

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

Parameters

Type	Name	Description
Control	objButton
System.Boolean	blnDefaultMin
DNNClientAPI.MinMaxPersistanceType	ePersistanceType
System.Boolean	value

MinMaxContentVisibile(Control, Boolean, DNNClientAPI.MinMaxPersistanceType)

Library responsible for interacting with DNN Client API.

Declaration

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

Parameters

Type	Name	Description
Control	objButton
System.Boolean	blnDefaultMin
DNNClientAPI.MinMaxPersistanceType	ePersistanceType

Returns

Type	Description
System.Boolean

MinMaxContentVisibile(Control, Int32, Boolean, DNNClientAPI.MinMaxPersistanceType, Boolean)

Library responsible for interacting with DNN Client API.

Declaration

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

Parameters

Type	Name	Description
Control	objButton
System.Int32	intModuleId
System.Boolean	blnDefaultMin
DNNClientAPI.MinMaxPersistanceType	ePersistanceType
System.Boolean	value

MinMaxContentVisibile(Control, Int32, Boolean, DNNClientAPI.MinMaxPersistanceType)

Library responsible for interacting with DNN Client API.

Declaration

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

Parameters

Type	Name	Description
Control	objButton
System.Int32	intModuleId
System.Boolean	blnDefaultMin
DNNClientAPI.MinMaxPersistanceType	ePersistanceType

Returns

Type	Description
System.Boolean

SetInitialFocus(Page, Control)

Library responsible for interacting with DNN Client API.

Declaration

public static void SetInitialFocus(Page objPage, Control control)

Parameters

Type	Name	Description
Page	objPage
Control	control

SetScrollTop(Page)

Library responsible for interacting with DNN Client API.

Declaration

public static void SetScrollTop(Page objPage)

Parameters

Type	Name	Description
Page	objPage

ShowModalPage(Page, String)

Library responsible for interacting with DNN Client API.

Declaration

public static void ShowModalPage(Page objPage, string url)

Parameters

Type	Name	Description
Page	objPage
System.String	url

Extension Methods

JsonExtensionsWeb.ToJson(Object)