クラス: DefaultDataValidator

Sheets.DataValidation.DefaultDataValidator

Table of contents

コンストラクタ

• constructor

メソッド

• comparisonOperator
• condition
• errorMessage
• errorStyle
• errorTitle
• getValidList
• highlightStyle
• ignoreBlank
• inCellDropdown
• inputMessage
• inputTitle
• isValid
• preciseCompareDate
• reset
• showErrorMessage
• showInputMessage
• type
• value1
• value2

コンストラクタ

constructor

• new DefaultDataValidator(condition?)

データバリデーターを表します。

実例

// 次のサンプルコードは、セルのデータを検証します。
spread.options.highlightInvalidData = true;
var dv = GC.Spread.Sheets.DataValidation.createTextLengthValidator(GC.Spread.Sheets.ConditionalFormatting.ComparisonOperators.greaterThan, 5);
activeSheet.setDataValidator(0, 0, 1, 1, dv, GC.Spread.Sheets.SheetArea.viewport);
activeSheet.setValue(0, 0, "abcf");

パラメータ

名前	型
condition?	Condition

メソッド

comparisonOperator

▸ comparisonOperator(value?): any

比較演算子を取得または設定します。

パラメータ

名前	型
value?	ComparisonOperators

戻り値

any

値が設定されていない場合は、比較演算子を返します。値が設定されている場合は、データバリデーターを返します。

---

condition

▸ condition(value?): any

検証する条件を取得または設定します。

パラメータ

名前	型
value?	Condition

戻り値

any

値が設定されていない場合は、検証する条件を返します。値が設定されている場合は、データバリデーターを返します。

---

errorMessage

▸ errorMessage(value?): any

エラーメッセージを取得または設定します。

パラメータ

名前	型
value?	string

戻り値

any

値が設定されていない場合は、エラーメッセージを返します。値が設定されている場合は、データバリデーターを返します。

---

errorStyle

▸ errorStyle(value?): any

表示するエラースタイルを取得または設定します。

パラメータ

名前	型
value?	ErrorStyle

戻り値

any

値が設定されていない場合は、表示するエラースタイルを返します。値が設定されている場合は、データバリデーターを返します。

---

errorTitle

▸ errorTitle(value?): any

エラータイトルを取得または設定します。

パラメータ

名前	型
value?	string

戻り値

any

値が設定されていない場合は、エラータイトルを返します。値が設定されている場合は、データバリデーターを返します。

---

getValidList

▸ getValidList(evaluator, baseRow, baseColumn): any[]

データ検証タイプがリストの場合は有効なデータリストを返し、それ以外の場合はnullを返します。

パラメータ

名前	型	説明
evaluator	Object	条件を評価できるオブジェクト。
baseRow	number	基本行。
baseColumn	number	基本列。

戻り値

any[]

有効なデータリストまたはnull。

---

highlightStyle

▸ highlightStyle(style?): any

無効なデータセルの協調表示スタイルを設定または参照します。

実例

// 次のサンプルコードは、highlightStyleメソッドを使用します。
sheet.setValue(1, 1, "sss");
var dv = GC.Spread.Sheets.DataValidation.createListValidator('Fruit,Vegetable,Food');
dv.highlightStyle({
   type:GC.Spread.Sheets.DataValidation.HighlightType.dogEar,
   color:'blue',
   position:GC.Spread.Sheets.DataValidation.HighlightPosition.topLeft
});
sheet.setDataValidator(1,1, dv);
spread.options.highlightInvalidData = true;

パラメータ

名前	型
style?	IHighLightStyle

戻り値

any

値が設定されていない場合、強調表示のスタイルオブジェクトを返します。 値が設定されている場合は、データ検証ツールを返します。

---

ignoreBlank

▸ ignoreBlank(value?): any

空の値を無視するかどうかを取得または設定します。

実例

// 次のサンプルコードは、IgnoreBlankメソッドを使用します。
var nCondition = new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.cellValueCondition);
nCondition.compareType(GC.Spread.Sheets.ConditionalFormatting.GeneralComparisonOperators.equalsTo);
nCondition.expected(0);
// 次のオプションがfalseの場合、検証は失敗し、赤のアラートが表示されます。
// 次のオプションがtrueの場合、空白セルはゼロとして扱われ、検証は成功します。
nCondition.treatNullValueAsZero(false);
var validator = new GC.Spread.Sheets.DataValidation.DefaultDataValidator(nCondition);
validator.type(GC.Spread.Sheets.DataValidation.CriteriaType.custom);
validator.ignoreBlank(false);
activeSheet.getCell(0, 0, GC.Spread.Sheets.SheetArea.viewport).validator(validator);
spread.options.highlightInvalidData = true;
activeSheet.setValue(0, 0, null);

パラメータ

名前	型
value?	boolean

戻り値

any

値が設定されていない場合は、空の値を無視するかどうかを返します。値が設定されている場合は、データバリデーターを返します。

---

inCellDropdown

▸ inCellDropdown(value?): any

ドロップダウンボタンを表示するかどうかを取得または設定します。

実例

// 次のサンプルコードは、inCellDropdownメソッドを使用します。
spread.options.highlightInvalidData = true;
var dv = GC.Spread.Sheets.DataValidation.createListValidator("1,2,3");
dv.showInputMessage(true);
dv.inputMessage("Value must be 1,2 or 3");
dv.inputTitle("tip");
dv.inCellDropdown(true);
activeSheet.setDataValidator(1,1,1,1,dv,GC.Spread.Sheets.SheetArea.viewport);
var validList = activeSheet.getDataValidator(1, 1).getValidList(activeSheet, 1, 1);
alert(validList);

パラメータ

名前	型
value?	boolean

戻り値

any

値が設定されていない場合は、ドロップダウンボタンを表示するかどうかを返します。値が設定されている場合は、データバリデーターを返します。

---

inputMessage

▸ inputMessage(value?): any

入力メッセージを取得または設定します。

実例

spread.options.highlightInvalidData = true;
var dv = GC.Spread.Sheets.DataValidation.createListValidator("1,2,3");
dv.showInputMessage(true);
dv.inputMessage("Value must be 1,2 or 3");
dv.inputTitle("tip");
activeSheet.setDataValidator(1,1,1,1,dv,GC.Spread.Sheets.SheetArea.viewport);
alert(activeSheet.getDataValidator(1,1).getValidList(activeSheet,1,1));

パラメータ

名前	型
value?	string

戻り値

any

値が設定されていない場合は、入力メッセージを返します。値が設定されている場合は、データバリデーターを返します。

---

inputTitle

▸ inputTitle(value?): any

入力タイトルを取得または設定します。

実例

spread.options.highlightInvalidData = true;
var dv = GC.Spread.Sheets.DataValidation.createListValidator("1,2,3");
dv.showInputMessage(true);
dv.inputMessage("Value must be 1,2 or 3");
dv.inputTitle("tip");
activeSheet.setDataValidator(1,1,1,1,dv,GC.Spread.Sheets.SheetArea.viewport);
alert(activeSheet.getDataValidator(1,1).getValidList(activeSheet,1,1));

パラメータ

名前	型
value?	string

戻り値

any

値が設定されていない場合は、入力タイトルを返します。値が設定されている場合は、データバリデーターを返します。

---

isValid

▸ isValid(evaluator, baseRow, baseColumn, actual): boolean

現在の値が有効かどうかを判断します。

実例

sheet.setArray(0, 0,
    [
        [ 3.4 ],
        [ 102.8 ]
    ]);
var expression1 = 1.1;
var expression2 = 101.2;
var dv = GC.Spread.Sheets.DataValidation.createNumberValidator(GC.Spread.Sheets.ConditionalFormatting.ComparisonOperators.between, expression1, expression2, false);
sheet.getCell(0, 0, GC.Spread.Sheets.SheetArea.viewport).validator(dv);
dv = sheet.getCell(0, 0, GC.Spread.Sheets.SheetArea.viewport).validator(); // SDM の制限により、スタイルに設定すると dv がコピーされます。
console.log(dv.isValid(sheet, 0, 0, 3)); // true
console.log(dv.isValid(sheet, 0, 0, 1)); // false
console.log(dv.isValid(sheet, 0, 0, 101)); // true
console.log(dv.isValid(sheet, 0, 0, 0)); // false
console.log(dv.isValid(sheet, 0, 0, 120.0)); // false

パラメータ

名前	型	説明
evaluator	Object	エバリュエーター。
baseRow	number	基本行。
baseColumn	number	基本列。
actual	Object	現在の値。

戻り値

boolean

値が有効な場合はtrue、それ以外の場合はfalse。

---

preciseCompareDate

▸ preciseCompareDate(value?): any

1日を比較するか、特定の日時を比較するかを取得または設定します。

実例

// 次のサンプルコードは、preciseCompareDateメソッドを使用します。
var dateCondition = new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.dateCondition);
dateCondition.compareType(GC.Spread.Sheets.ConditionalFormatting.DateCompareType.after);
dateCondition.expected(new Date(2020, 4, 22, 6));
// 次のオプションがfalseの場合、バリデーターは1日を比較し、それらは同じであるため、検証は失敗し、赤いアラートが表示されます。
// 次のオプションがtrueの場合、7時の日時が6時よりも大きいため、結果は成功します。
var validator = new GC.Spread.Sheets.DataValidation.DefaultDataValidator(dateCondition);
validator.type(GC.Spread.Sheets.DataValidation.CriteriaType.date);
validator.preciseCompareDate(true);
activeSheet.getCell(0, 0, GC.Spread.Sheets.SheetArea.viewport).validator(validator);
spread.options.highlightInvalidData = true;
activeSheet.setValue(0, 0, new Date(2020, 4, 22, 7));

パラメータ

名前	型
value?	boolean

戻り値

any

値が設定されていない場合は、1日または特定の日時の比較を返します。 それ以外の場合は、データバリデーターを返します。

---

reset

▸ reset(): void

データバリデーターをリセットします。

実例

// 次のサンプルコードは、resetメソッドを使用します。
var nCondition = new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.cellValueCondition);
nCondition.compareType(GC.Spread.Sheets.ConditionalFormatting.GeneralComparisonOperators.equalsTo);
nCondition.expected(0);
// 次のオプションがfalseの場合、検証は失敗し、赤のアラートが表示されます。
// 次のオプションがtrueの場合、空白セルはゼロとして扱われ、検証は成功します。
nCondition.treatNullValueAsZero(false);
var validator = new GC.Spread.Sheets.DataValidation.DefaultDataValidator(nCondition);
validator.type(GC.Spread.Sheets.DataValidation.CriteriaType.custom);
validator.ignoreBlank(false);
activeSheet.getCell(0, 0, GC.Spread.Sheets.SheetArea.viewport).validator(validator);
spread.options.highlightInvalidData = true;
activeSheet.setValue(0, 0, null);
validator.reset();

戻り値

void

---

showErrorMessage

▸ showErrorMessage(value?): any

エラーメッセージを表示するかどうかを取得または設定します。

実例

spread.options.highlightInvalidData = true;
// この数式バリデーターは、数式条件がtrueを返す場合、有効になります。
var dv = GC.Spread.Sheets.DataValidation.createFormulaValidator("A1>0");
dv.showInputMessage(true);
dv.inputMessage("Enter a value greater than 0 in A1.");
dv.inputTitle("Tip");
dv.showErrorMessage(true);
dv.errorMessage("Incorrect Value");
activeSheet.setDataValidator(0, 0, 1, 1, dv, GC.Spread.Sheets.SheetArea.viewport);
// 連結
activeSheet.bind(GC.Spread.Sheets.Events.ValidationError, function (sender, args) {
    if (args.validator.showErrorMessage()) {
        if (confirm(args.validator.errorMessage())) {
            args.validationResult = GC.Spread.Sheets.DataValidation.DataValidationResult.retry;
        } else {
            args.validationResult = GC.Spread.Sheets.DataValidation.DataValidationResult.forceApply;
        }
    }
});

パラメータ

名前	型
value?	boolean

戻り値

any

値が設定されていない場合は、エラーメッセージを表示するかどうかを返します。値が設定されている場合は、データバリデーターを返します。

---

showInputMessage

▸ showInputMessage(value?): any

入力タイトルと入力メッセージを表示するかどうかを取得または設定します。

実例

spread.options.highlightInvalidData = true;
var dv = GC.Spread.Sheets.DataValidation.createListValidator("1,2,3");
dv.showInputMessage(true);
dv.inputMessage("Value must be 1,2 or 3");
dv.inputTitle("tip");
activeSheet.setDataValidator(1,1,1,1,dv,GC.Spread.Sheets.SheetArea.viewport);
alert(activeSheet.getDataValidator(1,1).getValidList(activeSheet,1,1));

パラメータ

名前	型
value?	boolean

戻り値

any

値が設定されていない場合は、入力タイトルと入力メッセージを表示するかどうかを返します。値が設定されている場合は、データバリデーターを返します。

---

type

▸ type(value?): any

このデータバリデーターの基準タイプを取得または設定します。

パラメータ

名前	型
value?	CriteriaType

戻り値

any

値が設定されていない場合は、このデータバリデーターの基準タイプを返します。値が設定されている場合は、データバリデーターを返します。

---

value1

▸ value1(baseRow?, baseColumn?): any

データ検証の最初の値を取得します。

実例

// 次のサンプルコードは、セルの値を検証します。
var nCondition = new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.cellValueCondition);
nCondition.compareType(GC.Spread.Sheets.ConditionalFormatting.GeneralComparisonOperators.equalsTo);
nCondition.expected(0);
// 次のオプションがfalseの場合、検証は失敗し、赤のアラートが表示されます。
// 次のオプションがtrueの場合、空白セルはゼロとして扱われ、検証は成功します。
nCondition.treatNullValueAsZero(false);
var validator = new GC.Spread.Sheets.DataValidation.DefaultDataValidator(nCondition);
validator.type(GC.Spread.Sheets.DataValidation.CriteriaType.custom);
validator.ignoreBlank(false);
activeSheet.getCell(0, 0, GC.Spread.Sheets.SheetArea.viewport).validator(validator);
spread.options.highlightInvalidData = true;
activeSheet.setValue(0, 0, null);
alert(validator.value1());

パラメータ

名前	型
baseRow?	number
baseColumn?	number

戻り値

any

最初の値。

---

value2

▸ value2(baseRow?, baseColumn?): any

データ検証の2番目の値を取得します。

実例

// 次のサンプルコードは、セルの値を検証します。
var nCondition = new GC.Spread.Sheets.ConditionalFormatting.Condition(GC.Spread.Sheets.ConditionalFormatting.ConditionType.cellValueCondition);
nCondition.compareType(GC.Spread.Sheets.ConditionalFormatting.GeneralComparisonOperators.equalsTo);
nCondition.expected(0);
// 次のオプションがfalseの場合、検証は失敗し、赤のアラートが表示されます。
// 次のオプションがtrueの場合、空白セルはゼロとして扱われ、検証は成功します。
nCondition.treatNullValueAsZero(false);
var validator = new GC.Spread.Sheets.DataValidation.DefaultDataValidator(nCondition);
validator.type(GC.Spread.Sheets.DataValidation.CriteriaType.custom);
validator.ignoreBlank(false);
activeSheet.getCell(0, 0, GC.Spread.Sheets.SheetArea.viewport).validator(validator);
spread.options.highlightInvalidData = true;
activeSheet.setValue(0, 0, null);
alert(validator.value2());

パラメータ

名前	型
baseRow?	number
baseColumn?	number

戻り値

any

２番目の値。