Office.CoercionType enum

  • Referência
Pacote:
office

Especifica como forçar dados retornados ou definidos pelo método invocado.

Comentários

O suporte de aplicações e plataformas para cada CoercionType um é especificado nas seguintes descrições do conjunto de requisitos.

Exemplos

// 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}".`);
        }
    });
}

Campos

Html

Retorna ou define dados como HTML.

Nota: aplica-se apenas a dados em suplementos para suplementos do Word e do Outlook para o Outlook (modo de composição).
Image

Os dados são retornados ou definidos como um fluxo de imagem. Nota: aplica-se apenas a dados no Excel, Word e PowerPoint.
Matrix

Retornar ou definir dados como dados tabulares sem nenhum cabeçalho. Os dados são retornados ou definidos como uma matriz de matrizes contendo execuções de caracteres unidimensionais. Por exemplo, três linhas de valores de cadeia em duas colunas seriam: [["R1C1", "R1C2"], ["R2C1", "R2C2"], ["R3C1", "R3C2"]].

Nota: aplica-se apenas aos dados no Excel e no Word.
Ooxml

Retorna ou define dados como Office Open XML.

Nota: aplica-se apenas a dados no Word.
SlideRange

Devolver um objeto JSON que contém uma matriz de IDs, títulos e índices dos diapositivos selecionados. Por exemplo, {"slides":[{"id":257,"title":"Slide 2","index":2},{"id":256,"title":"Slide 1","index":1}]} para uma seleção de dois diapositivos.

Nota: aplica-se apenas aos dados no PowerPoint ao chamar o método Document.getSelectedData para obter o diapositivo atual ou o intervalo de diapositivos selecionado.
Table

Retorna ou define dados como dados tabulares com cabeçalhos opcionais. Os dados são retornados ou definidos como uma matriz de matrizes com cabeçalhos opcionais.

Nota: aplica-se apenas aos dados no Excel e no Word.
Text

Devolver ou definir dados como texto (cadeia). Os dados são devolvidos ou definidos como uma execução unidimensional de carateres.
XmlSvg

Os dados são devolvidos ou definidos como dados XML que contêm uma imagem SVG. Nota: aplica-se apenas a dados no Excel, Word e PowerPoint.