メインコンテンツまでスキップ
version: v2.3

RichText

概要​

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

この要素では、描画したい文字列をテキストコンテンツとして指定します。 テンプレート変数をテキストコンテンツ内で使用することも可能です。 詳細については、以下の開発ガイドを参照してください。

また、<Span> 要素を使うことで、コンテンツの一部に対して書式を指定できます。 後述の「XMLの記述例」を参照してください。

XMLの記述例​

レイアウトXML​

<RichText> では、テキストコンテンツの一部を <Span> 要素で囲むことで、その範囲に限定して書式を設定できます。

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

このXMLは以下のように描画されます。

描画結果

また、<Span> は入れ子にして記述しても構いません。

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

描画結果

スタイルXML​

<RichText key="style1" fontFamily="mincho" />

属性​

fontFamily​

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

データ型
FontFamily
必須
省略可能です。既定値は gothic です。
テンプレート変数の使用
使用できません。
スタイルXMLでの記述
記述可能です。

size​

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

データ型
UnsignedFloat （単位 : pt）
必須
省略可能です。既定値は 11 です。
テンプレート変数の使用
使用できません。
スタイルXMLでの記述
記述可能です。

color​

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

データ型
Color
必須
省略可能です。既定値は black です。
テンプレート変数の使用
使用可能です。
スタイルXMLでの記述
記述可能です。

bold​

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

データ型
Boolean
必須
省略可能です。既定値は false です。
テンプレート変数の使用
使用できません。
スタイルXMLでの記述
記述可能です。

underline​

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

データ型
Boolean
必須
省略可能です。既定値は false です。
テンプレート変数の使用
使用できません。
スタイルXMLでの記述
記述可能です。

underlinePosition​

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

データ型
UnderlinePosition
必須
省略可能です。既定値は normal です。
テンプレート変数の使用
使用できません。
スタイルXMLでの記述
記述可能です。

lineGap​

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

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

データ型
UnsignedFloat
必須
省略可能です。既定値は 0 です。
テンプレート変数の使用
使用できません。
スタイルXMLでの記述
記述可能です。

letterSpacing​

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

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

データ型
UnsignedFloat
必須
省略可能です。既定値は 0 です。
テンプレート変数の使用
使用できません。
スタイルXMLでの記述
記述可能です。

align​

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

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

データ型
TextAlign
必須
省略可能です。既定値は left です。
テンプレート変数の使用
使用可能です。
スタイルXMLでの記述
記述可能です。

valign​

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

データ型
TextVerticalAlign
必須
省略可能です。既定値は top です。
テンプレート変数の使用
使用可能です。
スタイルXMLでの記述
記述可能です。

wordwrap​

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

データ型
Wordwrap
必須
省略可能です。既定値は normal です。
テンプレート変数の使用
使用できません。
スタイルXMLでの記述
記述可能です。

overflow​

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

データ型
Overflow
必須
省略可能です。既定値は clip です。
テンプレート変数の使用
使用できません。
スタイルXMLでの記述
記述可能です。

width​

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

注記

この属性はスタックルールの要素内でのみ使用できます。

データ型
UnsignedFloat （単位 : mm）
必須
必須です。
テンプレート変数の使用
使用可能です。
スタイルXMLでの記述
記述できません。

height​

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

データ型
FlexHeight （単位 : mm）
必須
省略可能です。既定値は auto です。
テンプレート変数の使用
使用できません。
スタイルXMLでの記述
記述できません。

x​

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

注記

この属性はスタックルールの要素内でのみ使用できます。

データ型
Float （単位 : mm）
必須
必須です。
テンプレート変数の使用
使用可能です。
スタイルXMLでの記述
記述できません。

y​

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

注記

この属性はスタックルールの要素内でのみ使用できます。

データ型
Float （単位 : mm）
必須
必須です。
テンプレート変数の使用
使用可能です。
スタイルXMLでの記述
記述できません。

origin​

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

注記

この属性はスタックルールの要素内でのみ使用できます。

データ型
Origin
必須
必須です。
テンプレート変数の使用
使用可能です。
スタイルXMLでの記述
記述できません。

breakInside​

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

データ型
BreakInside
必須
省略可能です。既定値は auto です。
テンプレート変数の使用
使用できません。
スタイルXMLでの記述
記述できません。

logic​

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

データ型
Logic
必須
省略可能です。既定値はありません。
テンプレート変数の使用
使用できません。
スタイルXMLでの記述
記述できません。

style​

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

データ型
StyleName
必須
省略可能です。既定値はありません。
テンプレート変数の使用
使用できません。
スタイルXMLでの記述
記述できません。

key​

この要素のスタイル名を設定します。

注記

この属性はスタイルXMLでのみ使用できます。

データ型
StyleName
必須
省略可能です。既定値はありません。
テンプレート変数の使用
使用できません。
スタイルXMLでの記述
記述可能です。

関連情報​