Compartilhar via


Office.CoercionType enum

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 = "html"

Retorna ou define dados como HTML.

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

Image = "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 = "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 a dados no Excel e Word.

Ooxml = "ooxml"

Retorna ou define dados como Office Open XML.

Nota: aplica-se apenas aos dados no Word.

SlideRange = "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.getSelectedDataAsync para obter o diapositivo atual ou o intervalo de diapositivos selecionado.

Table = "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 a dados no Excel e Word.

Text = "text"

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

XmlSvg = "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.