Freigeben über

Office.GetSelectedDataOptions interface

Paket:
office

Bietet Optionen zum Anpassen, welche Daten zurückgegeben und wie sie formatiert werden.

Hinweise

Beispiele

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

Eigenschaften

asyncContext

Ein benutzerdefiniertes Element eines beliebigen Typs, das unverändert in der asyncContext-Eigenschaft des AsyncResult-Objekts zurückgegeben wird, das an einen Rückruf übergeben wird.
filterType

Geben Sie an, ob nur die sichtbaren (d. h. gefilterten) Daten oder alle Daten abgerufen werden sollen. Nützlich beim Filtern von Daten. Verwenden Sie Office.FilterType oder eine Zeichenfolgenäquivalente. Dieser Parameter wird in Word-Dokumenten ignoriert.
valueFormat

Geben Sie an, ob die Daten formatiert sind. Verwenden Sie Office.ValueFormat oder eine Zeichenfolgenentsprechung.

Details zur Eigenschaft

asyncContext

Ein benutzerdefiniertes Element eines beliebigen Typs, das unverändert in der asyncContext-Eigenschaft des AsyncResult-Objekts zurückgegeben wird, das an einen Rückruf übergeben wird.

asyncContext?: any

Eigenschaftswert

any

filterType

Geben Sie an, ob nur die sichtbaren (d. h. gefilterten) Daten oder alle Daten abgerufen werden sollen. Nützlich beim Filtern von Daten. Verwenden Sie Office.FilterType oder eine Zeichenfolgenäquivalente. Dieser Parameter wird in Word-Dokumenten ignoriert.

filterType?: Office.FilterType | string

Eigenschaftswert

Office.FilterType | string

valueFormat

Geben Sie an, ob die Daten formatiert sind. Verwenden Sie Office.ValueFormat oder eine Zeichenfolgenentsprechung.

valueFormat?: Office.ValueFormat | string

Eigenschaftswert

Office.ValueFormat | string