Ignite UI™ API ヘルプ

ig.excel.OneConstraintDataValidationRule
コンストラクター

new $.ig.excel.OneConstraintDataValidationRule( );

新しい OneConstraintDataValidationRule インスタンスを作成します。

ig.excel.OneConstraintDataValidationRule
コンストラクター

new $.ig.excel.OneConstraintDataValidationRule( validationOperator:ig.excel.OneConstraintDataValidationOperator, validationCriteria:ig.excel.DataValidationCriteria );

新しい OneConstraintDataValidationRule インスタンスを作成します。

validationOperator
タイプ:ig.excel.OneConstraintDataValidationOperator
セル値を制約値と比較するときに使用する演算子。
validationCriteria
タイプ:ig.excel.DataValidationCriteria
セル値を検証するときに使用する条件。

例外

例外	説明
ig.excel.InvalidEnumArgumentException	validationCriteria が DataValidationCriteria 列挙体のメンバーでない場合に発生します。

getConstraintFormula

.getConstraintFormula( address:string );
返却型:: string
返却型の説明:: セルに適用される値を検証するために使用する数式。

セル値を検証するために使用する制約数式を取得します。

address
タイプ:string
相対参照の基準となるセルまたは領域のアドレスか、ワークシートの左上のセルを使用する場合は null。

例外

例外	説明
ig.ArgumentException	アドレスが有効なセルアドレスまたは領域アドレスでない場合に発生します。

備考

セル値を制約数式の値と比較する方法は、OneConstraintDataValidationRule.validationOperator および ValueConstraintDataValidationRule.validationCriteria で決定されます。

ルールの ValidationCriteria に応じて、セル値自体またはセル値に相当するテキストの長さが制約数式の値と比較されます。

渡されたアドレスは、数式中で相対アドレスを使用する場合にのみ必要です。たとえば、適用された数式が =B1 で、データの入力規則ルールが領域 A1:A5 に適用されるとします。A1 の数式を取得すると、数式 =B1 が返されます。A2 の数式を取得すると、=B2 が返されます。同様に、セル A5 では =B5 が返されます。ただし、数式に参照が含まれていないかすべてが絶対参照の場合、アドレスは無視されます。そのため、上の例で、元の数式が =$B$1 の場合、指定したアドレスにかかわらず同じ数式が返されます。

アドレスは、ワークシート上の任意の有効なセルまたは領域参照です。領域アドレスが指定された場合、左上のセルまたは領域が使用されます。指定されたセルまたは領域には、データの入力規則ルールが適用されている必要はありません。すべての参照が許可されます。

データの入力規則ルールがブック内のワークシートに適用されていない限り、アドレスを解析するセル参照モードは A1 であると仮定されます。データの入力規則ルールがブック内のワークシートに適用されている場合は、Workbook.cellReferenceMode が使用されます。

getConstraintFormula

.getConstraintFormula( address:string, format:ig.excel.WorkbookFormat, cellReferenceMode:ig.excel.CellReferenceMode, culture:string );
返却型:: string
返却型の説明:: セルに適用される値を検証するために使用する数式。

セル値を検証するために使用する制約数式を取得します。

address
タイプ:string
相対参照の基準となるセルまたは領域のアドレスか、ワークシートの左上のセルを使用する場合は null。
format
タイプ:ig.excel.WorkbookFormat
アドレスを解析するために使用するワークブック形式。
cellReferenceMode
タイプ:ig.excel.CellReferenceMode
アドレスを解析するために使用するセル参照モード。
culture
タイプ:string
数式文字列を生成するときに使用するカルチャー。

例外

例外	説明
ig.ArgumentException	アドレスが有効なセルアドレスまたは領域アドレスでない場合に発生します。
ig.excel.InvalidEnumArgumentException	format が WorkbookFormat 列挙体で定義されていない場合に発生します。
ig.excel.InvalidEnumArgumentException	format が WorkbookFormat 列挙体で定義されていない場合に発生します。

備考

セル値を制約数式の値と比較する方法は、OneConstraintDataValidationRule.validationOperator および ValueConstraintDataValidationRule.validationCriteria で決定されます。

ルールの ValidationCriteria に応じて、セル値自体またはセル値に相当するテキストの長さが制約数式の値と比較されます。

渡されたアドレスは、数式中で相対アドレスを使用する場合にのみ必要です。たとえば、適用された数式が =B1 で、データの入力規則ルールが領域 A1:A5 に適用されるとします。A1 の数式を取得すると、数式 =B1 が返されます。A2 の数式を取得すると、=B2 が返されます。同様に、セル A5 では =B5 が返されます。ただし、数式に参照が含まれていないかすべてが絶対参照の場合、アドレスは無視されます。そのため、上の例で、元の数式が =$B$1 の場合、指定したアドレスにかかわらず同じ数式が返されます。

アドレスは、ワークシート上の任意の有効なセルまたは領域参照です。領域アドレスが指定された場合、左上のセルまたは領域が使用されます。指定されたセルまたは領域には、データの入力規則ルールが適用されている必要はありません。すべての参照が許可されます。

データの入力規則ルールがブック内のワークシートに適用されていない限り、アドレスを解析するセル参照モードは A1 であると仮定されます。データの入力規則ルールがブック内のワークシートに適用されている場合は、Workbook.cellReferenceMode が使用されます。

isEquivalentTo

.isEquivalentTo( other:ig.excel.DataValidationRule );
返却型:: boolean
返却型の説明:: 指定したその他のルールがこのルールと同じ設定を持つ場合、true を返します。

このルールがその他のルールと構造的に等しいかどうかを示します。

other
タイプ:ig.excel.DataValidationRule
比較対象のルール。

setConstraint

.setConstraint( value:ig.Date );

セル値を検証するために使用する制約値を設定します。

value
タイプ:ig.Date
セル値に対して比較するために使用する制約値。

例外

例外	説明
ig.ArgumentException	value を Excel で日付として表現できない場合に発生します。

備考

セル値を制約の値と比較する方法は、OneConstraintDataValidationRule.validationOperator および ValueConstraintDataValidationRule.validationCriteria で決定されます。

ルールの ValidationCriteria に応じて、セル値自体またはセル値に相当するテキストの長さが制約値と比較されます。

このオーバーロードは、ValidationCriteria が Date の場合に優先されます。ValidationCriteria が WholeNumber、Decimal、Time、または TextLength の場合は OneConstraintDataValidationRule.setConstraint オーバーロードが優先されます。

setConstraint

.setConstraint( value:number );

セル値を検証するために使用する制約値を設定します。

value
タイプ:number
セル値に対して比較するために使用する制約値。

備考

セル値を制約の値と比較する方法は、OneConstraintDataValidationRule.validationOperator および ValueConstraintDataValidationRule.validationCriteria で決定されます。

ルールの ValidationCriteria に応じて、セル値自体またはセル値に相当するテキストの長さが制約値と比較されます。

このオーバーロードは、ValidationCriteria が Date の場合に優先されます。ValidationCriteria が WholeNumber、Decimal、Time、または TextLength の場合は OneConstraintDataValidationRule.setConstraint オーバーロードが優先されます。

setConstraintFormula

.setConstraintFormula( constraintFormula:string, address:string );

セル値を検証するために使用する制約数式を設定します。

constraintFormula
タイプ:string
ルールに使用する検証式。
address
タイプ:string
相対参照の基準となるセルまたは領域のアドレスか、ワークシートの左上のセルを使用する場合は null。

例外

例外	説明
ig.ArgumentNullException	constraintFormula が null でルールが現在 Worksheet に適用されている場合に発生します。
ig.excel.FormulaParseException	constraintFormula が有効な数式でない場合に発生します。
ig.ArgumentException	アドレスが有効なセルアドレスまたは領域アドレスでない場合に発生します。

備考

セル値を制約数式の値と比較する方法は、OneConstraintDataValidationRule.validationOperator および ValueConstraintDataValidationRule.validationCriteria で決定されます。

ルールの ValidationCriteria に応じて、セル値自体またはセル値に相当するテキストの長さが制約数式の値と比較されます。

渡されたアドレスは、数式中で相対アドレスを使用する場合にのみ必要です。データの入力規則ルールがセルまたは領域に適用されている場合、各個別のセルで使用されている数式内の参照は、渡されたアドレスに対するセルのオフセットによってシフトされます。たとえば、指定された式が =B1 で指定されたアドレスが A1 の場合を考えます。データの入力規則ルールが A5 セルに適用されている場合、使用される数式は =B5 になります。ただし、数式中の参照が =$B$1 のように絶対参照の場合、指定したアドレスにかかわらず同じ数式が適用されます。

アドレスは、ワークシート上の任意の有効なセルまたは領域参照です。領域アドレスが指定された場合、左上のセルまたは領域が使用されます。指定されたセルまたは領域には、データの入力規則ルールが適用されている必要はありません。すべての参照が許可されます。

データの入力規則ルールがブック内のワークシートに適用されていない限り、アドレスを解析するセル参照モードは A1 であると仮定されます。データの入力規則ルールがブック内のワークシートに適用されている場合は、Workbook.cellReferenceMode が使用されます。

setConstraintFormula

.setConstraintFormula( constraintFormula:string, address:string, format:ig.excel.WorkbookFormat, cellReferenceMode:ig.excel.CellReferenceMode, culture:string );

セル値を検証するために使用する制約数式を設定します。

constraintFormula
タイプ:string
ルールに使用する検証式。
address
タイプ:string
相対参照の基準となるセルまたは領域のアドレスか、ワークシートの左上のセルを使用する場合は null。
format
タイプ:ig.excel.WorkbookFormat
アドレスを解析するために使用するワークブック形式。
cellReferenceMode
タイプ:ig.excel.CellReferenceMode
アドレスを解析するために使用するセル参照モード。
culture
タイプ:string
数式文字列を解析するときに使用するカルチャー。

例外

例外	説明
ig.ArgumentNullException	constraintFormula が null でルールが現在 Worksheet に適用されている場合に発生します。
ig.excel.FormulaParseException	constraintFormula が有効な数式でない場合に発生します。
ig.ArgumentException	アドレスが有効なセルアドレスまたは領域アドレスでない場合に発生します。
ig.excel.InvalidEnumArgumentException	format が WorkbookFormat 列挙体で定義されていない場合に発生します。
ig.excel.InvalidEnumArgumentException	format が WorkbookFormat 列挙体で定義されていない場合に発生します。

備考

セル値を制約数式の値と比較する方法は、OneConstraintDataValidationRule.validationOperator および ValueConstraintDataValidationRule.validationCriteria で決定されます。

ルールの ValidationCriteria に応じて、セル値自体またはセル値に相当するテキストの長さが制約数式の値と比較されます。

渡されたアドレスは、数式中で相対アドレスを使用する場合にのみ必要です。データの入力規則ルールがセルまたは領域に適用されている場合、各個別のセルで使用されている数式内の参照は、渡されたアドレスに対するセルのオフセットによってシフトされます。たとえば、指定された式が =B1 で指定されたアドレスが A1 の場合を考えます。データの入力規則ルールが A5 セルに適用されている場合、使用される数式は =B5 になります。ただし、数式中の参照が =$B$1 のように絶対参照の場合、指定したアドレスにかかわらず同じ数式が適用されます。

アドレスは、ワークシート上の任意の有効なセルまたは領域参照です。領域アドレスが指定された場合、左上のセルまたは領域が使用されます。指定されたセルまたは領域には、データの入力規則ルールが適用されている必要はありません。すべての参照が許可されます。

データの入力規則ルールがブック内のワークシートに適用されていない限り、アドレスを解析するセル参照モードは A1 であると仮定されます。データの入力規則ルールがブック内のワークシートに適用されている場合は、Workbook.cellReferenceMode が使用されます。

validationOperator

.validationOperator( );

セル値を制約値または数式に対して比較するときに使用する検証演算子を取得します。

例外

例外	説明
ig.excel.InvalidEnumArgumentException	値が OneConstraintDataValidationOperator 列挙体のメンバーでない場合に発生します。

備考

ルールの ValueConstraintDataValidationRule.validationCriteria に応じて、セル値自体またはセル値に相当するテキストの長さが制約値または数式と比較されます。

validationOperator

.validationOperator( value:ig.excel.OneConstraintDataValidationOperator );

セル値を制約値または数式に対して比較するときに使用する検証演算子を取得します。

value
タイプ:ig.excel.OneConstraintDataValidationOperator

例外

例外	説明
ig.excel.InvalidEnumArgumentException	値が OneConstraintDataValidationOperator 列挙体のメンバーでない場合に発生します。

備考

ルールの ValueConstraintDataValidationRule.validationCriteria に応じて、セル値自体またはセル値に相当するテキストの長さが制約値または数式と比較されます。

Ignite UI | サンプル

ig.excel.OneConstraintDataValidationRule

依存関係

ig.excel.OneConstraintDataValidationRule
コンストラクター

ig.excel.OneConstraintDataValidationRule
コンストラクター

例外

getConstraintFormula

例外

備考

関連項目

getConstraintFormula

例外

備考

関連項目

isEquivalentTo

setConstraint

例外

備考

関連項目

setConstraint

備考

関連項目

setConstraintFormula

例外

備考

関連項目

setConstraintFormula

例外

備考

関連項目

validationOperator

例外

備考

関連項目

validationOperator

例外

備考

関連項目

Ignite UI | サンプル

ig.excel.OneConstraintDataValidationRule

依存関係

ig.excel.OneConstraintDataValidationRuleコンストラクター

ig.excel.OneConstraintDataValidationRuleコンストラクター

例外

getConstraintFormula

例外

備考

関連項目

getConstraintFormula

例外

備考

関連項目

isEquivalentTo

setConstraint

例外

備考

関連項目

setConstraint

備考

関連項目

setConstraintFormula

例外

備考

関連項目

setConstraintFormula

例外

備考

関連項目

validationOperator

例外

備考

関連項目

validationOperator

例外

備考

関連項目

ig.excel.OneConstraintDataValidationRule
コンストラクター

ig.excel.OneConstraintDataValidationRule
コンストラクター