Office.CoercionType enum

Пакет:
office

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

Комментарии

Поддержка приложений и платформ для каждого из них CoercionType описана в следующих описаниях наборов требований.

  • HtmlCoercion, (при использовании Office.CoercionType.Html)

  • ImageCoercion 1.1 (при использовании Office.CoercionType.Image)

  • MatrixCoercion (при использовании Office.CoercionType.Matrix)

  • OoxmlCoercion (при использовании Office.CoercionType.Ooxml)

  • Selection

  • TableCoercion (при использовании Office.CoercionType.Table)

  • TextCoercion (при использовании Office.CoercionType.Text)

  • ImageCoercion 1.2 (при использовании Office.CoercionType.XmlSvg)

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

Примеры

// This function displays the currently selected text in the console.
// It uses the Common APIs.
function run() {
    Office.context.document.getSelectedDataAsync(Office.CoercionType.Text, (asyncResult) => {
        if (asyncResult.status === Office.AsyncResultStatus.Failed) {
            console.error(asyncResult.error.message);
        } else {
            console.log(`The selected data is "${asyncResult.value}".`);
        }
    });
}

Поля

Html = "html"

Возвращает или задает данные в формате HTML.

Примечание. Применяется только к данным в надстройках для Word и Outlook для Outlook (в режиме создания).
Image = "image"

Данные возвращаются или задаются как поток образа. Примечание. Применяется только к данным в Excel, Word и PowerPoint.
Matrix = "matrix"

Возвращает или задает данные в табличном формате без заголовков. Данные возвращаются или задаются как массив массивов с одномерными последовательностями символов. Например, три строки строковых значений в двух столбцах будут выглядеть так: [["R1C1", "R1C2"], ["R2C1", "R2C2"], ["R3C1", "R3C2"]].

Примечание. Относится только к данным в Excel и Word.
Ooxml = "ooxml"

Возвращает или задает данные в формате Office Open XML.

Примечание. Относится только к данным в Word.
SlideRange = "slideRange"

Возврат объекта JSON, содержащего массив идентификаторов, заголовков и индексов выбранных слайдов. Например, {"slides":[{"id":257,"title":"Slide 2","index":2},{"id":256,"title":"Slide 1","index":1}]} для выбора двух слайдов.

Примечание. Применяется к данным в PowerPoint только при вызове метода Document.getSelectedDataAsync для получения текущего слайда или выделенного диапазона слайдов.
Table = "table"

Возвращает или задает данные в табличном формате с необязательными заголовками. Данные возвращаются или задаются в качестве массива массивов с необязательными заголовками.

Примечание. Относится только к данным в Excel и Word.
Text = "text"

Возвращение или задание данных в виде текста (строки). Данные возвращаются или задаются в виде одномерной последовательности символов.
XmlSvg = "xmlSvg"

Данные возвращаются или устанавливаются как данные XML, содержащие изображение SVG. Примечание. Применяется только к данным в Excel, Word и PowerPoint.