ProjectDocument.ViewSelectionChanged event

Occurs when the active view changes in the active project.

Office.EventType.ViewSelectionChanged

Remarks

ViewSelectionChanged is an EventType enumeration constant that can be used in the ProjectDocument.addHandlerAsync and ProjectDocument.removeHandlerAsync methods to add or remove a handler for the event.

Example

The following code example adds a handler for the ViewSelectionChanged event. When the active view changes, it gets the name and type of the active view.

The example assumes your add-in has a reference to the jQuery library and that the following page control is defined in the content div in the page body.

<span id="message"></span>

(function () {
    "use strict";

    // The initialize function must be run each time a new page is loaded.
    Office.initialize = function (reason) {
        $(document).ready(function () {

            // After the DOM is loaded, add-in-specific code can run.
            Office.context.document.addHandlerAsync(
                Office.EventType.ViewSelectionChanged,
                getActiveView);
            getActiveView();
        });
    };

    // Get the name and type of the active view and display it in the add-in.
    function getActiveView() {
        Office.context.document.getSelectedViewAsync(
            function (result) {
                if (result.status === Office.AsyncResultStatus.Failed) {
                    onError(result.error);
                }
                else {
                    var output = String.format(
                        'View name: {0}<br/>View type: {1}',
                        result.value.viewName, result.value.viewType);
                    $('#message').html(output);
                }
            }
        );
    }

    function onError(error) {
        $('#message').html(error.name + ' ' + error.code + ': ' + error.message);
    }
})();

For an example that shows how to use a ViewSelectionChanged event handler in a Project add-in, see Create your first task pane add-in for Project 2013 by using a text editor.

Support details

A capital Y in the following matrix indicates that this event is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this event.

For more information about Office host application and server requirements, see Requirements for running Office Add-ins.

Support history

See also

Other resources

Create your first task pane add-in for Project 2013 by using a text editor EventType enumeration ProjectDocument.addHandlerAsync method ProjectDocument.removeHandlerAsync method ProjectDocument object