Class QuickNavigatorMenu

Class for rendering quick navigator menu

Inheritance
System.Object
QuickNavigatorMenu
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: EPiServer.Web
Assembly: EPiServer.dll
Version: 8.11.0
Syntax
public class QuickNavigatorMenu

Constructors

QuickNavigatorMenu()

Initializes a new instance of the QuickNavigatorMenu class.

Declaration
public QuickNavigatorMenu()

Properties

Gets or sets the content reference for the current content.

Declaration
public ContentReference CurrentContentLink { get; set; }
Property Value
Type Description
ContentReference

Gets or sets the current CMS page link.

Declaration
[Obsolete("This property is obsolete. Use CurrentContentReference instead.")]
public PageReference CurrentPageLink { get; set; }
Property Value
Type Description
PageReference

DefaultUrl

Gets the default URL of the QuickNavigator.

Declaration
public string DefaultUrl { get; }
Property Value
Type Description
System.String

EditPageUrl

Gets the URL to edit mode for the current content.

Declaration
public string EditPageUrl { get; }
Property Value
Type Description
System.String

Items

Gets the collection of menu items for the quick navigator.

Declaration
public IDictionary<string, QuickNavigatorMenuItem> Items { get; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.String, QuickNavigatorMenuItem>

The menu items.

ObjectSerializerFactory

Gets or sets the object serializer to use when serializing to Json.

Declaration
protected Injected<IObjectSerializerFactory> ObjectSerializerFactory { get; set; }
Property Value
Type Description
Injected<IObjectSerializerFactory>

The object serializer.

Methods

Add(String, QuickNavigatorMenuItem)

Add menu item

Declaration
public void Add(string name, QuickNavigatorMenuItem item)
Parameters
Type Name Description
System.String name

Name of item

QuickNavigatorMenuItem item

Initialized menu item

RegisterRequiredResources()

Renders the complete menu with JavaScript and surrounding script tags.

Declaration
public virtual void RegisterRequiredResources()

SerializeSettings()

Serializes the settings for the quicknavigator.

Declaration
public virtual string SerializeSettings()
Returns
Type Description
System.String

The settings as a string in JSON format.

Extension Methods