Office.BindingSelectionChangedEventArgs interface

Пакет:

office

Предоставляет сведения о привязке, вызвавшей событие SelectionChanged.

Комментарии

Используется

• Office.RemoveHandlerOptions: обработчик

Свойства

binding	Получает объект Office.Binding , представляющий привязку, которая вызвала событие SelectionChanged.
columnCount	Получает количество выбранных столбцов. Если выбрана одна ячейка, то возвращается значение 1. Если пользователь делает не сплошной выбор, то возвращается количество для последнего сплошного выбора. В Word это свойство будет работать только для привязок Office.BindingType "таблица". Если привязка имеет тип "matrix", возвращается значение null. Кроме того, вызов завершится неудачно, если в таблице имеются объединенные ячейки, поскольку для правильной работы этого свойства структура таблицы должна быть однородной.
rowCount	Получает количество выбранных строк. Если выбрана одна ячейка, то возвращается значение 1. Если пользователь делает не сплошной выбор, то возвращается количество для последнего сплошного выбора. В Word это свойство будет работать только для привязок Office.BindingType "таблица". Если привязка имеет тип "matrix", возвращается значение null. Кроме того, вызов завершится неудачно, если в таблице имеются объединенные ячейки, поскольку для правильной работы этого свойства структура таблицы должна быть однородной.
startColumn	Отсчитываемый от нуля индекс первого столбца текущего выбора, начиная с самого левого столбца в привязке. Если пользователь выбирает не смежные столбцы, то возвращаются координаты последнего сплошного выбора. В Word это свойство будет работать только для привязок Office.BindingType "таблица". Если привязка имеет тип "matrix", возвращается значение null. Кроме того, вызов завершится неудачно, если в таблице имеются объединенные ячейки, поскольку для правильной работы этого свойства структура таблицы должна быть однородной.
startRow	Отсчитываемый от нуля индекс первой строки текущего выбора, начиная с первой строки в привязке. Если пользователь выбирает не смежные строки, то возвращаются координаты последнего сплошного выбора. В Word это свойство будет работать только для привязок Office.BindingType "таблица". Если привязка имеет тип "matrix", возвращается значение null. Кроме того, вызов завершится неудачно, если в таблице имеются объединенные ячейки, поскольку для правильной работы этого свойства структура таблицы должна быть однородной.
type	Получает значение перечисления Office.EventType , определяющее тип возникшего события.

Сведения о свойстве

binding

Получает объект Office.Binding , представляющий привязку, которая вызвала событие SelectionChanged.

binding: Binding;

Значение свойства

Office.Binding

columnCount

Получает количество выбранных столбцов. Если выбрана одна ячейка, то возвращается значение 1.

Если пользователь делает не сплошной выбор, то возвращается количество для последнего сплошного выбора.

В Word это свойство будет работать только для привязок Office.BindingType "таблица". Если привязка имеет тип "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 "таблица". Если привязка имеет тип "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 "таблица". Если привязка имеет тип "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 "таблица". Если привязка имеет тип "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