Class DnnHelper

Inheritance

System.Object

DnnHelper

Namespace: DotNetNuke.Web.Mvc.Helpers

Assembly: DotNetNuke.Web.Mvc.dll

Syntax

public class DnnHelper : object

Constructors

| Improve this Doc View Source

DnnHelper(HtmlHelper)

Initializes a new instance of the DnnHelper class.

Declaration

protected DnnHelper(HtmlHelper htmlHelper)

Parameters

Type	Name	Description
HtmlHelper	htmlHelper	The HtmlHelper instance to wrap.

| Improve this Doc View Source

DnnHelper(ViewContext, IViewDataContainer, RouteCollection)

Initializes a new instance of the DnnHelper class.

Declaration

public DnnHelper(ViewContext viewContext, IViewDataContainer viewDataContainer, RouteCollection routeCollection)

Parameters

Type	Name	Description
ViewContext	viewContext	The view context.
IViewDataContainer	viewDataContainer	The ViewData container.
RouteCollection	routeCollection	The route collection.

| Improve this Doc View Source

DnnHelper(ViewContext, IViewDataContainer)

Initializes a new instance of the DnnHelper class.

Declaration

public DnnHelper(ViewContext viewContext, IViewDataContainer viewDataContainer)

Parameters

Type	Name	Description
ViewContext	viewContext	The view context.
IViewDataContainer	viewDataContainer	The ViewData container.

Properties

| Improve this Doc View Source

ActiveModule

Declaration

public ModuleInfo ActiveModule { get; }

Property Value

Type	Description
ModuleInfo

| Improve this Doc View Source

ActivePage

Declaration

public TabInfo ActivePage { get; }

Property Value

Type	Description
TabInfo

| Improve this Doc View Source

DnnPage

Declaration

public Page DnnPage { get; set; }

Property Value

Type	Description
Page

| Improve this Doc View Source

LocalResourceFile

Declaration

public string LocalResourceFile { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

ModuleContext

Declaration

public ModuleInstanceContext ModuleContext { get; set; }

Property Value

Type	Description
ModuleInstanceContext

| Improve this Doc View Source

PortalSettings

Declaration

public PortalSettings PortalSettings { get; }

Property Value

Type	Description
PortalSettings

| Improve this Doc View Source

RouteCollection

Declaration

public RouteCollection RouteCollection { get; }

Property Value

Type	Description
RouteCollection

| Improve this Doc View Source

User

Declaration

public UserInfo User { get; }

Property Value

Type	Description
UserInfo

| Improve this Doc View Source

ViewBag

Declaration

public dynamic ViewBag { get; }

Property Value

Type	Description
System.Object

| Improve this Doc View Source

ViewContext

Declaration

public ViewContext ViewContext { get; }

Property Value

Type	Description
ViewContext

| Improve this Doc View Source

ViewData

Declaration

public ViewDataDictionary ViewData { get; }

Property Value

Type	Description
ViewDataDictionary

| Improve this Doc View Source

ViewDataContainer

Declaration

public IViewDataContainer ViewDataContainer { get; }

Property Value

Type	Description
IViewDataContainer

Methods

| Improve this Doc View Source

DnnCssInclude(String, FileOrder.Css)

Requests that a CSS file be registered on the client browser. Defaults to rendering in the page header.

Declaration

public void DnnCssInclude(string filePath, FileOrder.Css priority)

Parameters

Type	Name	Description
System.String	filePath	The relative file path to the CSS resource.
FileOrder.Css	priority	The relative priority in which the file should be loaded.

| Improve this Doc View Source

DnnCssInclude(String, Int32, String, String, String)

Requests that a CSS file be registered on the client browser. Allows for overriding the default provider.

Declaration

public void DnnCssInclude(string filePath, int priority, string provider, string name, string version)

Parameters

Type	Name	Description
System.String	filePath	The relative file path to the CSS resource.
System.Int32	priority	The relative priority in which the file should be loaded.
System.String	provider	The provider name to be used to render the css file on the page.
System.String	name	Name of framework like Bootstrap, Angular, etc.
System.String	version	Version nr of framework.

| Improve this Doc View Source

DnnCssInclude(String, Int32, String)

Requests that a CSS file be registered on the client browser. Allows for overriding the default provider.

Declaration

public void DnnCssInclude(string filePath, int priority, string provider)

Parameters

Type	Name	Description
System.String	filePath	The relative file path to the CSS resource.
System.Int32	priority	The relative priority in which the file should be loaded.
System.String	provider	The provider name to be used to render the css file on the page.

| Improve this Doc View Source

DnnCssInclude(String, Int32)

Requests that a CSS file be registered on the client browser. Defaults to rendering in the page header.

Declaration

public void DnnCssInclude(string filePath, int priority)

Parameters

Type	Name	Description
System.String	filePath	The relative file path to the CSS resource.
System.Int32	priority	The relative priority in which the file should be loaded.

| Improve this Doc View Source

DnnCssInclude(String)

Requests that a CSS file be registered on the client browser.

Declaration

public void DnnCssInclude(string filePath)

Parameters

Type	Name	Description
System.String	filePath	The relative file path to the CSS resource.

| Improve this Doc View Source

DnnJsInclude(String, FileOrder.Js)

Requests that a JavaScript file be registered on the client browser.

Declaration

public void DnnJsInclude(string filePath, FileOrder.Js priority)

Parameters

Type	Name	Description
System.String	filePath	The relative file path to the JavaScript resource.
FileOrder.Js	priority	The relative priority in which the file should be loaded.

| Improve this Doc View Source

DnnJsInclude(String, Int32, String, String, String)

Requests that a JavaScript file be registered on the client browser.

Declaration

public void DnnJsInclude(string filePath, int priority, string provider, string name, string version)

Parameters

Type	Name	Description
System.String	filePath	The relative file path to the JavaScript resource.
System.Int32	priority	The relative priority in which the file should be loaded.
System.String	provider	The name of the provider responsible for rendering the script output.
System.String	name	Name of framework like Bootstrap, Angular, etc.
System.String	version	Version nr of framework.

| Improve this Doc View Source

DnnJsInclude(String, Int32, String)

Requests that a JavaScript file be registered on the client browser.

Declaration

public void DnnJsInclude(string filePath, int priority, string provider)

Parameters

Type	Name	Description
System.String	filePath	The relative file path to the JavaScript resource.
System.Int32	priority	The relative priority in which the file should be loaded.
System.String	provider	The name of the provider responsible for rendering the script output.

| Improve this Doc View Source

DnnJsInclude(String, Int32)

Requests that a JavaScript file be registered on the client browser.

Declaration

public void DnnJsInclude(string filePath, int priority)

Parameters

Type	Name	Description
System.String	filePath	The relative file path to the JavaScript resource.
System.Int32	priority	The relative priority in which the file should be loaded.

| Improve this Doc View Source

DnnJsInclude(String)

Requests that a JavaScript file be registered on the client browser.

Declaration

public void DnnJsInclude(string filePath)

Parameters

Type	Name	Description
System.String	filePath	The relative file path to the JavaScript resource.

| Improve this Doc View Source

JavaScriptLibraryInclude(String, Version, SpecificVersion)

Requests that a script from a JavaScript Library be registered on the client browser.

Declaration

public void JavaScriptLibraryInclude(string name, Version version, SpecificVersion specificVersion)

Parameters

Type	Name	Description
System.String	name	The name of the JavaScript Library.
Version	version	The library's version.
SpecificVersion	specificVersion	How much of the `version` to pay attention to. When is passed, ignore the `version`. When is passed, match the major version. When is passed, match the major and minor versions. When is passed, match all parts of the version.

| Improve this Doc View Source

JavaScriptLibraryInclude(String, Version)

Requests that a script from a JavaScript Library be registered on the client browser.

Declaration

public void JavaScriptLibraryInclude(string name, Version version)

Parameters

Type	Name	Description
System.String	name	The name of the JavaScript Library.
Version	version	The library's version.

| Improve this Doc View Source

JavaScriptLibraryInclude(String)

Requests that a script from a JavaScript Library be registered on the client browser.

Declaration

public void JavaScriptLibraryInclude(string name)

Parameters

Type	Name	Description
System.String	name	The name of the JavaScript Library.

| Improve this Doc View Source

LocalizeString(String)

Declaration

public string LocalizeString(string key)

Parameters

Type	Name	Description
System.String	key

Returns

Type	Description
System.String

Extension Methods

JsonExtensionsWeb.ToJson(Object)