SP.ViewCollection.add Method (sp.js)

  • Article

Adds a new list view to the collection.

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

SP.ViewCollection.add()

Parameters

Return value

Type: SP.View

The new list view.

Remarks

This method creates a new list view based on the specified View list properties.

Example

The following example creates an Input button on an application page that adds a new view to the Tasks list of the current site, and displays the Tasks list's current views.

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

    var viewCollection = null;
    function runCode() {

        var clientContext = new SP.ClientContext.get_current();
        if (clientContext != undefined && clientContext != null) {
            var web = clientContext.get_web();

            var listCollection = web.get_lists();
            var list = listCollection.getByTitle("Tasks");
            this.viewCollection = list.get_views();

            var viewInfo = new SP.ViewCreationInformation();
            viewInfo.set_title('MyView');
            this.viewCollection.add(viewInfo);

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

    function onQuerySucceeded() {
        var viewInfo = 'Tasks list current views: \n\n';
        var viewEnumerator = this.viewCollection.getEnumerator();
        while (viewEnumerator.moveNext()) {
            var view = viewEnumerator.get_current();
            viewInfo += view.get_title() + '\n';
        }
        alert(viewInfo);
    }

    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>

REST resource endpoint

Endpoint URI structure

http://<sitecollection>/<site>/_api/web/lists(listid)/Views/add(parameters)

HTTP requests

This resource supports the following HTTP commands:

  • POST

POST syntax

POST http://<sitecollection>/<site>/_api/web/lists(listid)/Views/add(parameters)

Resource parameters

  • parameters