ig.excel.CustomDataValidationRule
依存関係
-
ig.excel.CustomDataValidationRule
コンストラクター- new $.ig.excel.CustomDataValidationRule( );
新しい CustomDataValidationRule インスタンスを作成します。
-
getFormula
- .getFormula( address:string );
- 返却型:
- string
- 返却型の説明:
- セルに適用される値を検証するために使用する数式。
セルに適用された値を検証するために使用する数式を取得します。
- address
- タイプ:string
- 相対参照の基準となるセルまたは領域のアドレスか、ワークシートの左上のセルを使用する場合は null。
例外
例外 説明 ig.ArgumentException アドレスが有効なセル アドレスまたは領域アドレスでない場合に発生します。 備考
数式の評価結果が False、0、ErrorValue (#VALUE! など)、または「True」(大文字と小文字は区別しません) 以外の文字列の場合、値が無効であることを示します。 True、「True」(大文字と小文字は区別しません)、null、およびゼロ以外の数値は、有効な値が適用されたことを示します。
渡されたアドレスは、数式中で相対アドレスを使用する場合にのみ必要です。たとえば、適用された数式が =B1 で、データの入力規則ルールが領域 A1:A5 に適用されるとします。A1 の数式を取得すると、数式 =B1 が返されます。A2 の数式を取得すると、=B2 が返されます。同様に、セル A5 では =B5 が返されます。 ただし、数式に参照が含まれていないかすべてが絶対参照の場合、アドレスは無視されます。そのため、上の例で、元の数式が =$B$1 の場合、指定したアドレスにかかわらず同じ数式が返されます。
アドレスは、ワークシート上の任意の有効なセルまたは領域参照です。領域アドレスが指定された場合、左上のセルまたは領域が使用されます。指定されたセルまたは領域には、データの入力規則ルールが適用されている必要はありません。 すべての参照が許可されます。
データの入力規則ルールがブック内のワークシートに適用されていない限り、アドレスを解析するセル参照モードは A1 であると仮定されます。データの入力規則ルールがブック内のワークシートに適用されている場合は、Workbook.cellReferenceMode が使用されます。
-
getFormula
- .getFormula( 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 列挙体で定義されていない場合に発生します。 備考
数式の評価結果が False、0、ErrorValue (#VALUE! など)、または「True」(大文字と小文字は区別しません) 以外の文字列の場合、値が無効であることを示します。 True、「True」(大文字と小文字は区別しません)、null、およびゼロ以外の数値は、有効な値が適用されたことを示します。
渡されたアドレスは、数式中で相対アドレスを使用する場合にのみ必要です。たとえば、適用された数式が =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
- 比較対象のルール。
-
setFormula
- .setFormula( formula:string, address:string );
セルに適用される値を検証するために使用する数式を設定します。
- formula
- タイプ:string
- ルールに使用する検証式。
- address
- タイプ:string
- 相対参照の基準となるセルまたは領域のアドレスか、ワークシートの左上のセルを使用する場合は null。
例外
例外 説明 ig.ArgumentNullException formula が null でルールが現在 Worksheet に適用されている場合に発生します。 ig.excel.FormulaParseException 数式が有効な数式でない場合に発生します。 ig.ArgumentException アドレスが有効なセル アドレスまたは領域アドレスでない場合に発生します。 備考
数式の評価結果が False、0、ErrorValue (#VALUE! など)、または「True」(大文字と小文字は区別しません) 以外の文字列の場合、値が無効であることを示します。 True、「True」(大文字と小文字は区別しません)、null、およびゼロ以外の数値は、有効な値が適用されたことを示します。
渡されたアドレスは、数式中で相対アドレスを使用する場合にのみ必要です。データの入力規則ルールがセルまたは領域に適用されている場合、各個別のセルで使用されている数式内の参照は、渡されたアドレスに対するセルのオフセットによってシフトされます。たとえば、指定された式が =B1 で指定されたアドレスが A1 の場合を考えます。データの入力規則ルールが A5 セルに適用されている場合、使用される数式は =B5 になります。ただし、数式中の参照が =$B$1 のように絶対参照の場合、指定したアドレスにかかわらず同じ数式が適用されます。
アドレスは、ワークシート上の任意の有効なセルまたは領域参照です。領域アドレスが指定された場合、左上のセルまたは領域が使用されます。指定されたセルまたは領域には、データの入力規則ルールが適用されている必要はありません。 すべての参照が許可されます。
データの入力規則ルールがブック内のワークシートに適用されていない限り、アドレスを解析するセル参照モードは A1 であると仮定されます。データの入力規則ルールがブック内のワークシートに適用されている場合は、Workbook.cellReferenceMode が使用されます。
-
setFormula
- .setFormula( formula:string, address:string, format:ig.excel.WorkbookFormat, cellReferenceMode:ig.excel.CellReferenceMode, culture:string );
セルに適用される値を検証するために使用する数式を設定します。
- formula
- タイプ:string
- ルールに使用する検証式。
- address
- タイプ:string
- 相対参照の基準となるセルまたは領域のアドレスか、ワークシートの左上のセルを使用する場合は null。
- format
- タイプ:ig.excel.WorkbookFormat
- アドレスを解析するために使用するワークブック形式。
- cellReferenceMode
- タイプ:ig.excel.CellReferenceMode
- アドレスを解析するために使用するセル参照モード。
- culture
- タイプ:string
- 数式文字列を解析するときに使用するカルチャー。
例外
例外 説明 ig.ArgumentNullException formula が null でルールが現在 Worksheet に適用されている場合に発生します。 ig.excel.FormulaParseException 数式が有効な数式でない場合に発生します。 ig.ArgumentException アドレスが有効なセル アドレスまたは領域アドレスでない場合に発生します。 ig.excel.InvalidEnumArgumentException format が WorkbookFormat 列挙体で定義されていない場合に発生します。 ig.excel.InvalidEnumArgumentException format が WorkbookFormat 列挙体で定義されていない場合に発生します。 備考
数式の評価結果が False、0、ErrorValue (#VALUE! など)、または「True」(大文字と小文字は区別しません) 以外の文字列の場合、値が無効であることを示します。 True、「True」(大文字と小文字は区別しません)、null、およびゼロ以外の数値は、有効な値が適用されたことを示します。
渡されたアドレスは、数式中で相対アドレスを使用する場合にのみ必要です。データの入力規則ルールがセルまたは領域に適用されている場合、各個別のセルで使用されている数式内の参照は、渡されたアドレスに対するセルのオフセットによってシフトされます。たとえば、指定された式が =B1 で指定されたアドレスが A1 の場合を考えます。データの入力規則ルールが A5 セルに適用されている場合、使用される数式は =B5 になります。ただし、数式中の参照が =$B$1 のように絶対参照の場合、指定したアドレスにかかわらず同じ数式が適用されます。
アドレスは、ワークシート上の任意の有効なセルまたは領域参照です。領域アドレスが指定された場合、左上のセルまたは領域が使用されます。指定されたセルまたは領域には、データの入力規則ルールが適用されている必要はありません。 すべての参照が許可されます。
データの入力規則ルールがブック内のワークシートに適用されていない限り、アドレスを解析するセル参照モードは A1 であると仮定されます。データの入力規則ルールがブック内のワークシートに適用されている場合は、Workbook.cellReferenceMode が使用されます。