ig.excel.PageBreakCollection`1

PageBreakCollection`1.worksheet の水平および垂直の改ページのコレクションの基本クラス。

依存関係

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( pageBreak:ig.excel.T );

    PageBreakCollection`1.worksheet に改ページを追加します。

    • pageBreak
    • タイプ:ig.excel.T
    • Worksheet に追加する改ページ。

    例外

    例外 説明
    ig.ArgumentNullException pageBreak が null の場合に発生します。
    ig.ArgumentException pageBreak がすでにコレクションに含まれている別の改ページと重複する場合に発生します。
  • clear

    .clear( );

    改ページのコレクションをクリアします。

  • contains

    .contains( pageBreak:ig.excel.T );
    返却型:
    boolean
    返却型の説明:
    改ページが Worksheet 上にある場合は True、そうでない場合は False。

    指定した改ページが PageBreakCollection`1.worksheet に存在するかどうかを判定します。

    • pageBreak
    • タイプ:ig.excel.T
    • テストする改ページ。

    例外

    例外 説明
    ig.ArgumentNullException pageBreak が null の場合に発生します。
  • count

    .count( );

    このコレクション内の改ページの数を取得します。

  • indexOf

    .indexOf( pageBreak:ig.excel.T );
    返却型:
    number
    返却型の説明:
    改ページのゼロで始まるインデックスか、改ページがコレクションに含まれていない場合は -1。

    指定した改ページのゼロから始まるインデックスを取得します。

    • pageBreak
    • タイプ:ig.excel.T
    • インデックスを取得する改ページ。

    例外

    例外 説明
    ig.ArgumentNullException pageBreak が null の場合に発生します。
  • item

    .item( index:number );
    返却型:
    ig.excel.T
    返却型の説明:
    PageBreak から派生したインスタンス。

    指定したインデックスにある改ページを取得します。

    • index
    • タイプ:number
    • 取得する改ページのインデックス。

    例外

    例外 説明
    ig.ArgumentOutOfRangeException index が 0 よりも小さいか PageBreakCollection`1.count 以上の場合に発生します。
  • remove

    .remove( pageBreak:ig.excel.T );
    返却型:
    boolean
    返却型の説明:
    削除前に改ページが Worksheet に含まれていた場合は True、そうでない場合は False。

    指定した改ページを PageBreakCollection`1.worksheet から削除します。

    • pageBreak
    • タイプ:ig.excel.T
    • 削除する改ページ。

    例外

    例外 説明
    ig.ArgumentNullException pageBreak が null の場合に発生します。
  • removeAt

    .removeAt( index:number );

    指定したインデックスにある改ページを削除します。

    • index
    • タイプ:number
    • 削除する改ページのゼロから始まるインデックス。

    例外

    例外 説明
    ig.ArgumentOutOfRangeException index が、0 よりも小さいか、コレクション内の改ページ数以上の場合に発生します。

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