Office.GetSelectedDataOptions interface

Paquete:
office

Proporciona opciones para personalizar los datos que se devuelven y cómo se les da formato.

Comentarios

Usada por

Ejemplos

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

Propiedades

asyncContext

Un elemento definido por el usuario de cualquier tipo que se devuelve, sin cambios, en la propiedad asyncContext del objeto AsyncResult que se pasa a una devolución de llamada.
filterType

Especifique si desea obtener solo los datos visibles (es decir, filtrados) o todos los datos. Es útil al filtrar datos. Use Office.FilterType o el equivalente de cadena. Este parámetro se ignora en los documentos de Word.
valueFormat

Especifique si los datos tienen formato. Use Office.ValueFormat o el equivalente de cadena.

Detalles de las propiedades

asyncContext

Un elemento definido por el usuario de cualquier tipo que se devuelve, sin cambios, en la propiedad asyncContext del objeto AsyncResult que se pasa a una devolución de llamada.

asyncContext?: any

Valor de propiedad

any

filterType

Especifique si desea obtener solo los datos visibles (es decir, filtrados) o todos los datos. Es útil al filtrar datos. Use Office.FilterType o el equivalente de cadena. Este parámetro se ignora en los documentos de Word.

filterType?: Office.FilterType | string

Valor de propiedad

Office.FilterType | string

valueFormat

Especifique si los datos tienen formato. Use Office.ValueFormat o el equivalente de cadena.

valueFormat?: Office.ValueFormat | string

Valor de propiedad

Office.ValueFormat | string