ig.excel.OneConstraintDataValidationRule

単一の制約値または数式に対してセルの値を検証するデータの入力規則ルールを表します。

依存関係

jquery-1.4.4.js
infragistics.util.js
infragistics.ext_core.js
infragistics.ext_collections.js
infragistics.ext_collectionsExtended.js
infragistics.ext_io.js
infragistics.ext_text.js
infragistics.documents.core_core.js
infragistics.ext_ui.js
このコントロールにオプションはありません。
このコントロールにイベントはありません。
  • 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 列挙体のメンバーでない場合に発生します。
  • 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 の場合のみ使用されます。

  • 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 が使用されます。

  • 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 文字よりも長い場合に発生します。

    備考

    この値は、DataValidationRule.showInputMessage が True の場合のみ使用されます。

    注記: 説明の最大文字数は 255 文字です。

  • inputMessageDescription
    継承

    .inputMessageDescription( value:string );
    返却型:
    string
    返却型の説明:
    ツールチップでユーザーに表示する説明。

    ユーザーが Microsoft Excel でセルを選択したときに表示されるツールチップの説明を取得します。

    • value
    • タイプ:string

    例外

    例外 説明
    ig.ArgumentException 指定した値が 255 文字よりも長い場合に発生します。

    備考

    この値は、DataValidationRule.showInputMessage が True の場合のみ使用されます。

    注記: 説明の最大文字数は 255 文字です。

  • inputMessageTitle
    継承

    .inputMessageTitle( );
    返却型:
    string
    返却型の説明:
    ツールチップでユーザーに表示するタイトル。

    ユーザーが Microsoft Excel でセルを選択したときに表示されるツールチップのタイトルを取得します。

    例外

    例外 説明
    ig.ArgumentException 指定した値が 32 文字よりも長い場合に発生します。

    備考

    この値は、DataValidationRule.showInputMessage が True の場合のみ使用されます。

    注記: タイトルは最大文字数は 32 文字です。

  • inputMessageTitle
    継承

    .inputMessageTitle( value:string );
    返却型:
    string
    返却型の説明:
    ツールチップでユーザーに表示するタイトル。

    ユーザーが Microsoft Excel でセルを選択したときに表示されるツールチップのタイトルを取得します。

    • value
    • タイプ:string

    例外

    例外 説明
    ig.ArgumentException 指定した値が 32 文字よりも長い場合に発生します。

    備考

    この値は、DataValidationRule.showInputMessage が True の場合のみ使用されます。

    注記: タイトルは最大文字数は 32 文字です。

  • 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 が使用されます。

  • 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 でない場合にのみ表示されます。

  • validationCriteria
    継承

    .validationCriteria( );
    返却型:
    ig.excel.DataValidationCriteria
    返却型の説明:
    DataValidationCriteria を返します。

    セル値を制約に対して検証するときに使用する条件を取得します。

    例外

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

    備考

    指定した値に応じて、セル値またはそれに相当するテキストの長さが制約に対して比較されます。また、特定の ValidationCriteria 値は、制約と比較するときに、セル値が有効であっても拒否することがあります。たとえば、ValidationCriteria.WholeNumber 値は、小数部分がある数値を許可しません。

  • validationCriteria
    継承

    .validationCriteria( value:ig.excel.DataValidationCriteria );
    返却型:
    ig.excel.DataValidationCriteria
    返却型の説明:
    DataValidationCriteria を返します。

    セル値を制約に対して検証するときに使用する条件を取得します。

    • value
    • タイプ:ig.excel.DataValidationCriteria

    例外

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

    備考

    指定した値に応じて、セル値またはそれに相当するテキストの長さが制約に対して比較されます。また、特定の ValidationCriteria 値は、制約と比較するときに、セル値が有効であっても拒否することがあります。たとえば、ValidationCriteria.WholeNumber 値は、小数部分がある数値を許可しません。

  • validationOperator

    .validationOperator( );
    返却型:
    ig.excel.OneConstraintDataValidationOperator
    返却型の説明:
    OneConstraintDataValidationOperator を返します。

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

    例外

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

    備考

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

  • validationOperator

    .validationOperator( value:ig.excel.OneConstraintDataValidationOperator );
    返却型:
    ig.excel.OneConstraintDataValidationOperator
    返却型の説明:
    OneConstraintDataValidationOperator を返します。

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

    • value
    • タイプ:ig.excel.OneConstraintDataValidationOperator

    例外

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

    備考

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

Copyright © 1996 - 2024 Infragistics, Inc. All rights reserved.