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