SP.NavigationNode object

Article
08/29/2016

Represents the URL to a specific navigation node and provides access to properties and methods for manipulating the ordering of the navigation node in a navigation node collection.

Applies to: apps for SharePoint | SharePoint Foundation 2013 | SharePoint Server 2013

var object = new SP.NavigationNode()

Members

The NavigationNode object has the following members.

Constructor

The NavigationNode object has the following constructor.

Constructor	Description
NavigationNode	Initializes a new instance of the SP.NavigationNode object.

Methods

The NavigationNode object has the following methods.

Method	Description
deleteObject	Deletes the navigation node.
initPropertiesFromJson
update	Updates property changes that have been made to the navigation node.

Properties

The NavigationNode object has the following properties.

Property	Description
children	Gets the collection of child nodes of the navigation node.
id	Gets a value that specifies the identifier for the navigation node.
isDocLib
isExternal
isVisible
title	Gets or sets value that specifies the anchor text for the navigation node link.
url	Gets or sets a value that specifies the URL stored with the navigation node.

Example

The following example creates an input button on an application page that adds a node to the Quick Launch area of the current Web site and displays the current Quick Launch nodes.

<asp:Content ID="Main" ContentPlaceHolderID="PlaceHolderMain" runat="server">
<script type="text/ecmascript" language="ecmascript">

    var quickLaunchNodeCollection = null;
    var nnci = null;
    function runCode() {

        var clientContext = new SP.ClientContext.get_current();

        if (clientContext != undefined && clientContext != null) {
            var web = clientContext.get_web();

            // Get the Quick Launch navigation node collection.
            this.quickLaunchNodeCollection = web.get_navigation().get_quickLaunch();

            // Set properties for a new navigation node.
            this.nnci = new SP.NavigationNodeCreationInformation();
            nnci.set_title('MyNode');
            nnci.set_url('https://localhost');
            // Create node as the last node in the collection.
            nnci.set_asLastNode(true);
            this.quickLaunchNodeCollection.add(nnci);

            clientContext.load(this.quickLaunchNodeCollection);
            clientContext.executeQueryAsync(Function.createDelegate(this, this.onQuerySucceeded), Function.createDelegate(this, this.onQueryFailed));
        }
    }

    function onQuerySucceeded() {
        var nodeInfo = '';
        var nodeEnumerator = this.quickLaunchNodeCollection.getEnumerator();
        while (nodeEnumerator.moveNext()) {
            var node = nodeEnumerator.get_current();
            nodeInfo += node.get_title() + '\n';
        }
        alert("Current nodes: \n\n" + nodeInfo);
    }

    function onQueryFailed(sender, args) {
        alert('Request failed. ' + args.get_message() + '\n' + args.get_stackTrace());
    }

</script>

    <input id="Button1" type="button" value="Run Code" onclick="runCode()" />

</asp:Content>

Share via