ig.excel.FormattedText
備考
文字列の書式は、Microsoft Excel と同様の方式で制御されます。Excel では、ユーザーはテキストの一部分を選択し、選択したテキストのさまざまな書式プロパティを設定します。
FormattedText では、FormattedText.getFont または FormattedText.getFont を呼び出すことによってテキストの一部分を「selected」(選択状態) に設定します。その後、返された FormattedTextFont に対して書式のプロパティが設定され、こうしたプロパティはフォントの選択範囲に含まれるすべての文字に設定されます。
FormattedTextFont の書式設定プロパティを取得すると、フォントの選択範囲にある最初の文字の書式が返されます。
依存関係
-
ig.excel.FormattedText
コンストラクター- new $.ig.excel.FormattedText( unformattedString:string );
FormattedText クラスの新しいインスタンスを作成します。
- unformattedString
- タイプ:string
- このシェイプに表示される文字列です。文字列の各行は、FormattedText.paragraphs コレクションの別個の段落に配置されます。
例外
例外 説明 ig.ArgumentNullException unformattedString は null です。 -
clone
- .clone( );
- 返却型:
- ig.excel.FormattedText
- 返却型の説明:
- この FormattedText をコピーして新規に作成した FormattedText インスタンス。
このコピーである新しい FormattedText を作成します。
備考
同じ書式付きテキストを複数のシェイプで使用する必要がある場合にはこれを使用します。 FormattedText クラスを同時に複数のシェイプの WorksheetShapeWithText.text として使用することはできません。すでに特定のシェイプのテキストとして使用されている FormattedText を別のシェイプのテキストとして使用する必要がある場合には、その FormattedText のクローンを作成し、そのクローンを当該のシェイプのテキストとして指定してください。
FormattedText のクローンは、複製元の FormattedText の設定値をコピーしただけものです。 このインスタンスがクローンされて変更されると、クローンは変更されず、これがクローンされた時の状態のままになります。
-
getFont
- .getFont( startIndex:number );
- 返却型:
- ig.excel.FormattedTextFont
- 返却型の説明:
- この文字列の末尾部分の書式を決定する FormattedTextFont インスタンス。
指定した開始インデックスから文字列の終わりまでの文字列の書式プロパティを制御するフォントを取得します。
- startIndex
- タイプ:number
- 返されるフォント制御の最初の文字のインデックス。
例外
例外 説明 ig.ArgumentOutOfRangeException startIndex はゼロ未満です。 備考
開始インデックスが書式化されていない文字列の長さ以上の場合、例外はスローされません。返された FormattedTextFont の書式プロパティのひとつが設定されると後で例外がスローされます。
-
getFont
- .getFont( startIndex:number, length:number );
- 返却型:
- ig.excel.FormattedTextFont
- 返却型の説明:
- この文字列の末尾部分の書式を決定する FormattedTextFont インスタンス。
指定した開始インデックスから文字列の終わりまでの文字列の書式プロパティを制御するフォントを取得します。
- startIndex
- タイプ:number
- 返されるフォント制御の最初の文字のインデックス。
- length
- タイプ:number
- 返されるフォントによって制御される開始インデックスの後の文字数。
例外
例外 説明 ig.ArgumentOutOfRangeException startIndex はゼロ未満です。 ig.ArgumentOutOfRangeException startIndex はゼロ未満です。 備考
開始インデックスが書式化されていない文字列の長さ以上の場合、例外はスローされません。返された FormattedTextFont の書式プロパティのひとつが設定されると後で例外がスローされます。
-
getFormattingRuns
- .getFormattingRuns( );
文字列の最初文字に開始する同様な書式設定の接続ブロックを表す書式設定ランのコレクションを取得します。
-
paragraphs
- .paragraphs( );
- 返却型:
- ig.excel.FormattedTextParagraphCollection
- 返却型の説明:
- 指定されたインデックスにある段落を表す FormattedTextParagraph。
書式付きテキストの段落を取得します。
-
paragraphs
- .paragraphs( index:number );
- 返却型:
- ig.excel.FormattedTextParagraph
- 返却型の説明:
- 指定されたインデックスにある段落を表す FormattedTextParagraph。
書式付きテキストの段落を取得します。
- index
- タイプ:number
- 取得する段落の 0 から始まるインデックス。
例外
例外 説明 ig.ArgumentOutOfRangeException index が 0 未満、またはコレクションに含まれる段落数以上の値です。 -
toString
- .toString( );
- 返却型:
- string
- 返却型の説明:
- この FormattedText を表す文字列です。
FormattedText を表す文字列を返します。この文字列は書式設定のない文字列です。
-
verticalAlignment
- .verticalAlignment( );
- 返却型:
- ig.excel.VerticalTextAlignment
- 返却型の説明:
親シェイプ内における書式付きテキストの垂直方向の配置を取得します。
例外
例外 説明 ig.excel.InvalidEnumArgumentException 指定した値が VerticalTextAlignment 列挙体に定義されていません。 -
verticalAlignment
- .verticalAlignment( value:ig.excel.VerticalTextAlignment );
- 返却型:
- ig.excel.VerticalTextAlignment
- 返却型の説明:
親シェイプ内における書式付きテキストの垂直方向の配置を取得します。
- value
- タイプ:ig.excel.VerticalTextAlignment
例外
例外 説明 ig.excel.InvalidEnumArgumentException 指定した値が VerticalTextAlignment 列挙体に定義されていません。