Interface INavigationManager

Provides navigation services.

Namespace: DotNetNuke.Abstractions

Assembly: DotNetNuke.Abstractions.dll

Syntax

public interface INavigationManager

Methods

| Improve this Doc View Source

NavigateURL()

Gets the URL to the current page.

Declaration

string NavigateURL()

Returns

Type	Description
System.String	Formatted URL.

| Improve this Doc View Source

NavigateURL(Int32, IPortalSettings, String, String[])

Gets the URL to show the given page.

Declaration

string NavigateURL(int tabID, IPortalSettings settings, string controlKey, params string[] additionalParameters)

Parameters

Type	Name	Description
System.Int32	tabID	The tab ID.
IPortalSettings	settings	The portal settings.
System.String	controlKey	The control key, or or `null`.
System.String[]	additionalParameters	Any additional parameters.

Returns

Type	Description
System.String	Formatted URL.

| Improve this Doc View Source

NavigateURL(Int32, Boolean, IPortalSettings, String, String, String, String[])

Gets the URL to show the given page.

Declaration

string NavigateURL(int tabID, bool isSuperTab, IPortalSettings settings, string controlKey, string language, string pageName, params string[] additionalParameters)

Parameters

Type	Name	Description
System.Int32	tabID	The tab ID.
System.Boolean	isSuperTab	if set to `true` the page is a "super-tab," i.e. a host-level page.
IPortalSettings	settings	The portal settings.
System.String	controlKey	The control key, or or `null`.
System.String	language	The language code.
System.String	pageName	The page name to pass.
System.String[]	additionalParameters	Any additional parameters.

Returns

Type	Description
System.String	Formatted url.

| Improve this Doc View Source

NavigateURL(Int32, Boolean, IPortalSettings, String, String, String[])

Gets the URL to show the given page.

Declaration

string NavigateURL(int tabID, bool isSuperTab, IPortalSettings settings, string controlKey, string language, params string[] additionalParameters)

Parameters

Type	Name	Description
System.Int32	tabID	The tab ID.
System.Boolean	isSuperTab	if set to `true` the page is a "super-tab," i.e. a host-level page.
IPortalSettings	settings	The portal settings.
System.String	controlKey	The control key, or or `null`.
System.String	language	The language code.
System.String[]	additionalParameters	Any additional parameters.

Returns

Type	Description
System.String	Formatted URL.

| Improve this Doc View Source

NavigateURL(Int32, Boolean, IPortalSettings, String, String[])

Gets the URL to show the given page.

Declaration

string NavigateURL(int tabID, bool isSuperTab, IPortalSettings settings, string controlKey, params string[] additionalParameters)

Parameters

Type	Name	Description
System.Int32	tabID	The tab ID.
System.Boolean	isSuperTab	if set to `true` the page is a "super-tab," i.e. a host-level page.
IPortalSettings	settings	The portal settings.
System.String	controlKey	The control key, or or `null`.
System.String[]	additionalParameters	Any additional parameters.

Returns

Type	Description
System.String	Formatted URL.

| Improve this Doc View Source

NavigateURL(Int32, Boolean)

Gets the URL to the given page.

Declaration

string NavigateURL(int tabID, bool isSuperTab)

Parameters

Type	Name	Description
System.Int32	tabID	The tab ID.
System.Boolean	isSuperTab	if set to `true` the page is a "super-tab," i.e. a host-level page.

Returns

Type	Description
System.String	Formatted URL.

| Improve this Doc View Source

NavigateURL(Int32, String, String[])

Gets the URL to show the given page.

Declaration

string NavigateURL(int tabID, string controlKey, params string[] additionalParameters)

Parameters

Type	Name	Description
System.Int32	tabID	The tab ID.
System.String	controlKey	The control key, or or `null`.
System.String[]	additionalParameters	Any additional parameters.

Returns

Type	Description
System.String	Formatted URL.

| Improve this Doc View Source

NavigateURL(Int32, String)

Gets the URL to show the control associated with the given control key on the given page.

Declaration

string NavigateURL(int tabID, string controlKey)

Parameters

Type	Name	Description
System.Int32	tabID	The tab ID.
System.String	controlKey	The control key, or or `null`.

Returns

Type	Description
System.String	Formatted URL.

| Improve this Doc View Source

NavigateURL(Int32)

Gets the URL to the given page.

Declaration

string NavigateURL(int tabID)

Parameters

Type	Name	Description
System.Int32	tabID	The tab ID.

Returns

Type	Description
System.String	Formatted URL.

| Improve this Doc View Source

NavigateURL(String, String[])

Gets the URL to show the control associated with the given control key.

Declaration

string NavigateURL(string controlKey, params string[] additionalParameters)

Parameters

Type	Name	Description
System.String	controlKey	The control key, or or `null`.
System.String[]	additionalParameters	Any additional parameters, in `"key=value"` format.

Returns

Type	Description
System.String	Formatted URL.

| Improve this Doc View Source

NavigateURL(String)

Gets the URL to show the control associated with the given control key.

Declaration

string NavigateURL(string controlKey)

Parameters

Type	Name	Description
System.String	controlKey	The control key, or or `null`.

Returns

Type	Description
System.String	Formatted URL.

Extension Methods

JsonExtensionsWeb.ToJson(Object)