BindingSelectionChangedEventArgs.startRow property (JavaScript API for Office)

Office Add-ins

Gets the index of the first row of the selection (zero-based).

Last modified: June 22, 2015

Note Note

The name "apps for Office" is changing to "Office Add-ins". During the transition, the documentation and the UI of some Office host applications and Visual Studio tools might still use the term "apps for Office". For details, see New name for apps for Office and SharePoint.

Hosts:

Access, Excel, Word

Last changed in

1.1

See all support details

var startRw = eventArgsObj.startRow;

The zero-based index of the first row of the selection counting from the first row in the binding.

If the user makes a non-contiguous selection, the coordinates for the last contiguous selection within the binding are returned.

For Word, this property will work only for bindings of BindingType "table". If the binding is of type "matrix", null is returned. Also, the call will fail if the table contains merged cells, because the structure of the table must be uniform for this property to work correctly.

The following example adds an event handler for the SelectionChanged event to the binding with an id of myTable. When the user changes the selection, the handler displays the coordinates of the first cell in the selection, and the number of row and columns selected.

function addSelectionHandler() {
    Office.context.document.bindings.getByIdAsync("myTable", function (result) {
        result.value.addHandlerAsync("bindingSelectionChanged", myHandler);
    });
}

// Display selection start coordinates and row/column count.
function myHandler(bArgs) {
    write("Selection start row/col: " + bArgs.startRow + "," + bArgs.startColumn);
    write("Selection row count: " + bArgs.rowCount);
    write("Selection col count: " + bArgs.columnCount);
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

A checkmark (√) in the following matrix indicates that this property is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this property.

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

Supported hosts, by platform

Office for Windows desktop

Office Online
(in browser)

Office for iPad

Access

Excel

Word

Minimum permission level

Restricted

App types

Content, task pane

Library

Office.js

Namespace

Office

Version

Changes

1.1

Added support for Excel and Word in Office for iPad.

1.1

Added support for apps for Access.

1.0

Introduced

Show:
© 2015 Microsoft