mlreportgen.dom.Text クラス

名前空間: mlreportgen.dom

Text オブジェクト

このページをすべて展開する

説明

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 オブジェクトを追加するドキュメントのテンプレートのスタイル シートで定義しなければなりません。

プロパティ

すべて展開する

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

テキストに使用するフォント ファミリの名前。文字ベクトルまたは string スカラーとして指定します。フォントの代替を指定する場合は、このプロパティの設定によってフォント ファミリを指定しないでください。代わりに、mlreportgen.dom.FontFamily オブジェクトを作成して Style プロパティに追加します。

メモ

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

例: "Courier New"

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

ドキュメント要素に使用するフォント サイズ (数値とそれに続く測定単位の略語を含む)。文字ベクトルまたは string スカラーとして指定します。たとえば、"12pt" は 12 ポイントを指定します。有効な略語を以下に示します。

  • "px" — ピクセル

  • "cm" — センチメートル

  • "in" — インチ

  • "mm" — ミリメートル

  • "pc" — パイカ

  • "pt" — ポイント

メモ

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

例: "12pt"

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

CSS の色名または 16 進数の RGB 値を含む背景色。文字ベクトルまたは string スカラーとして指定します。

  • 色の名前を使用するには、CSS の色名を指定します。CSS の色名のリストについては、https://www.w3.org/wiki/CSS/Properties/color/keywordsを参照してください。

  • 16 進数の RGB 形式を指定するには、最初の文字として # を使用し、赤、緑、および青の値に 2 桁の 16 進数を使用します。たとえば、"#0000ff" は青を指定します。

メモ

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

例: "blue"

例: "#0000ff"

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

ドキュメント要素オブジェクトの色。CSS の色名または 16 進数の RGB 値を含む文字ベクトルまたは string スカラーとして指定します。

  • 色の名前を使用するには、CSS の色名を指定します。CSS の色名のリストについては、https://www.w3.org/wiki/CSS/Properties/color/keywords を参照してください。

  • 16 進数の RGB 形式を指定するには、最初の文字として # を使用し、赤、緑、および青の値に 2 桁の 16 進数を使用します。たとえば、"#0000ff" は青を指定します。

メモ

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

例: "blue"

例: "#0000ff"

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

このドキュメント要素に太字を使用するオプション。数値または logical の 1 (true) または 0 (false) として指定します。ドキュメント要素を太字にするには、Bold を true または 1 に設定します。

メモ

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: logical

ドキュメント要素にイタリックを使用するオプション。数値または logical の 1 (true) または 0 (false) として指定します。ドキュメント要素をイタリックにするには、Italic を true または 1 に設定します。

メモ

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: logical

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

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

  • "single" — 一重線

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

メモ

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

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

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

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

テキスト内の空白と改行の処理方法。次の表のいずれかの値として指定します。Document オブジェクトの Type プロパティが PDF の場合、WhiteSpace プロパティは適用されません。

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

"normal"

HTML や PDF の場合、この値を設定すると、テキストの最初と最後のスペースが削除されます。テキスト内の複数のスペースは単一のスペースに折りたたまれます。

Microsoft® Word の場合、この値を設定すると、テキストの最初と最後のスペースが削除されます。

すべて

"nowrap"

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

HTML

"pre"

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

HTML および PDF

"preserve"

"pre" と同様です。すべて

"pre-line"

連続する空白は単一の空白に折りたたまれます。テキストは必要に応じて、また改行で折り返されます。

HTML および PDF

"pre-wrap"

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

HTML および PDF

メモ

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

スタイルシート定義スタイル名。文字ベクトルまたは string スカラーとして指定します。スタイル名は、この要素を追加するドキュメントまたはドキュメント パーツのスタイル シートで指定したスタイルの名前です。指定されたスタイルは、この要素の Style プロパティで指定された書式によってオーバーライドされない限り、出力ドキュメントでのこの要素の外観を定義します。スタイル シートの使用の詳細については、スタイル シートのスタイルの使用を参照してください。

メモ

Microsoft Word レポートでは、ドキュメント テンプレートで定義されていないスタイル名は無視されます。Microsoft Word テンプレートの詳細については、DOM API レポート プログラムのテンプレートを参照してください。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

このドキュメント要素オブジェクトの書式指定。DOM 書式オブジェクトの配列として指定します。このプロパティで指定された書式は、この要素の StyleName プロパティで指定された対応する書式をオーバーライドします。このドキュメント要素オブジェクトに適用されない書式は無視されます。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

このオブジェクトの親。ドキュメント要素オブジェクトとして指定します。ドキュメント要素の親は 1 つでなければなりません。

属性:

GetAccess
public
SetAccess
private
NonCopyable
true

このオブジェクトの子。ドキュメント要素オブジェクトの配列として指定します。このプロパティには、append メソッドを使用して追加されたドキュメント要素オブジェクトが含まれます。

属性:

GetAccess
public
SetAccess
private
NonCopyable
true

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

オブジェクト識別子。文字ベクトルまたは string スカラーとして指定します。DOM API は、ドキュメント要素オブジェクトの作成時にセッション固有識別子を生成します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

メソッド

すべて展開する

例

すべて折りたたむ

ライブ スクリプトを開く

この例では、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 で導入

参考

クラス

トピック