ig.excel.DisplayValueCollection

表示テキストの値のコレクション。

依存関係

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
このコントロールにオプションはありません。
このコントロールにイベントはありません。
  • add

    .add( item:string );

    このコレクションに表示テキスト値を追加します。

    • item
    • タイプ:string
    • このコレクションに追加する表示テキスト値。

    例外

    例外 説明
    ig.ArgumentNullException 項目は null または空です。
    ig.ArgumentException 項目はこのコレクションに含まれる別の値に一致します。値は大文字と小文字を区別せずに比較されます。
  • clear

    .clear( );

    コレクションを消去します。

    例外

    例外 説明
    ig.InvalidOperationException コレクションは、そのコレクション内の値のみを許可した FixedValuesFilter によって所有されます。 コレクションをクリアするとフィルターが値を含まないようにします。これは FixedValuesFilter には許可されません。
  • contains

    .contains( item:string );
    返却型:
    boolean

    指定した値がこのコレクションに含まれているかどうかを調べます。

    • item
    • タイプ:string
    • このコレクションに含まれているかどうかを調べたい表示テキスト値。

    備考

    表示テキストの値は大文字と小文字を区別せずに比較されます。

  • count

    .count( );

    このコレクションに含まれている表示テキスト値の数を取得します。

  • indexOf

    .indexOf( item:string );
    返却型:
    number
    返却型の説明:
    このコレクション内における指定した表示テキスト値の 0 から始まるインデックスが返されます。指定した項目がこのコレクションに含まれていない場合は -1 が返されます。

    このコレクション内における指定した表示テキスト値のインデックスを取得します。

    • item
    • タイプ:string
    • このコレクションに含まれているかどうかを調べたい表示テキスト値。
  • insert

    .insert( index:number, item:string );

    このコレクションに表示テキスト値を挿入します。

    • index
    • タイプ:number
    • 値の挿入位置を表す 0 から始まるインデックス。
    • item
    • タイプ:string
    • このコレクションに挿入する表示テキストの値。

    例外

    例外 説明
    ig.ArgumentNullException 項目は null または空です。
    ig.ArgumentException 項目はこのコレクションに含まれる別の値に一致します。値は大文字と小文字を区別せずに比較されます。
    ig.ArgumentOutOfRangeException index が、0 未満、または DisplayValueCollection.count を超える値です。
  • item

    .item( index:number );

    指定したインデックスにある表示テキストの値を取得します。

    • index
    • タイプ:number
    • 取得または設定する値の 0 から始まるインデックス。

    例外

    例外 説明
    ig.ArgumentOutOfRangeException index が 0 未満、または DisplayValueCollection.count 以上の値です。
    ig.ArgumentNullException 指定された値は null です。
    ig.ArgumentException 割り当てられた値はこのコレクションに含まれる別の値に一致します。値は大文字と小文字を区別せずに比較されます。
  • item

    .item( index:number, value:string );

    指定したインデックスにある表示テキストの値を取得します。

    • index
    • タイプ:number
    • 取得または設定する値の 0 から始まるインデックス。
    • value
    • タイプ:string

    例外

    例外 説明
    ig.ArgumentOutOfRangeException index が 0 未満、または DisplayValueCollection.count 以上の値です。
    ig.ArgumentNullException 指定された値は null です。
    ig.ArgumentException 割り当てられた値はこのコレクションに含まれる別の値に一致します。値は大文字と小文字を区別せずに比較されます。
  • remove

    .remove( item:string );
    返却型:
    boolean
    返却型の説明:
    指定した値が見つかり削除された場合は True、そうでない場合は False。

    このコレクションから表示テキスト値を削除します。

    • item
    • タイプ:string
    • このコレクションから削除する表示テキスト値。

    備考

    表示テキストの値は大文字と小文字を区別せずに比較されます。

  • removeAt

    .removeAt( index:number );

    指定したインデックスにある表示テキストの値を削除します。

    • index
    • タイプ:number
    • 削除する値の 0 から始まるインデックス。

    例外

    例外 説明
    ig.ArgumentOutOfRangeException index が 0 未満、または DisplayValueCollection.count 以上の値です。
    ig.InvalidOperationException この操作はコレクション内の最後の項目を削除し、コレクション内の値のみを許可した FixedValuesFilter によって所有されます。コレクションをクリアするとフィルターが値を含まないようにします。これは FixedValuesFilter には許可されません。

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