Class NavigationManager

Represents navigation manager.

Inheritance
System.Object
NavigationManager
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Mediachase.Commerce.Customization
Assembly: Mediachase.Commerce.dll
Version: 10.8.0
Syntax
public sealed class NavigationManager

Fields

CommandTypeClientAction

Declaration
public const string CommandTypeClientAction = "ClientAction"
Field Value
Type Description
System.String

CommandTypeNavigate

Declaration
public const string CommandTypeNavigate = "Navigate"
Field Value
Type Description
System.String

ItemArgumentClientScript

Declaration
public const string ItemArgumentClientScript = "clientscript"
Field Value
Type Description
System.String

ItemArgumentCommand

Declaration
public const string ItemArgumentCommand = "command"
Field Value
Type Description
System.String

ItemArgumentCommandType

Declaration
public const string ItemArgumentCommandType = "commandtype"
Field Value
Type Description
System.String

ItemArgumentEnableHandler

Declaration
public const string ItemArgumentEnableHandler = "enablehandler"
Field Value
Type Description
System.String

ItemArgumentIconUrl

Declaration
public const string ItemArgumentIconUrl = "iconurl"
Field Value
Type Description
System.String

ItemArgumentOrder

Declaration
public const string ItemArgumentOrder = "order"
Field Value
Type Description
System.String

ItemArgumentParams

Declaration
public const string ItemArgumentParams = "params"
Field Value
Type Description
System.String

ItemArgumentPermissions

Declaration
public const string ItemArgumentPermissions = "permissions"
Field Value
Type Description
System.String

ItemArgumentTarget

Declaration
public const string ItemArgumentTarget = "target"
Field Value
Type Description
System.String

ItemArgumentText

Declaration
public const string ItemArgumentText = "text"
Field Value
Type Description
System.String

ItemArgumentUrl

Declaration
public const string ItemArgumentUrl = "url"
Field Value
Type Description
System.String

Methods

AddClientScriptItem(String, Int32, String, String, String, FileInfo)

Adds the client script item.

Declaration
public static void AddClientScriptItem(string parentFullId, int order, string text, string script, string permissions, FileInfo iconInfo)
Parameters
Type Name Description
System.String parentFullId

The parent full id.

System.Int32 order

The order.

System.String text

The text.

System.String script

The script.

System.String permissions

The permissions.

FileInfo iconInfo

The icon info.

AddNavigationItem(String, Int32, String, String, String, FileInfo)

Adds the navigation Item.

Declaration
public static void AddNavigationItem(string parentFullId, int order, string text, string url, string permissions, FileInfo iconInfo)
Parameters
Type Name Description
System.String parentFullId

The parent full id.

System.Int32 order

The order.

System.String text

The text.

System.String url

The URL.

System.String permissions

The permissions.

FileInfo iconInfo

The icon info.

DeleteNavigationItem(String)

Deletes the navigation item.

Declaration
public static void DeleteNavigationItem(string fullId)
Parameters
Type Name Description
System.String fullId

The full id.

GetCustomizationItem(String, ItemCommandType)

Gets the customization item.

Declaration
public static CustomizationItemEntity GetCustomizationItem(string fullId, ItemCommandType commandType)
Parameters
Type Name Description
System.String fullId

The full id.

ItemCommandType commandType

Type of the command.

Returns
Type Description
CustomizationItemEntity

GetCustomizationItemArguments(PrimaryKeyId)

Gets the customization item arguments.

Declaration
public static Dictionary<string, CustomizationItemArgumentEntity> GetCustomizationItemArguments(PrimaryKeyId itemId)
Parameters
Type Name Description
PrimaryKeyId itemId

The item id.

Returns
Type Description
System.Collections.Generic.Dictionary<System.String, CustomizationItemArgumentEntity>

GetCustomizationItemArguments(String, ItemCommandType)

Gets the customization item arguments.

Declaration
public static Dictionary<string, CustomizationItemArgumentEntity> GetCustomizationItemArguments(string fullId, ItemCommandType commandType)
Parameters
Type Name Description
System.String fullId

The full id.

ItemCommandType commandType

Type of the command.

Returns
Type Description
System.Collections.Generic.Dictionary<System.String, CustomizationItemArgumentEntity>

HideCustomizationItem(String)

Hides the customization item.

Declaration
public static void HideCustomizationItem(string fullId)
Parameters
Type Name Description
System.String fullId

The full id.

ModifyNavigationItem(String, Int32, String, String, FileInfo)

Modifies the navigation item.

Declaration
public static void ModifyNavigationItem(string fullId, int order, string text, string permissions, FileInfo iconInfo)
Parameters
Type Name Description
System.String fullId

The full id.

System.Int32 order

The order.

System.String text

The text.

System.String permissions

The permissions.

FileInfo iconInfo

The icon info.

ShowCustomizationItem(String)

Shows the hidden customization item.

Declaration
public static void ShowCustomizationItem(string fullId)
Parameters
Type Name Description
System.String fullId

The full id.

UndoModifyNavigationItem(String)

Undoes the modify navigation item.

Declaration
public static void UndoModifyNavigationItem(string xmlFullId)
Parameters
Type Name Description
System.String xmlFullId

The XML full id.

UpdateClientScriptItem(String, Int32, String, String, String, FileInfo)

Updates the client script item.

Declaration
public static void UpdateClientScriptItem(string fullId, int order, string text, string script, string permissions, FileInfo iconInfo)
Parameters
Type Name Description
System.String fullId

The full id.

System.Int32 order

The order.

System.String text

The text.

System.String script

The script.

System.String permissions

The permissions.

FileInfo iconInfo

The icon info.

UpdateNavigationItem(String, Int32, String, String, String, FileInfo)

Updates the navigation item.

Declaration
public static void UpdateNavigationItem(string fullId, int order, string text, string url, string permissions, FileInfo iconInfo)
Parameters
Type Name Description
System.String fullId

The full id.

System.Int32 order

The order.

System.String text

The text.

System.String url

The URL.

System.String permissions

The permissions.

FileInfo iconInfo

The icon info.