ig.excel.FormattedString

セルまたはセル コメント内の書式設定が混在する文字列を表します。

備考

文字列の書式は、Microsoft Excel と同様の方式で制御されます。Excel では、ユーザーはテキストの一部分を選択し、選択したテキストのさまざまな書式プロパティを設定します。

FormattedString では、文字列の一部分は GetFont(int) または GetFont(int,int) で呼び出すことによって選択されます。書式プロパティは、返される FormattedStringFont で設定され、フォントの選択範囲のすべての文字がこれらのプロパティで指定されます。

FormattedStringFont の書式プロパティを取得すると、フォントの選択範囲で最初の文字の書式を返します。これは Excel と似ており、セルのテキストが選択されると、選択範囲の最初の文字の書式を反映するために書式インタフェースを更新します。

依存関係

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.FormattedString
    コンストラクター

    new $.ig.excel.FormattedString( unformattedString:string );

    FormattedString クラスの新しいインスタンスを作成します。

    • unformattedString
    • タイプ:string
    • 書式を持つセルに表示される文字列。

    例外

    例外 説明
    ig.ArgumentNullException unformattedString は null です。
  • clone

    .clone( );
    返却型:
    ig.excel.FormattedString
    返却型の説明:
    このコピーである新しい FormattedString。

    このコピーである新しい FormattedString を作成します。

    備考

    これは同じ書式化された文字列を複数のセルで使用する必要がある場合に使用されます。 FormattedString クラスは、一度にひとつのセルの WorksheetCell.value としてのみ存在できます。FormattedString がすでにセルの値であり、他のセルの値として設定する必要がある場合、FormattedString のクローンを作成し、セルの値として返されたクローンを設定します。

    クローンされた FormattedString は、このインスタンスのオリジナル構成のみをとります。 このインスタンスがクローンされて変更されると、クローンは変更されず、これがクローンされた時の状態のままになります。

  • equals

    .equals( obj:object );
    返却型:
    boolean
    返却型の説明:
    obj が FormattedString インスタンスの場合は True で、FormattedString と同じ書式化されていない文字列と書式を含み、そうでなければ False。

    指定した Object がこの FormattedString と等しいかどうかを決定します。

    • obj
    • タイプ:object
    • この FormattedString と等しいことをテストするための値。
  • getFont

    .getFont( startIndex:number );
    返却型:
    ig.excel.FormattedStringFont
    返却型の説明:
    文字列の終わりの部分の書式を制御する FormattedStringFont インスタンス。

    指定した開始インデックスから文字列の終わりまでの文字列の書式プロパティを制御するフォントを取得します。

    • startIndex
    • タイプ:number
    • 返されるフォント制御の最初の文字のインデックス。

    例外

    例外 説明
    ig.ArgumentOutOfRangeException startIndex はゼロ未満です。

    備考

    開始インデックスが書式化されていない文字列の長さ以上の場合、例外はスローされません。返された FormattedStringFont の書式プロパティのひとつが設定されると後で例外がスローされます。

  • getFont

    .getFont( startIndex:number, length:number );
    返却型:
    ig.excel.FormattedStringFont
    返却型の説明:
    文字列の終わりの部分の書式を制御する FormattedStringFont インスタンス。

    指定した開始インデックスから文字列の終わりまでの文字列の書式プロパティを制御するフォントを取得します。

    • startIndex
    • タイプ:number
    • 返されるフォント制御の最初の文字のインデックス。
    • length
    • タイプ:number
    • 返されるフォントによって制御される開始インデックスの後の文字数。

    例外

    例外 説明
    ig.ArgumentOutOfRangeException startIndex はゼロ未満です。
    ig.ArgumentOutOfRangeException startIndex はゼロ未満です。

    備考

    開始インデックスが書式化されていない文字列の長さ以上の場合、例外はスローされません。返された FormattedStringFont の書式プロパティのひとつが設定されると後で例外がスローされます。

  • getFormattingRuns

    .getFormattingRuns( );

    文字列の最初文字に開始する同様な書式設定の接続ブロックを表す書式設定ランのコレクションを取得します。

  • getHashCode

    .getHashCode( );
    返却型:
    number
    返却型の説明:
    ハッシュ関数で使用できる数。

    この FormattedString のハッシュ コードを計算します。

  • toString

    .toString( );
    返却型:
    string
    返却型の説明:
    この FormattedString を表す文字列。

    この FormattedString を表す文字列を返します。 これは書式化されていない文字列です。

    備考

    これは FormattedString.unformattedString と同じ値を返します。

  • unformattedString

    .unformattedString( );
    返却型:
    string
    返却型の説明:
    書式化されていない文字列。

    書式化されていない文字列を取得します。

    例外

    例外 説明
    ig.ArgumentNullException 指定された値は null 文字列です。

    備考

    指定された新しい書式化されていない文字列が古い書式化されていない文字列よりも短い場合、新しい値の範囲外のすべての書式は失われます。

  • unformattedString

    .unformattedString( value:string );
    返却型:
    string
    返却型の説明:
    書式化されていない文字列。

    書式化されていない文字列を取得します。

    • value
    • タイプ:string

    例外

    例外 説明
    ig.ArgumentNullException 指定された値は null 文字列です。

    備考

    指定された新しい書式化されていない文字列が古い書式化されていない文字列よりも短い場合、新しい値の範囲外のすべての書式は失われます。

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