Office.GetSelectedDataOptions interface

Пакет:

office

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

Комментарии

Примеры

/* Set the selection options. These will:
 - Pass the string "myContext" to the callback.
 - Include both visible and hidden data.
 - Return the formatted values of the selection 
     (for an Excel date, 1/1/2023 instead of 44928).
 */  
const options: Office.GetSelectedDataOptions = {
    asyncContext: "myContext",
    filterType: Office.FilterType.All,
    valueFormat: Office.ValueFormat.Formatted
}

// Get the selected data in the Office document as text.
Office.context.document.getSelectedDataAsync(
    Office.CoercionType.Text,
    options,
    (asyncResult) => {
        if (asyncResult.status === Office.AsyncResultStatus.Failed) {
            console.error(`${asyncResult.asyncContext}: asyncResult.error.message`);
        } else {
            console.log(`The selected data is "${asyncResult.value}".`);
        }
});

Свойства

asyncContext	Определяемый пользователем элемент любого типа, возвращаемый без изменений в свойстве asyncContext объекта AsyncResult, который передается обратному вызову.
filterType	Укажите, следует ли получать только видимые (то есть отфильтрованные) данные или все данные. Полезно при фильтрации данных. Используйте Office.FilterType или эквивалент строки. Этот параметр игнорируется в документах Word.
valueFormat	Укажите, являются ли данные отформатированными. Используйте Office.ValueFormat или эквивалент строки.

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

asyncContext

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

asyncContext?: any

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

any

filterType

Укажите, следует ли получать только видимые (то есть отфильтрованные) данные или все данные. Полезно при фильтрации данных. Используйте Office.FilterType или эквивалент строки. Этот параметр игнорируется в документах Word.

filterType?: Office.FilterType | string

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

Office.FilterType | string

valueFormat

Укажите, являются ли данные отформатированными. Используйте Office.ValueFormat или эквивалент строки.

valueFormat?: Office.ValueFormat | string

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

Office.ValueFormat | string