ig.excel.FormattedTextParagraphCollection

FormattedText の FormattedTextParagraph インスタンスのコレクション。

依存関係

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( paragraphText:string );
    返却型:
    ig.excel.FormattedTextParagraph
    返却型の説明:
    新たに追加された段落を表す FormattedTextParagraph。

    指定されたテキストからなる段落を追加し、新たに追加された段落を表す FormattedTextParagraph を返します。

    • paragraphText
    • タイプ:string
    • この段落に含まれるテキスト。
  • clear

    .clear( );

    この書式付きテキストから段落をすべて削除します。

  • contains

    .contains( paragraph:ig.excel.FormattedTextParagraph );
    返却型:
    boolean
    返却型の説明:
    指定した段落がコレクションに含まれている場合は True、そうでない場合は False。

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

    • paragraph
    • タイプ:ig.excel.FormattedTextParagraph
    • コレクションに含まれているかどうかを調べたい段落。
  • count

    .count( );

    このコレクションに含まれる段落の数を取得します。

  • getEnumerator

    .getEnumerator( );

    すべての段落を繰り返し走査する列挙体を取得します。

  • indexOf

    .indexOf( paragraph:ig.excel.FormattedTextParagraph );
    返却型:
    number
    返却型の説明:
    コレクション内における指定した段落の位置が 0 から始まるインデックスとして返されます。指定した段落がコレクション内に存在しない場合は -1 が返されます。

    コレクション内における指定した段落の 0 から始まるインデックスを取得します。

    • paragraph
    • タイプ:ig.excel.FormattedTextParagraph
    • コレクションに含まれているかどうかを調べたい段落。
  • insert

    .insert( index:number, paragraphText:string );
    返却型:
    ig.excel.FormattedTextParagraph
    返却型の説明:
    新たに追加された段落を表す FormattedTextParagraph。

    指定されたテキストからなる段落を挿入し、新たに追加された段落を表す FormattedTextParagraph を返します。

    • index
    • タイプ:number
    • コレクション内での段落の挿入位置を表す 0 から始まるインデックス。
    • paragraphText
    • タイプ:string
    • この段落に含まれるテキスト。

    例外

    例外 説明
    ig.ArgumentOutOfRangeException index が 0 未満、またはこのコレクションに含まれる段落の数を超える値です。
  • item

    .item( index:number );
    返却型:
    ig.excel.FormattedTextParagraph
    返却型の説明:
    指定されたインデックスにある段落を表す FormattedTextParagraph

    0 から始まるインデックスを指定して段落を取得します。

    • index
    • タイプ:number
    • 取得する段落の 0 から始まるインデックス。

    例外

    例外 説明
    ig.ArgumentOutOfRangeException index が 0 未満、またはコレクションに含まれる段落数以上の値です。
  • remove

    .remove( paragraph:ig.excel.FormattedTextParagraph );
    返却型:
    boolean
    返却型の説明:
    指定した段落がコレクションに含まれている、あるいは削除された場合は True、そうでない場合は False。

    指定した段落をコレクションから削除します。

    • paragraph
    • タイプ:ig.excel.FormattedTextParagraph
    • コレクションから削除する段落。
  • removeAt

    .removeAt( index:number );

    0 から始まるインデックス値によって段落の位置を指定し、その段落をコレクションから削除します。

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

    例外

    例外 説明
    ig.ArgumentOutOfRangeException index が 0 未満、またはコレクションに含まれる段落数以上の値です。

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