Main Content

mlreportgen.dom.Text クラス

パッケージ: mlreportgen.dom

説明

mlreportgen.dom.Text クラスのオブジェクトを使用し、ドキュメントにテキストを含めます。

mlreportgen.dom.Text クラスは handle クラスです。

クラス属性

HandleCompatible
true
ConstructOnLoad
true

作成

説明

textObj = mlreportgen.dom.Text() は、空の Text オブジェクトを作成します。

textObj = mlreportgen.dom.Text(text) は、指定されたテキストを含む Text オブジェクトを作成し、Content プロパティを text に設定します。

textObj = mlreportgen.dom.Text(text,styleName) は、さらにスタイルを指定して、StyleName プロパティを styleName に設定します。スタイルは、この Text オブジェクトを追加するドキュメントのテンプレートのスタイル シートで定義しなければなりません。

プロパティ

すべて展開する

このドキュメント要素に含まれるテキスト。文字ベクトルとして指定します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

テキストに太字を使用するかどうか。数値または logical の 1 (true) または 0 (false) として指定します。テキストを太字にするには、Boldtrue または 1 に設定します。

Bold プロパティを設定すると、対応する mlreportgen.dom.Bold 書式オブジェクトが Style プロパティに追加されます。Bold プロパティを空の値に設定すると、そのオブジェクトは削除されます。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

テキストにイタリックを使用するかどうか。数値または logical の 1 (true) または 0 (false) として指定します。テキストをイタリックにするには、Italictrue または 1 に設定します。

Italic プロパティを設定すると、対応する mlreportgen.dom.Italic 書式オブジェクトが Style プロパティに追加されます。Italic プロパティを空の値に設定すると、そのオブジェクトは削除されます。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

テキストの色。CSS の色名 (https://www.w3.org/wiki/CSS/Properties/color/keywordsを参照してください) または #RRGGBB 形式の 16 進数の RGB (トゥルーカラー) 値で構成される文字ベクトルまたは string スカラーとして指定します。

Color プロパティを設定すると、対応する mlreportgen.dom.Color 書式オブジェクトが Style プロパティに追加されます。Color プロパティを空の値に設定すると、そのオブジェクトは削除されます。

例: "blue"

例: "#0000ff"

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

背景色。CSS の色名 (https://www.w3.org/wiki/CSS/Properties/color/keywordsを参照してください) または #RRGGBB 形式の 16 進数の RGB (トゥルーカラー) 値で構成される文字ベクトルまたは string スカラーとして指定します。

BackgroundColor プロパティを設定すると、対応する mlreportgen.dom.BackgroundColor 書式オブジェクトが Style プロパティに追加されます。BackgroundColor プロパティを空の値に設定すると、そのオブジェクトは削除されます。

例: "blue"

例: "#0000ff"

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

下線のタイプ。次の表のいずれかの値として指定します。

下線の値説明サポートされる出力タイプ

"single"

一重線

すべて

"words"

スペースを除くすべての文字に下線を引く

Word

"double"

二重線

Word

"thick"

太い線

Word

"dotted"

点線

Word

"dottedHeavy"

太い点線

Word

"dash"

破線

Word

"dashedHeavy"

太い破線で構成される線

Word

"dashLong"

長い破線で構成される線

Word

"dashLongHeavy"

太くて長い破線で構成される線

Word

"dotDash"

一点鎖線

Word

"dashDotHeavy"

太い一点鎖線

Word

"dotDotDash"

二点鎖線

Word

"dashDotDotHeavy"

太い破線かつ破線の間に 2 つの点がある線

Word

"wave"

波線

Word

"wavyHeavy"

太い波線

Word

"wavyDouble"

二重波線

Word

"none"

下線なし

すべて

Underline プロパティを設定すると、対応する mlreportgen.dom.Underline 書式オブジェクトが Style プロパティに追加されます。Underline プロパティを空の値に設定すると、そのオブジェクトは削除されます。

下線の色とタイプの両方を指定する場合は、Underline プロパティを設定しないでください。代わりに、下線のタイプと色を指定する mlreportgen.dom.Underline 書式オブジェクトを含めるように Style プロパティを設定します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

テキストで使用する空白と改行のタイプ。次の表にあるいずれかの値として指定します。Document オブジェクトの Type プロパティが PDF の場合、WhiteSpace プロパティは適用されません。

説明サポートされる出力タイプ

"normal"

空白と改行は維持されません。

Word および HTML

"nowrap"

連続する空白は単一の空白に折りたたまれます。テキストが次の行に折り返されることはありません。

HTML

"preserve"

空白を維持します。テキストは必要に応じて、また改行で折り返されます。HTML の <pre-wrap> 設定のように機能します。

Word および HTML

"pre"

空白を維持します。テキストは改行でのみ折り返されます。HTML の <pre> 設定のように機能します。

HTML

"pre-line"

連続する空白は単一の空白に折りたたまれます。テキストは折り返されます。

HTML

"pre-wrap"

空白を維持します。テキストは必要に応じて、また改行で折り返されます。

HTML

MATLAB® ブラウザーで HTML 出力を表示し、空白を維持して改行でのみテキストを折り返す場合は、pre 設定の代わりに preserve 設定を使用します。

WhiteSpace プロパティを設定すると、対応する WhiteSpace 書式オブジェクトが Style プロパティに追加されます。WhiteSpace プロパティ設定を削除すると、WhiteSpace オブジェクトは削除されます。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

テキストに使用するフォント ファミリの名前。文字ベクトルまたは string スカラーとして指定します。

FontFamilyName プロパティを設定すると、対応する mlreportgen.dom.FontFamily 書式オブジェクトが Style プロパティに追加されます。FontFamilyName プロパティを設定することは、mlreportgen.dom.FontFamily オブジェクトの FontName プロパティを設定することと同じです。FontFamilyName プロパティを空の値に設定すると、そのオブジェクトは削除されます。

フォントの代替を指定する場合は、このプロパティの設定によってフォント ファミリを指定しないでください。代わりに、mlreportgen.dom.FontFamily オブジェクトを作成して Style プロパティに追加します。

例: "Courier New"

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

テキストに使用するフォント サイズ。数値とそれに続く測定単位の略語で構成される文字ベクトルまたは string スカラーとして指定します。たとえば、'12pt' は 12 ポイントを指定します。有効な略語を以下に示します。

  • px — ピクセル (既定)

  • cm — センチメートル

  • in — インチ

  • mm — ミリメートル

  • pc — パイカ

  • pt — ポイント

FontSize プロパティを設定すると、対応する mlreportgen.dom.FontSize 書式オブジェクトが Style プロパティに追加されます。FontSize プロパティを空の値に設定すると、そのオブジェクトは削除されます。

例: "12pt"

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

テキストの取り消し線。次のいずれかの値として指定します。

  • "none" — 取り消し線なし

  • "single" — 一重線

  • "double" — 二重線 (Word レポートの場合のみ)

Strike プロパティを設定すると、対応する mlreportgen.dom.Strike 書式オブジェクトが、このドキュメント要素の Style プロパティに追加されます。Strike プロパティを空の値に設定すると、そのオブジェクトは削除されます。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

スタイルは、この Text オブジェクトを追加するドキュメントのテンプレートのスタイルシートで定義しなければなりません。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

テキストの書式設定。DOM 書式オブジェクトの cell 配列として指定します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

このドキュメント要素のカスタム属性。mlreportgen.dom.CustomAttribute オブジェクトの配列として指定します。カスタム属性は、この Text オブジェクトが追加される Document オブジェクトの出力形式でサポートされていなければなりません。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

この DOM API オブジェクトの親。DOM API オブジェクトとして指定します。

属性:

GetAccess
public
SetAccess
private
NonCopyable
true

この DOM API オブジェクトの子。DOM API オブジェクトの配列として指定します。

属性:

GetAccess
public
SetAccess
private
NonCopyable
true

この DOM API オブジェクトのタグ。文字ベクトルまたは string スカラーとして指定します。

DOM は、このオブジェクトを作成するときに、セッション固有タグを生成します。生成されたタグの形式は CLASS:ID という形式です。ここで、CLASS はオブジェクト クラスです。ID はオブジェクトの Id プロパティの値です。独自のタグ値を指定すると、ドキュメントの生成中に問題が発生した箇所を容易に特定できるようになります。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

この DOM API オブジェクトの ID。文字ベクトルまたは string スカラーとして指定します。ドキュメント要素を作成するときに、DOM によってセッション固有 ID が生成されます。独自の ID を指定できます。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

メソッド

すべて展開する

すべて折りたたむ

この例では、2 つの個別の mlreportgen.dom.Text オブジェクトを使用して段落を書式設定し、テキストの各部分が独自のスタイルをもてるようにします。最初の Text オブジェクトは、テキストに下線を付けて太字にします。2 番目の Text オブジェクトは、既定のスタイルを使用します。

長い完全修飾名を使用せずに済むよう、DOM API パッケージをインポートします。

import mlreportgen.dom.*

Document オブジェクトを作成します。

d = Document("mydoc","html");

Paragraph オブジェクトを作成します。

para = Paragraph();

太字にして下線を付けるテキストの Text オブジェクトを作成します。Text オブジェクトを Paragraph オブジェクトに追加します。

paraTitle = Text("Results:");
paraTitle.Bold = true;
paraTitle.Underline = "single";
append(para,paraTitle);

段落内の残りのテキスト用に Text オブジェクトを作成し、その Text オブジェクトを Paragraph オブジェクトに追加します。

paraContent = Text(" Study 1");
append(para,paraContent);
append(d,para);

レポートを閉じて表示します。

close(d);
rptview(d);

生成された段落は次のようになります。

バージョン履歴

R2014b で導入