RichText

<RichText> は、テキストに複数の書式を適用して描画する要素です。

<RichText>これは<Span color="red" bold="true">RichText</Span>です。</RichText>
描画結果

<RichText> 内では、<Span> 要素を使って部分的に書式を設定します。書式を変えたい箇所を <Span> で囲むことで、太字や色などを指定できます。また、<Span> は入れ子にすることも可能です。

<RichText>これは<Span color="red" underline="true">書式を<Span size="14" color="blue">ネスト</Span>した例</Span>です。</RichText>
描画結果

プロパティ

fontFamily

フォントファミリーを設定します。

データ型

FontFamily

必須

省略可能です。既定値は gothic です。

テンプレート変数

使用できません。

size

フォントサイズを設定します。 指定可能な値は 1 以上、1024 以下です。

データ型

UnsignedFloat (単位: pt)

必須

省略可能です。既定値は 11 です。

テンプレート変数

使用できません。

color

テキストの色を設定します。

データ型

Color

必須

省略可能です。既定値は black です。

テンプレート変数

使用可能です。

bold

テキストを太字にするかを設定します。

データ型

Boolean

必須

省略可能です。既定値は false です。

テンプレート変数

使用できません。

underline

テキストに下線を引くかを設定します。

データ型

Boolean

必須

省略可能です。既定値は false です。

テンプレート変数

使用できません。

underlinePosition

下線の描画位置を設定します。

データ型

UnderlinePosition

必須

省略可能です。既定値は normal です。

テンプレート変数

使用できません。

lineGap

テキストの垂直方向の行間を設定します。 size を基準にした相対サイズを指定します。

例えば、<Text size="11" lineGap="0.5"> と指定した場合、 5.5ポイント分の行間を設けてテキストが描画されます。

データ型

UnsignedFloat

必須

省略可能です。既定値は 0 です。

テンプレート変数

使用できません。

letterSpacing

テキストの水平方向の字間を設定します。 size を基準にした相対サイズを指定します。

例えば、<Text size="11" letterSpacing="0.5"> と指定した場合、 5.5ポイント分の字間を設けてテキストが描画されます。

データ型

UnsignedFloat

必須

省略可能です。既定値は 0 です。

テンプレート変数

使用できません。

align

テキストの水平方向の配置を設定します。

align="justify"letterSpacing を同時に指定した場合、 letterSpacing よりも広い字間となるように両端揃えを行います。

データ型

TextAlign

必須

省略可能です。既定値は left です。

テンプレート変数

使用可能です。

valign

テキストの垂直方向の配置を設定します。

データ型

TextVerticalAlign

必須

省略可能です。既定値は top です。

テンプレート変数

使用可能です。

wordwrap

テキストの折り返し方法を設定します。

データ型

Wordwrap

必須

省略可能です。既定値は normal です。

テンプレート変数

使用できません。

overflow

テキストが描画領域内に収まらなかった場合の振る舞いを設定します。

データ型

Overflow

必須

省略可能です。既定値は clip です。

テンプレート変数

使用できません。

width (stack-only)

描画領域の幅を設定します。

データ型

UnsignedFloat (単位: mm)

必須

Stackコンテナ要素内に限り、必須です。

テンプレート変数

使用可能です。

備考

このプロパティはStackコンテナ要素内でのみ有効です。

height (required)

描画領域の高さを設定します。

データ型

FlexHeight (単位: mm)

必須

省略可能です。既定値は auto です。

テンプレート変数

使用できません。

x (stack-only)

この要素を配置するX座標(水平方向の位置)を指定します。 座標の基準点は origin プロパティで指定します。

データ型

Float (単位: mm)

必須

省略可能です。既定値は 0 です。

テンプレート変数

使用可能です。

備考

このプロパティはStackコンテナ要素内でのみ有効です。

y (stack-only)

この要素を配置するY座標(垂直方向の位置)を指定します。 座標の基準点は origin プロパティで指定します。

データ型

Float (単位: mm)

必須

省略可能です。既定値は 0 です。

テンプレート変数

使用可能です。

備考

このプロパティはStackコンテナ要素内でのみ有効です。

origin (stack-only)

X/Y座標の基準点を設定します。

データ型

Origin

必須

省略可能です。既定値は topLeft です。

テンプレート変数

使用可能です。

備考

このプロパティはStackコンテナ要素内でのみ有効です。

breakInside

この要素の改ページ制御ルールを設定します。

データ型

BreakInside

テンプレート変数

使用できません。

既定値

auto

style

この要素に適用するスタイルの識別名を設定します。

データ型

StyleName

必須

省略可能です。既定値はありません。

テンプレート変数

使用できません。

logic

この要素に適用する制御構造を設定します。

データ型

Logic

必須

省略可能です。既定値はありません。

テンプレート変数

使用できません。

StyleXML

<RichText> 要素は、StyleXMLに対応しています。 次のプロパティが使用可能です。

使用可能なプリセット変数

以下のプリセット変数は <StackLayout> <LayoutHeader> <LayoutFooter> の中で使うことができます。

${Report.page}

全体を通したページ番号

${Report.totalPages}

全体を通した総ページ数

${Layout.page}

現在のレイアウトにおけるページ番号

${Layout.totalPages}

現在のレイアウトにおける総ページ数

関連情報