Excel.DataValidation class

現在の範囲に適用されるデータの入力規則を表します。Represents the data validation applied to the current range. データ検証オブジェクトモデルの詳細については、「 Excel 範囲へのデータ検証の追加」を参照してください。To learn more about the data validation object model, read Add data validation to Excel ranges.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

Extends

プロパティ

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

errorAlert

無効なデータが入力された場合のエラー警告。Error alert when user enters invalid data.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

ignoreBlanks

空白を無視します。つまり、空白のセルではデータの入力規則が検証されません。既定では true に設定されます。Ignore blanks: no data validation will be performed on blank cells, it defaults to true.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

prompt

ユーザーがセルを選択したときにメッセージを表示します。Prompt when users select a cell.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

rule

さまざまな種類のデータ検証条件を含むデータ入力規則。Data validation rule that contains different type of data validation criteria.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

type

データの入力規則の種類。詳細については、Excel.DataValidationType を参照してください。Type of the data validation, see Excel.DataValidationType for details.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

valid

すべてのセルの値がデータの入力規則に従っているかどうかを表します。Represents if all cell values are valid according to the data validation rules. すべてのセルの値が有効な場合は true、すべてのセルの値が無効な場合は false を返します。Returns true if all cell values are valid, or false if all cell values are invalid. 範囲内に有効で無効なセル値がある場合は、null を返します。Returns null if there are both valid and invalid cell values within the range.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

メソッド

clear()

現在の範囲からデータの入力規則をクリアします。Clears the data validation from the current range.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

getInvalidCells()

1 つまたは複数の長方形範囲で構成され、無効なセル値を含む RangeAreas を返します。Returns a RangeAreas, comprising one or more rectangular ranges, with invalid cell values. すべてのセル値が有効な場合、この関数からは ItemNotFound エラーがスローされます。If all cell values are valid, this function will throw an ItemNotFound error.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getInvalidCellsOrNullObject()

1 つまたは複数の長方形範囲で構成され、無効なセル値を含む RangeAreas を返します。Returns a RangeAreas, comprising one or more rectangular ranges, with invalid cell values. すべてのセル値が有効な場合、この関数からは null が返されます。If all cell values are valid, this function will return null.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

load(propertyNamesAndPaths)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

set(properties, options)

一度に1つのオブジェクトの複数のプロパティを設定します。Sets multiple properties of an object at the same time. 適切なプロパティを持つプレーンオブジェクト、または同じ種類の別の API オブジェクトのいずれかを渡すことができます。You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを設定します。Sets multiple properties on the object at the same time, based on an existing loaded object.

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元の DataValidation オブジェクトは API オブジェクトであるのに対し、 toJSONメソッドはプレーンな JavaScript オブジェクトを返します (型はExcel.Interfaces.DataValidationData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.DataValidation object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.DataValidationData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

プロパティの詳細

context

オブジェクトに関連付けられている要求コンテキスト。The request context associated with the object. これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。This connects the add-in's process to the Office host application's process.

context: RequestContext;

プロパティ値

RequestContext

errorAlert

無効なデータが入力された場合のエラー警告。Error alert when user enters invalid data.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

errorAlert: Excel.DataValidationErrorAlert;

プロパティ値

Examples

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

空白を無視します。つまり、空白のセルではデータの入力規則が検証されません。既定では true に設定されます。Ignore blanks: no data validation will be performed on blank cells, it defaults to true.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

ignoreBlanks: boolean;

プロパティ値

boolean

prompt

ユーザーがセルを選択したときにメッセージを表示します。Prompt when users select a cell.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

prompt: Excel.DataValidationPrompt;

プロパティ値

Examples

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

さまざまな種類のデータ検証条件を含むデータ入力規則。Data validation rule that contains different type of data validation criteria.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

rule: Excel.DataValidationRule;

プロパティ値

Examples

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

データの入力規則の種類。詳細については、Excel.DataValidationType を参照してください。Type of the data validation, see Excel.DataValidationType for details.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

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

プロパティ値

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

valid

すべてのセルの値がデータの入力規則に従っているかどうかを表します。Represents if all cell values are valid according to the data validation rules. すべてのセルの値が有効な場合は true、すべてのセルの値が無効な場合は false を返します。Returns true if all cell values are valid, or false if all cell values are invalid. 範囲内に有効で無効なセル値がある場合は、null を返します。Returns null if there are both valid and invalid cell values within the range.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

readonly valid: boolean;

プロパティ値

boolean

メソッドの詳細

clear()

現在の範囲からデータの入力規則をクリアします。Clears the data validation from the current range.

[API セット: excelapi 1.8][ API set: ExcelApi 1.8 ]

clear(): void;

戻り値

void

getInvalidCells()

1 つまたは複数の長方形範囲で構成され、無効なセル値を含む RangeAreas を返します。Returns a RangeAreas, comprising one or more rectangular ranges, with invalid cell values. すべてのセル値が有効な場合、この関数からは ItemNotFound エラーがスローされます。If all cell values are valid, this function will throw an ItemNotFound error.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getInvalidCells(): Excel.RangeAreas;

戻り値

getInvalidCellsOrNullObject()

1 つまたは複数の長方形範囲で構成され、無効なセル値を含む RangeAreas を返します。Returns a RangeAreas, comprising one or more rectangular ranges, with invalid cell values. すべてのセル値が有効な場合、この関数からは null が返されます。If all cell values are valid, this function will return null.

[API セット: excelapi 1.9][ API set: ExcelApi 1.9 ]

getInvalidCellsOrNullObject(): Excel.RangeAreas;

戻り値

load(option)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るには先に "context.sync()" を呼び出す必要があります。You must call "context.sync()" before reading the properties.

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

パラメーター

戻り値

注釈

このシグネチャに加えて、このメソッドのシグネチャは次のとおりです。In addition to this signature, this method has the following signatures:

load(option?: string | string[]): Excel.DataValidation-Where オプションは、読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列です。load(option?: string | string[]): Excel.DataValidation - Where option is a comma-delimited string or an array of strings that specify the properties to load.

load(option?: { select?: string; expand?: string; }): Excel.DataValidation-Where オプションを指定します。 select は、読み込むプロパティを指定するコンマで区切られた文字列で、オプション expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。load(option?: { select?: string; expand?: string; }): Excel.DataValidation - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.DataValidation-コレクション型でのみ使用できます。load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.DataValidation - Only available on collection types. これは、前述の署名に似ています。It is similar to the preceding signature. Top は、結果に含めることができるコレクション項目の最大数を指定します。Option.top specifies the maximum number of collection items that can be included in the result. 省略すると、スキップされ、結果に含まれないアイテムの数を指定します。Option.skip specifies the number of items that are to be skipped and not included in the result. Option を指定すると、指定した数のアイテムをスキップした後に結果セットが開始されます。If option.top is specified, the result set will start after skipping the specified number of items.

load(propertyNames)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

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

パラメーター

propertyNames
string | string[]

読み込むプロパティを指定する、コンマで区切られた文字列または文字列の配列。A comma-delimited string or an array of strings that specify the properties to load.

戻り値

load(propertyNamesAndPaths)

オブジェクトの指定のプロパティを読み込むコマンドを待ち行列に入れます。Queues up a command to load the specified properties of the object. プロパティを読み取るcontext.sync()前に、を呼び出す必要があります。You must call context.sync() before reading the properties.

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

パラメーター

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

ここで、は、読み込むプロパティを指定するコンマで区切られた文字列を指定します。 expand は、読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。Where propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

戻り値

set(properties, options)

一度に1つのオブジェクトの複数のプロパティを設定します。Sets multiple properties of an object at the same time. 適切なプロパティを持つプレーンオブジェクト、または同じ種類の別の API オブジェクトのいずれかを渡すことができます。You can pass either a plain object with the appropriate properties, or another API object of the same type.

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

パラメーター

properties
Interfaces.DataValidationUpdateData

メソッドが呼び出されるオブジェクトのプロパティに構造化 isomorphically されているプロパティを持つ JavaScript オブジェクト。A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options
OfficeExtension.UpdateOptions

プロパティオブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。Provides an option to suppress errors if the properties object tries to set any read-only properties.

戻り値

void

注釈

このメソッドには、次の追加のシグネチャがあります。This method has the following additional signature:

set(properties: Excel.DataValidation): void

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを設定します。Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.DataValidation): void;

パラメーター

戻り値

void

toJSON()

API オブジェクトがtoJSON()渡されるときに、より有用な出力を提供するために、JavaScript メソッドをオーバーライドします。JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringifyその後、渡されたtoJSONオブジェクトのメソッドを呼び出します。元の DataValidation オブジェクトは API オブジェクトであるのに対し、 toJSONメソッドはプレーンな JavaScript オブジェクトを返します (型はExcel.Interfaces.DataValidationData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.DataValidation object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.DataValidationData) は、元のオブジェクトから読み込まれた子プロパティの浅いコピーを格納します。) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.DataValidationData;

戻り値