通过

Office.BindingSelectionChangedEventArgs interface

  • 参考
包:
office

提供有关引发了 SelectionChanged 事件的绑定的信息。

属性

binding

获取一个 Office.Binding 对象，该对象表示引发 SelectionChanged 事件的绑定。
columnCount

获取选择的列数。 如果只选择了一个单元格，则返回 1。

如果用户选择了不连续的单元格，则返回此绑定内最后一个连续选区的计数。

对于Word，此属性仅适用于 Office.BindingType“table”的绑定。 如果绑定类型为"matrix"，将返回 null。 此外，如果表格包含合并单元格，调用将失败，因为表的结构必须统一，此属性才能正确工作。
rowCount

获取选择的行数。 如果只选择了一个单元格，则返回 1。

如果用户选择了不连续的单元格，则返回此绑定内最后一个连续选区的计数。

对于Word，此属性仅适用于 Office.BindingType“table”的绑定。 如果绑定类型为"matrix"，将返回 null。 此外，如果表格包含合并单元格，调用将失败，因为表的结构必须统一，此属性才能正确工作。
startColumn

所选内容第一列的从零开始的索引；从绑定中最左侧的列开始算起。

如果用户选择了不连续的单元格，则返回此绑定内最后一个连续选区的坐标。

对于Word，此属性仅适用于 Office.BindingType“table”的绑定。 如果绑定类型为"matrix"，将返回 null。 此外，如果表格包含合并单元格，调用将失败，因为表的结构必须统一，此属性才能正确工作。
startRow

所选内容第一行的从零开始的索引；从绑定中的第一行开始算起。

如果用户选择了不连续的单元格，则返回此绑定内最后一个连续选区的坐标。

对于Word，此属性仅适用于 Office.BindingType“table”的绑定。 如果绑定类型为"matrix"，将返回 null。 此外，如果表格包含合并单元格，调用将失败，因为表的结构必须统一，此属性才能正确工作。
type

获取一个 Office.EventType 枚举值，该值标识引发的事件类型。

属性详细信息

binding

获取一个 Office.Binding 对象，该对象表示引发 SelectionChanged 事件的绑定。

binding: Binding;

属性值

Office.Binding

columnCount

获取选择的列数。 如果只选择了一个单元格，则返回 1。

如果用户选择了不连续的单元格，则返回此绑定内最后一个连续选区的计数。

对于Word，此属性仅适用于 Office.BindingType“table”的绑定。 如果绑定类型为"matrix"，将返回 null。 此外，如果表格包含合并单元格，调用将失败，因为表的结构必须统一，此属性才能正确工作。

columnCount: number;

属性值

number

示例

// 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; 
}

rowCount

获取选择的行数。 如果只选择了一个单元格，则返回 1。

如果用户选择了不连续的单元格，则返回此绑定内最后一个连续选区的计数。

对于Word，此属性仅适用于 Office.BindingType“table”的绑定。 如果绑定类型为"matrix"，将返回 null。 此外，如果表格包含合并单元格，调用将失败，因为表的结构必须统一，此属性才能正确工作。

rowCount: number;

属性值

number

示例

// 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; 
}

startColumn

所选内容第一列的从零开始的索引；从绑定中最左侧的列开始算起。

如果用户选择了不连续的单元格，则返回此绑定内最后一个连续选区的坐标。

对于Word，此属性仅适用于 Office.BindingType“table”的绑定。 如果绑定类型为"matrix"，将返回 null。 此外，如果表格包含合并单元格，调用将失败，因为表的结构必须统一，此属性才能正确工作。

startColumn: number;

属性值

number

示例

// 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; 
}

startRow

所选内容第一行的从零开始的索引；从绑定中的第一行开始算起。

如果用户选择了不连续的单元格，则返回此绑定内最后一个连续选区的坐标。

对于Word，此属性仅适用于 Office.BindingType“table”的绑定。 如果绑定类型为"matrix"，将返回 null。 此外，如果表格包含合并单元格，调用将失败，因为表的结构必须统一，此属性才能正确工作。

startRow: number;

属性值

number

示例

// 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; 
}

type

获取一个 Office.EventType 枚举值，该值标识引发的事件类型。

type: EventType;

属性值

Office.EventType