Compartilhar via

Office.GetSelectedDataOptions interface

Pacote:
office

Fornece opções para personalizar que dados são devolvidos e como são formatados.

Comentários

Exemplos

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

Propriedades

asyncContext

Um item definido pelo utilizador de qualquer tipo que seja devolvido, inalterado, na propriedade asyncContext do objeto AsyncResult que é transmitido a uma chamada de retorno.
filterType

Especifique se pretende obter apenas os dados visíveis (ou seja, filtrados) ou todos os dados. Útil ao filtrar dados. Utilize Office.FilterType ou equivalente de cadeia. Esse parâmetro é ignorado em documentos do Word.
valueFormat

Especifique se os dados estão formatados. Utilize Office.ValueFormat ou equivalente de cadeia.

Detalhes da propriedade

asyncContext

Um item definido pelo utilizador de qualquer tipo que seja devolvido, inalterado, na propriedade asyncContext do objeto AsyncResult que é transmitido a uma chamada de retorno.

asyncContext?: any

Valor da propriedade

any

filterType

Especifique se pretende obter apenas os dados visíveis (ou seja, filtrados) ou todos os dados. Útil ao filtrar dados. Utilize Office.FilterType ou equivalente de cadeia. Esse parâmetro é ignorado em documentos do Word.

filterType?: Office.FilterType | string

Valor da propriedade

Office.FilterType | string

valueFormat

Especifique se os dados estão formatados. Utilize Office.ValueFormat ou equivalente de cadeia.

valueFormat?: Office.ValueFormat | string

Valor da propriedade

Office.ValueFormat | string