Excel.DataValidation class

Stellt die Datenüberprüfung dar, die auf den aktuellen Bereich angewendet wird. Weitere Informationen zum Datenüberprüfungsobjektmodell finden Sie unter Hinzufügen der Datenüberprüfung zu Excel-Bereichen.

Extends

Hinweise

[ API-Satz: ExcelApi 1.8 ]

Eigenschaften

context

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

errorAlert

Fehlermeldung, wenn Benutzer ungültige Daten eingibt.

ignoreBlanks

Gibt an, ob die Datenüberprüfung für leere Zellen ausgeführt wird. Der Standardwert ist true.

prompt

Aufforderung, wenn Benutzer eine Zelle auswählen.

rule

Datenüberprüfungsregel, die verschiedene Arten von Datenüberprüfungskriterien enthält.

type

Weitere Informationen finden Sie unter Excel.DataValidationType Typ der Datenüberprüfung.

valid

Gibt an, ob alle Zellwerte entsprechend den Datenüberprüfungsregeln gültig sind. Gibt zurück true , wenn alle Zellwerte gültig sind oder false wenn alle Zellwerte ungültig sind. Gibt zurück null , wenn innerhalb des Bereichs sowohl gültige als auch ungültige Zellwerte vorhanden sind.

Methoden

clear()

Löscht die Datenüberprüfung aus dem aktuellen Bereich.

getInvalidCells()

Gibt ein RangeAreas Objekt zurück, das einen oder mehrere rechteckige Bereiche mit ungültigen Zellwerten umfasst. Wenn alle Zellwerte gültig sind, löst diese Funktion einen Fehler aus ItemNotFound .

getInvalidCellsOrNullObject()

Gibt ein RangeAreas Objekt zurück, das einen oder mehrere rechteckige Bereiche mit ungültigen Zellwerten umfasst. Wenn alle Zellwerte gültig sind, gibt diese Funktion zurück null.

load(options)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNames)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNamesAndPaths)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

set(properties, options)

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.

set(properties)

Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

toJSON()

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Excel.DataValidation Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.DataValidationData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

Details zur Eigenschaft

context

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

errorAlert

Fehlermeldung, wenn Benutzer ungültige Daten eingibt.

errorAlert: Excel.DataValidationErrorAlert;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.8 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/22-data-validation/data-validation.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Decision");
    const commentsRange = 
        sheet.tables.getItem("NameOptionsTable").columns.getItem("Comments").getDataBodyRange();

    // When you are developing, it is a good practice to
    // clear the dataValidation object with each run of your code.
    commentsRange.dataValidation.clear();   

    // If the value of A2 is contained in the value of C2, then 
    // SEARCH(A2,C2) returns the number where it begins. Otherwise,
    // it does not return a number.
    let redundantStringRule = {
        custom: {
            formula: "=NOT(ISNUMBER(SEARCH(A2,C2)))"
        }
    };
    commentsRange.dataValidation.rule = redundantStringRule;
    commentsRange.dataValidation.errorAlert = {
        message: "It is redundant to include the baby name in the comment.",
        showAlert: true,
        style: "Information",
        title: "Baby Name in Comment"
    };

    await context.sync();
});

ignoreBlanks

Gibt an, ob die Datenüberprüfung für leere Zellen ausgeführt wird. Der Standardwert ist true.

ignoreBlanks: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.8 ]

prompt

Aufforderung, wenn Benutzer eine Zelle auswählen.

prompt: Excel.DataValidationPrompt;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.8 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/22-data-validation/data-validation.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Decision");
    const rankingRange = sheet.tables.getItem("NameOptionsTable").columns.getItem("Ranking").getDataBodyRange();

    // When you are developing, it is a good practice to
    // clear the dataValidation object with each run of your code.
    rankingRange.dataValidation.clear();

    let greaterThanZeroRule = {
        wholeNumber: {
            formula1: 0,
            operator: Excel.DataValidationOperator.greaterThan
        }
    };
    rankingRange.dataValidation.rule = greaterThanZeroRule;

    rankingRange.dataValidation.prompt = {
        message: "Please enter a positive number.",
        showPrompt: true,
        title: "Positive numbers only."
    };

    rankingRange.dataValidation.errorAlert = {
        message: "Sorry, only positive numbers are allowed",
        showAlert: true,
        style: "Stop",
        title: "Negative Number Entered"
    };

    await context.sync();
});

rule

Datenüberprüfungsregel, die verschiedene Arten von Datenüberprüfungskriterien enthält.

rule: Excel.DataValidationRule;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.8 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/22-data-validation/data-validation.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Decision");
    const nameRange = 
        sheet.tables.getItem("NameOptionsTable").columns.getItem("Baby Name").getDataBodyRange();

    // When you are developing, it is a good practice to
    // clear the dataValidation object with each run of your code.
    nameRange.dataValidation.clear();

    const nameSourceRange = context.workbook.worksheets.getItem("Names").getRange("A1:A3");

    let approvedListRule = {
        list: {
            inCellDropDown: true,
            source: nameSourceRange
        }
    };
    nameRange.dataValidation.rule = approvedListRule;

    await context.sync();
});

type

Weitere Informationen finden Sie unter Excel.DataValidationType Typ der Datenüberprüfung.

readonly type: Excel.DataValidationType | "None" | "WholeNumber" | "Decimal" | "List" | "Date" | "Time" | "TextLength" | "Custom" | "Inconsistent" | "MixedCriteria";

Eigenschaftswert

Excel.DataValidationType | "None" | "WholeNumber" | "Decimal" | "List" | "Date" | "Time" | "TextLength" | "Custom" | "Inconsistent" | "MixedCriteria"

Hinweise

[ API-Satz: ExcelApi 1.8 ]

valid

Gibt an, ob alle Zellwerte entsprechend den Datenüberprüfungsregeln gültig sind. Gibt zurück true , wenn alle Zellwerte gültig sind oder false wenn alle Zellwerte ungültig sind. Gibt zurück null , wenn innerhalb des Bereichs sowohl gültige als auch ungültige Zellwerte vorhanden sind.

readonly valid: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.8 ]

Details zur Methode

clear()

Löscht die Datenüberprüfung aus dem aktuellen Bereich.

clear(): void;

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.8 ]

getInvalidCells()

Gibt ein RangeAreas Objekt zurück, das einen oder mehrere rechteckige Bereiche mit ungültigen Zellwerten umfasst. Wenn alle Zellwerte gültig sind, löst diese Funktion einen Fehler aus ItemNotFound .

getInvalidCells(): Excel.RangeAreas;

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.9 ]

getInvalidCellsOrNullObject()

Gibt ein RangeAreas Objekt zurück, das einen oder mehrere rechteckige Bereiche mit ungültigen Zellwerten umfasst. Wenn alle Zellwerte gültig sind, gibt diese Funktion zurück null.

getInvalidCellsOrNullObject(): Excel.RangeAreas;

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.9 ]

load(options)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(options?: Excel.Interfaces.DataValidationLoadOptions): Excel.DataValidation;

Parameter

options
Excel.Interfaces.DataValidationLoadOptions

Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

Gibt zurück

load(propertyNames)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNames?: string | string[]): Excel.DataValidation;

Parameter

propertyNames

string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

load(propertyNamesAndPaths)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.DataValidation;

Parameter

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

set(properties, options)

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.

set(properties: Interfaces.DataValidationUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameter

properties
Excel.Interfaces.DataValidationUpdateData

Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.

options
OfficeExtension.UpdateOptions

Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt versucht, schreibgeschützte Eigenschaften festzulegen.

Gibt zurück

void

set(properties)

Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: Excel.DataValidation): void;

Parameter

Gibt zurück

void

toJSON()

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Excel.DataValidation Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.DataValidationData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Excel.Interfaces.DataValidationData;

Gibt zurück