ig.excel.WorksheetCollection

ワークブック内のワークシートのコレクション。

依存関係

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( name:string );
    返却型:
    ig.excel.Worksheet
    返却型の説明:
    指定した名前で作成したワークシート。

    新しい Worksheet を作成してコレクションに追加します。

    • name
    • タイプ:string
    • 新しいワークシートを指定するための名前。

    例外

    例外 説明
    ig.ArgumentNullException 名前は null または空です。
    ig.ArgumentException name は無効な文字を含みます: ':'、'\'、'/'、'?'、'*'、'['、または ']'。
    ig.ArgumentException name は無効な文字を含みます: ':'、'\'、'/'、'?'、'*'、'['、または ']'。
    ig.ArgumentException name は無効な文字を含みます: ':'、'\'、'/'、'?'、'*'、'['、または ']'。

    備考

    ワークブックにワークシートが最初からない場合、新しく追加されたワークシートは、ワークブックの選択されたワークシートになります。これはワークブックの WindowOptions.selectedWorksheet を設定することでより多くのワークシートを追加後に変更できます。

  • clear

    .clear( );

    このコレクションからすべてのワークシートをクリアします。

    備考

    Workbook.namedReferences コレクションの NamedReference インスタンスのなかに削除範囲に含まれるワークシートを持つインスタンスがある場合、そうしたインスタンスは Workbook から削除されます。

  • contains

    .contains( worksheet:ig.excel.Worksheet );
    返却型:
    boolean
    返却型の説明:
    ワークシートが見つかった場合は True、そうでなければ False。

    ワークシートがコレクションにあるかどうかを決定します。

    • worksheet
    • タイプ:ig.excel.Worksheet
    • このコレクションで見つけ出すワークシート。
  • count

    .count( );
    返却型:
    number
    返却型の説明:
    このコレクション内のワークシートの数。

    このコレクション内のワークシートの数を取得します。

  • exists

    .exists( name:string );
    返却型:
    boolean
    返却型の説明:
    指定された名前のワークシートが見つかった場合は True、そうでなければ False。

    指定した名前がコレクション内に存在するかどうかを決定します。

    • name
    • タイプ:string
    • 検索するワークシートの名前名前は大文字と小文字を区別せずに比較されます。
  • indexOf

    .indexOf( worksheet:ig.excel.Worksheet );
    返却型:
    number
    返却型の説明:
    コレクション内の指定したワークシートのインデックス。

    コレクション内の指定したワークシートのインデックスを取得します。

    • worksheet
    • タイプ:ig.excel.Worksheet
    • インデックスを取得するためのワークシ―ト。
  • item

    .item( index:number );
    返却型:
    ig.excel.Worksheet
    返却型の説明:
    指定されたインデックスにあるワークシート。

    指定したインデックスでワークシートを取得します。

    • index
    • タイプ:number
    • 取得するワークシートの 0 から始まるインデックス。

    例外

    例外 説明
    ig.ArgumentOutOfRangeException インデックスは 0 未満であるか、または、インデックスが WorksheetCollection.count 以上です。
  • item

    .item( name:string );
    返却型:
    ig.excel.Worksheet
    返却型の説明:
    指定されたインデックスにあるワークシート。

    指定したインデックスでワークシートを取得します。

    • name
    • タイプ:string
    • 取得するワークシートの名前。

    例外

    例外 説明
    ig.InvalidOperationException 指定した名前のワークシートはコレクションに存在しません。

    備考

    ワークシート名は大文字と小文字を区別せずに比較されます。

  • remove

    .remove( worksheet:ig.excel.Worksheet );
    返却型:
    boolean
    返却型の説明:
    ワークシートがコレクションから問題なく削除された場合は True、ワークシートがコレクションに存在しなかった場合は False。

    指定したワークシートをコレクションから削除します。

    • worksheet
    • タイプ:ig.excel.Worksheet
    • コレクションから削除するワークシート。

    備考

    Workbook.namedReferences コレクションの NamedReference インスタンスのなかにスコープとして削除するワークシートを持つインスタンスがある場合、そうしたインスタンスは Workbook から削除されます。

  • removeAt

    .removeAt( index:number );

    指定したインデックスにあるワークシートをコレクションから削除します。

    • index
    • タイプ:number
    • コレクションから削除するワークシートのインデックス。

    例外

    例外 説明
    ig.ArgumentOutOfRangeException インデックスは 0 未満であるか、または、インデックスが WorksheetCollection.count 以上です。

    備考

    Workbook.namedReferences コレクションの NamedReference インスタンスのなかにスコープとして削除するワークシートを持つインスタンスがある場合、そうしたインスタンスは Workbook から削除されます。

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