ig.excel.ListDataValidationRule
依存関係
-
ig.excel.ListDataValidationRule
コンストラクター- new $.ig.excel.ListDataValidationRule( );
新しい ListDataValidationRule インスタンスを作成します。
-
allowNull
継承- .allowNull( );
- 返却型:
- boolean
- 返却型の説明:
- null 値をセルに設定できる場合は True、そうでない場合は False。
null または空白の値をセルに設定できるかどうかを示す値を取得します。
-
allowNull
継承- .allowNull( value:boolean );
- 返却型:
- boolean
- 返却型の説明:
- null 値をセルに設定できる場合は True、そうでない場合は False。
null または空白の値をセルに設定できるかどうかを示す値を取得します。
- value
- タイプ:boolean
-
clone
継承- .clone( );
他のワークシートに適用できるこのルールのコピーを作成します。
-
errorMessageDescription
継承- .errorMessageDescription( );
- 返却型:
- string
- 返却型の説明:
- ユーザーに表示する説明か、既定のエラー説明を使用する場合は null。
Microsoft Excel で無効な値がセルに適用された場合にダイアログ ボックスに表示される説明を取得します。
例外
例外 説明 ig.ArgumentException 指定した値が 225 文字よりも長い場合に発生します。 備考
この値は、DataValidationRule.showErrorMessageForInvalidValue が True の場合のみ使用されます。
注記: タイトルは最大文字数は 225 文字です。
-
errorMessageDescription
継承- .errorMessageDescription( value:string );
- 返却型:
- string
- 返却型の説明:
- ユーザーに表示する説明か、既定のエラー説明を使用する場合は null。
Microsoft Excel で無効な値がセルに適用された場合にダイアログ ボックスに表示される説明を取得します。
- value
- タイプ:string
例外
例外 説明 ig.ArgumentException 指定した値が 225 文字よりも長い場合に発生します。 備考
この値は、DataValidationRule.showErrorMessageForInvalidValue が True の場合のみ使用されます。
注記: タイトルは最大文字数は 225 文字です。
-
errorMessageTitle
継承- .errorMessageTitle( );
- 返却型:
- string
- 返却型の説明:
- ユーザーに表示するタイトルか、既定のエラー ダイアログ タイトルを使用する場合は null。
Microsoft Excel で無効な値がセルに適用された場合にダイアログ ボックスに表示されるタイトルを取得します。
例外
例外 説明 ig.ArgumentException 指定した値が 32 文字よりも長い場合に発生します。 備考
この値は、DataValidationRule.showErrorMessageForInvalidValue が True の場合のみ使用されます。
注記: タイトルは最大文字数は 32 文字です。
-
errorMessageTitle
継承- .errorMessageTitle( value:string );
- 返却型:
- string
- 返却型の説明:
- ユーザーに表示するタイトルか、既定のエラー ダイアログ タイトルを使用する場合は null。
Microsoft Excel で無効な値がセルに適用された場合にダイアログ ボックスに表示されるタイトルを取得します。
- value
- タイプ:string
例外
例外 説明 ig.ArgumentException 指定した値が 32 文字よりも長い場合に発生します。 備考
この値は、DataValidationRule.showErrorMessageForInvalidValue が True の場合のみ使用されます。
注記: タイトルは最大文字数は 32 文字です。
-
errorStyle
継承- .errorStyle( );
- 返却型:
- ig.excel.DataValidationErrorStyle
- 返却型の説明:
- DataValidationErrorStyle を返します。
値が無効な場合に値が許可されるかどうかと、Microsoft Excel で表示されるエラー ダイアログでユーザーに表示する選択肢を示すオプションが提供されているかを取得します。
例外
例外 説明 ig.excel.InvalidEnumArgumentException 値が DataValidationErrorStyle 列挙体のメンバーでない場合に発生します。 備考
この値は、DataValidationRule.showErrorMessageForInvalidValue が True の場合のみ使用されます。
-
errorStyle
継承- .errorStyle( value:ig.excel.DataValidationErrorStyle );
- 返却型:
- ig.excel.DataValidationErrorStyle
- 返却型の説明:
- DataValidationErrorStyle を返します。
値が無効な場合に値が許可されるかどうかと、Microsoft Excel で表示されるエラー ダイアログでユーザーに表示する選択肢を示すオプションが提供されているかを取得します。
- value
- タイプ:ig.excel.DataValidationErrorStyle
例外
例外 説明 ig.excel.InvalidEnumArgumentException 値が DataValidationErrorStyle 列挙体のメンバーでない場合に発生します。 備考
この値は、DataValidationRule.showErrorMessageForInvalidValue が True の場合のみ使用されます。
-
getValuesFormula
- .getValuesFormula( address:string );
- 返却型:
- string
- 返却型の説明:
- セルに適用される値を検証するために使用する数式。
指定可能な値を指定する数式を取得します。
- address
- タイプ:string
- 相対参照の基準となるセルまたは領域のアドレスか、ワークシートの左上のセルを使用する場合は null。
例外
例外 説明 ig.ArgumentException アドレスが有効なセル アドレスまたは領域アドレスでない場合に発生します。 備考
これは指定可能な値のリストが格納された文字列か、同じブック内の指定可能な値が格納されたセルまたは領域の参照です。
数式が文字列に等しい場合、=「A,B,C」のように、指定可能な値のリストです。いずれかの値に二重引用符 (") が含まれる場合、="A,""B"",C" のように、リスト中で二重引用符を繰り返します。これは、値 A、"B"、および C を許可します。現在のカルチャーの小数点記号がカンマ (,) でない限り、値の区切り文字はカンマです。現在のカルチャーの小数点記号がカンマである場合は、区切り文字はセミコロン (;) です。
数式が 1 つ以上の参照に等しい場合、同じブック内の 1 つのセルまたは領域の参照になります。和集合、論理積、範囲演算子は許可されません。数式は、=$A$1 または =Sheet2!$A$1:$A$5 のようになります。1 つのセルまたは領域を参照している場合、1 つのセルまたは領域に加えて、名前付き参照も使用できます。領域が指定された場合や、領域を参照する名前付き参照が指定された場合、領域は 1 つの行または列で構成されます。エラー値に等しい数式も返すことができますが、セルはいずれの値も受け入れず、ドロップ ダウンは空になるため、あまり有用ではありません。
渡されたアドレスは、数式中で相対アドレスを使用する場合にのみ必要です。たとえば、適用された数式が =B1 で、データの入力規則ルールが領域 A1:A5 に適用されるとします。A1 の数式を取得すると、数式 =B1 が返されます。A2 の数式を取得すると、=B2 が返されます。同様に、セル A5 では =B5 が返されます。 ただし、数式に参照が含まれていないかすべてが絶対参照の場合、アドレスは無視されます。そのため、上の例で、元の数式が =$B$1 の場合、指定したアドレスにかかわらず同じ数式が返されます。
アドレスは、ワークシート上の任意の有効なセルまたは領域参照です。領域アドレスが指定された場合、左上のセルまたは領域が使用されます。指定されたセルまたは領域には、データの入力規則ルールが適用されている必要はありません。 すべての参照が許可されます。
データの入力規則ルールがブック内のワークシートに適用されていない限り、アドレスを解析するセル参照モードは A1 であると仮定されます。データの入力規則ルールがブック内のワークシートに適用されている場合は、Workbook.cellReferenceMode が使用されます。
-
getValuesFormula
- .getValuesFormula( 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 列挙体で定義されていない場合に発生します。 備考
これは指定可能な値のリストが格納された文字列か、同じブック内の指定可能な値が格納されたセルまたは領域の参照です。
数式が文字列に等しい場合、=「A,B,C」のように、指定可能な値のリストです。いずれかの値に二重引用符 (") が含まれる場合、="A,""B"",C" のように、リスト中で二重引用符を繰り返します。これは、値 A、"B"、および C を許可します。現在のカルチャーの小数点記号がカンマ (,) でない限り、値の区切り文字はカンマです。現在のカルチャーの小数点記号がカンマである場合は、区切り文字はセミコロン (;) です。
数式が 1 つ以上の参照に等しい場合、同じブック内の 1 つのセルまたは領域の参照になります。和集合、論理積、範囲演算子は許可されません。数式は、=$A$1 または =Sheet2!$A$1:$A$5 のようになります。1 つのセルまたは領域を参照している場合、1 つのセルまたは領域に加えて、名前付き参照も使用できます。領域が指定された場合や、領域を参照する名前付き参照が指定された場合、領域は 1 つの行または列で構成されます。エラー値に等しい数式も返すことができますが、セルはいずれの値も受け入れず、ドロップ ダウンは空になるため、あまり有用ではありません。
渡されたアドレスは、数式中で相対アドレスを使用する場合にのみ必要です。たとえば、適用された数式が =B1 で、データの入力規則ルールが領域 A1:A5 に適用されるとします。A1 の数式を取得すると、数式 =B1 が返されます。A2 の数式を取得すると、=B2 が返されます。同様に、セル A5 では =B5 が返されます。 ただし、数式に参照が含まれていないかすべてが絶対参照の場合、アドレスは無視されます。そのため、上の例で、元の数式が =$B$1 の場合、指定したアドレスにかかわらず同じ数式が返されます。
アドレスは、ワークシート上の任意の有効なセルまたは領域参照です。領域アドレスが指定された場合、左上のセルまたは領域が使用されます。指定されたセルまたは領域には、データの入力規則ルールが適用されている必要はありません。 すべての参照が許可されます。
データの入力規則ルールがブック内のワークシートに適用されていない限り、アドレスを解析するセル参照モードは A1 であると仮定されます。データの入力規則ルールがブック内のワークシートに適用されている場合は、Workbook.cellReferenceMode が使用されます。
-
imeMode
継承- .imeMode( );
- 返却型:
- ig.excel.DataValidationImeMode
- 返却型の説明:
- 日本語の入力規則の説明を設定します。
日本語の入力規則の説明を取得します。
例外
例外 説明 ig.excel.InvalidEnumArgumentException 値が DataValidationImeMode 列挙体のメンバーでない場合に発生します。 -
imeMode
継承- .imeMode( value:ig.excel.DataValidationImeMode );
- 返却型:
- ig.excel.DataValidationImeMode
- 返却型の説明:
- 日本語の入力規則の説明を設定します。
日本語の入力規則の説明を取得します。
- value
- タイプ:ig.excel.DataValidationImeMode
例外
例外 説明 ig.excel.InvalidEnumArgumentException 値が DataValidationImeMode 列挙体のメンバーでない場合に発生します。 -
inputMessageDescription
継承- .inputMessageDescription( );
- 返却型:
- string
- 返却型の説明:
- ツールチップでユーザーに表示する説明。
ユーザーが Microsoft Excel でセルを選択したときに表示されるツールチップの説明を取得します。
例外
例外 説明 ig.ArgumentException 指定した値が 255 文字よりも長い場合に発生します。 -
inputMessageDescription
継承- .inputMessageDescription( value:string );
- 返却型:
- string
- 返却型の説明:
- ツールチップでユーザーに表示する説明。
ユーザーが Microsoft Excel でセルを選択したときに表示されるツールチップの説明を取得します。
- value
- タイプ:string
例外
例外 説明 ig.ArgumentException 指定した値が 255 文字よりも長い場合に発生します。 -
inputMessageTitle
継承- .inputMessageTitle( );
- 返却型:
- string
- 返却型の説明:
- ツールチップでユーザーに表示するタイトル。
ユーザーが Microsoft Excel でセルを選択したときに表示されるツールチップのタイトルを取得します。
例外
例外 説明 ig.ArgumentException 指定した値が 32 文字よりも長い場合に発生します。 -
inputMessageTitle
継承- .inputMessageTitle( value:string );
- 返却型:
- string
- 返却型の説明:
- ツールチップでユーザーに表示するタイトル。
ユーザーが Microsoft Excel でセルを選択したときに表示されるツールチップのタイトルを取得します。
- value
- タイプ:string
例外
例外 説明 ig.ArgumentException 指定した値が 32 文字よりも長い場合に発生します。 -
isEquivalentTo
- .isEquivalentTo( other:ig.excel.DataValidationRule );
- 返却型:
- boolean
- 返却型の説明:
- 指定したその他のルールがこのルールと同じ設定を持つ場合、true を返します。
このルールがその他のルールと構造的に等しいかどうかを示します。
- other
- タイプ:ig.excel.DataValidationRule
- 比較対象のルール。
-
setValues
- .setValues( values:object[] );
セルが受け付けることができる指定可能な値のリストを設定します。
- values
- タイプ:object[]
- 指定可能な値のリスト。
例外
例外 説明 ig.ArgumentNullException values が null でルールが現在 Worksheet に適用されている場合に発生します。 ig.ArgumentException values 配列が空の場合に発生します。 備考
LimitedValueDataValidationRule.allowNull が True の場合、指定可能な値のリストの他に、null 値が許可されます。
指定可能な値のリストを数式に変換するため、すべての値に対して ToString が呼び出されます。
注記: 指定可能な値の数式は、関数パラメーター セパレーターを使用して各値を分離し、1 つの文字列に連結することで作成されます。そのため、1、2、3 のリストに対しては数式 ="1,2,3" が作成されます。ただし、現在のカルチャーの小数点記号がカンマ (,) の場合、値を区切るために、代わりにセミコロンが使用されます。このため、値の ToString がこれらの区切り文字のいずれかを含む文字列を返す場合、値は 2 つ以上の指定可能な値に分割されます。
-
setValuesFormula
- .setValuesFormula( valuesFormula:string, address:string );
指定可能な値を指定する数式を設定します。
- valuesFormula
- タイプ:string
- ルールの指定可能な値を提供する数式。
- address
- タイプ:string
- 相対参照の基準となるセルまたは領域のアドレスか、ワークシートの左上のセルを使用する場合は null。
例外
例外 説明 ig.ArgumentNullException valuesFormula が null でルールが現在 Worksheet に適用されている場合に発生します。 ig.excel.FormulaParseException valuesFormula が有効な数式でない場合に発生します。 ig.ArgumentException 指定した値に文字または参照以外のものが含まれている場合に発生します。 ig.ArgumentException 指定した値に文字または参照以外のものが含まれている場合に発生します。 ig.ArgumentException 指定した値に文字または参照以外のものが含まれている場合に発生します。 備考
数式は指定可能な値のリストが格納された文字列か、同じブック内の指定可能な値が格納されたセルまたは領域の参照である必要があります。
文字列に等しい数式が指定された場合、文字列リテラルでなくてはならず、連結できません。たとえば、指定可能な数式は ="A,B,C" です。いずれかの値に二重引用符 (") が含まれる場合、="A,""B"",C" のように、リスト中で二重引用符を繰り返します。これは、値 A、"B"、および C を許可します。現在のカルチャーの小数点記号がカンマ (,) でない限り、値の区切り文字はカンマである必要があります。現在のカルチャーの小数点記号がカンマである場合は、区切り文字はセミコロン (;) である必要があります。
1 つ以上の参照に等しい数式が指定された場合、同じブック内の 1 つのセルまたは領域の参照である必要があります。 和集合、論理積、範囲演算子は許可されません。指定可能な数式は =$A$1 または =Sheet2!$A$1:$A$5 のようになります。1 つのセルまたは領域を参照している場合、1 つのセルまたは領域に加えて、名前付き参照も使用できます。領域が指定された場合や、領域を参照する名前付き参照が指定された場合、領域は 1 つの行または列で構成されている必要があります。エラー値に等しい数式も許可されますが、セルはいずれの値も受け入れず、ドロップ ダウンは空になるため、あまり有用ではありません。
渡されたアドレスは、数式中で相対アドレスを使用する場合にのみ必要です。データの入力規則ルールがセルまたは領域に適用されている場合、各個別のセルで使用されている数式内の参照は、渡されたアドレスに対するセルのオフセットによってシフトされます。たとえば、指定された式が =B1 で指定されたアドレスが A1 の場合を考えます。データの入力規則ルールが A5 セルに適用されている場合、使用される数式は =B5 になります。ただし、数式中の参照が =$B$1 のように絶対参照の場合、指定したアドレスにかかわらず同じ数式が適用されます。
アドレスは、ワークシート上の任意の有効なセルまたは領域参照です。領域アドレスが指定された場合、左上のセルまたは領域が使用されます。指定されたセルまたは領域には、データの入力規則ルールが適用されている必要はありません。 すべての参照が許可されます。
データの入力規則ルールがブック内のワークシートに適用されていない限り、アドレスを解析するセル参照モードは A1 であると仮定されます。データの入力規則ルールがブック内のワークシートに適用されている場合は、Workbook.cellReferenceMode が使用されます。
-
setValuesFormula
- .setValuesFormula( valuesFormula:string, address:string, format:ig.excel.WorkbookFormat, cellReferenceMode:ig.excel.CellReferenceMode, culture:string );
指定可能な値を指定する数式を設定します。
- valuesFormula
- タイプ:string
- ルールの指定可能な値を提供する数式。
- address
- タイプ:string
- 相対参照の基準となるセルまたは領域のアドレスか、ワークシートの左上のセルを使用する場合は null。
- format
- タイプ:ig.excel.WorkbookFormat
- アドレスを解析するために使用するワークブック形式。
- cellReferenceMode
- タイプ:ig.excel.CellReferenceMode
- アドレスを解析するために使用するセル参照モード。
- culture
- タイプ:string
- 数式文字列を解析するときに使用するカルチャー。
例外
例外 説明 ig.ArgumentNullException valuesFormula が null でルールが現在 Worksheet に適用されている場合に発生します。 ig.excel.FormulaParseException valuesFormula が有効な数式でない場合に発生します。 ig.ArgumentException 指定した値に文字または参照以外のものが含まれている場合に発生します。 ig.ArgumentException 指定した値に文字または参照以外のものが含まれている場合に発生します。 ig.ArgumentException 指定した値に文字または参照以外のものが含まれている場合に発生します。 ig.excel.InvalidEnumArgumentException format が WorkbookFormat 列挙体で定義されていない場合に発生します。 ig.excel.InvalidEnumArgumentException format が WorkbookFormat 列挙体で定義されていない場合に発生します。 備考
数式は指定可能な値のリストが格納された文字列か、同じブック内の指定可能な値が格納されたセルまたは領域の参照である必要があります。
文字列に等しい数式が指定された場合、文字列リテラルでなくてはならず、連結できません。たとえば、指定可能な数式は ="A,B,C" です。いずれかの値に二重引用符 (") が含まれる場合、="A,""B"",C" のように、リスト中で二重引用符を繰り返します。これは、値 A、"B"、および C を許可します。現在のカルチャーの小数点記号がカンマ (,) でない限り、値の区切り文字はカンマである必要があります。現在のカルチャーの小数点記号がカンマである場合は、区切り文字はセミコロン (;) である必要があります。
1 つ以上の参照に等しい数式が指定された場合、同じブック内の 1 つのセルまたは領域の参照である必要があります。 和集合、論理積、範囲演算子は許可されません。指定可能な数式は =$A$1 または =Sheet2!$A$1:$A$5 のようになります。1 つのセルまたは領域を参照している場合、1 つのセルまたは領域に加えて、名前付き参照も使用できます。領域が指定された場合や、領域を参照する名前付き参照が指定された場合、領域は 1 つの行または列で構成されている必要があります。エラー値に等しい数式も許可されますが、セルはいずれの値も受け入れず、ドロップ ダウンは空になるため、あまり有用ではありません。
渡されたアドレスは、数式中で相対アドレスを使用する場合にのみ必要です。データの入力規則ルールがセルまたは領域に適用されている場合、各個別のセルで使用されている数式内の参照は、渡されたアドレスに対するセルのオフセットによってシフトされます。たとえば、指定された式が =B1 で指定されたアドレスが A1 の場合を考えます。データの入力規則ルールが A5 セルに適用されている場合、使用される数式は =B5 になります。ただし、数式中の参照が =$B$1 のように絶対参照の場合、指定したアドレスにかかわらず同じ数式が適用されます。
アドレスは、ワークシート上の任意の有効なセルまたは領域参照です。領域アドレスが指定された場合、左上のセルまたは領域が使用されます。指定されたセルまたは領域には、データの入力規則ルールが適用されている必要はありません。 すべての参照が許可されます。
データの入力規則ルールがブック内のワークシートに適用されていない限り、アドレスを解析するセル参照モードは A1 であると仮定されます。データの入力規則ルールがブック内のワークシートに適用されている場合は、Workbook.cellReferenceMode が使用されます。
-
showDropdown
- .showDropdown( );
指定可能な値のリストが格納されたドロップ ダウンを Microsoft Excel で表示する必要があるかどうかを示す値を取得します。
備考
True の場合、セルを選択したときに、ドロップ ダウン矢印がセルの横に表示されます。ユーザーがドロップ ダウン矢印をクリックすると、ドロップ ダウンに指定可能な値のリストが表示されます。
-
showDropdown
- .showDropdown( value:boolean );
指定可能な値のリストが格納されたドロップ ダウンを Microsoft Excel で表示する必要があるかどうかを示す値を取得します。
- value
- タイプ:boolean
備考
True の場合、セルを選択したときに、ドロップ ダウン矢印がセルの横に表示されます。ユーザーがドロップ ダウン矢印をクリックすると、ドロップ ダウンに指定可能な値のリストが表示されます。
-
showErrorMessageForInvalidValue
継承- .showErrorMessageForInvalidValue( );
- 返却型:
- boolean
- 返却型の説明:
- 無効なセル データについてエラー ダイアログを表示する場合は True、それ以外の場合は False。
セルに無効なデータが入力されたときに Microsoft Excel でエラー ダイアログを表示するかどうかを示す値を取得します。
備考
値が False の場合、無効なデータをセルに入力できますが、後でユーザーが Microsoft Excel 無効な値を円で囲むことを選択した場合、セルが円で囲まれます。
-
showErrorMessageForInvalidValue
継承- .showErrorMessageForInvalidValue( value:boolean );
- 返却型:
- boolean
- 返却型の説明:
- 無効なセル データについてエラー ダイアログを表示する場合は True、それ以外の場合は False。
セルに無効なデータが入力されたときに Microsoft Excel でエラー ダイアログを表示するかどうかを示す値を取得します。
- value
- タイプ:boolean
備考
値が False の場合、無効なデータをセルに入力できますが、後でユーザーが Microsoft Excel 無効な値を円で囲むことを選択した場合、セルが円で囲まれます。
-
showInputMessage
継承- .showInputMessage( );
ユーザーが Microsoft Excel でセルを選択したときに、ユーザーに入力プロンプト ツールチップを表示するかどうかを示す値を取得します。
備考
入力 プロンプトは、この値が True で DataValidationRule.inputMessageDescription が null でない場合にのみ表示されます。
-
showInputMessage
継承- .showInputMessage( value:boolean );
ユーザーが Microsoft Excel でセルを選択したときに、ユーザーに入力プロンプト ツールチップを表示するかどうかを示す値を取得します。
- value
- タイプ:boolean
備考
入力 プロンプトは、この値が True で DataValidationRule.inputMessageDescription が null でない場合にのみ表示されます。