Office.AddBindingFromPromptOptions interface

Пакет:
office

Предоставляет параметры для настройки запроса и определения созданной привязки.

Комментарии

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

Примеры

// Add a binding to the document by prompting the user to select a cell in the document.
function addBinding() {
    const bindings = Office.context.document.bindings;
    const options: Office.AddBindingFromPromptOptions = { 
        id: "prompt-binding",
        promptText: "Select a cell" 
    };
    const callback = (asyncResult: Office.AsyncResult<Office.Binding>) => {
        if (asyncResult.status === Office.AsyncResultStatus.Failed) {
            console.error(asyncResult.error.message);
            return;
        }

        console.log(`Created binding "${asyncResult.value.id}" of type "${asyncResult.value.type}".`);
    };

    bindings.addFromPromptAsync(Office.BindingType.Text, options, callback);
}

Свойства

asyncContext

Определяемый пользователем элемент любого типа, возвращаемый без изменений в свойстве asyncContext объекта AsyncResult, передаваемого обратному вызову.
id

Уникальный идентификатор привязки. Автоматическое создание, если не предоставлено.
promptText

Указывает строку для отображения в запросе, в котором пользователю указывается элемент для выбора. Длина ограничена 200 символами. Если аргумент promptText не передан, отображается сообщение "Сделайте выбор".
sampleData

Указывает таблицу образцов данных, отображаемую в пользовательском интерфейсе командной строки в качестве примера типов полей (столбцов), которые могут быть связаны вашей надстройкой. Заголовки в объекте TableData указывают метки, используемые в пользовательском интерфейсе выбора поля.

Примечание. Этот параметр используется только в надстройках для Access. Он игнорируется, если он указан при вызове метода в надстройке для Excel.

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

asyncContext

Определяемый пользователем элемент любого типа, возвращаемый без изменений в свойстве asyncContext объекта AsyncResult, передаваемого обратному вызову.

asyncContext?: any

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

any

id

Уникальный идентификатор привязки. Автоматическое создание, если не предоставлено.

id?: string

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

string

promptText

Указывает строку для отображения в запросе, в котором пользователю указывается элемент для выбора. Длина ограничена 200 символами. Если аргумент promptText не передан, отображается сообщение "Сделайте выбор".

promptText?: string

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

string

sampleData

Предупреждение

Теперь этот API является нерекомендуемым.

Microsoft Access is no longer supported.

Указывает таблицу образцов данных, отображаемую в пользовательском интерфейсе командной строки в качестве примера типов полей (столбцов), которые могут быть связаны вашей надстройкой. Заголовки в объекте TableData указывают метки, используемые в пользовательском интерфейсе выбора поля.

Примечание. Этот параметр используется только в надстройках для Access. Он игнорируется, если он указан при вызове метода в надстройке для Excel.

sampleData?: Office.TableData

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

Office.TableData