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
,styleName
)StyleName
プロパティを styleName
に設定します。スタイルは、この Text
オブジェクトを追加するドキュメントのテンプレートのスタイル シートで定義しなければなりません。
プロパティ
Content
— このドキュメント要素に含まれるテキスト
文字ベクトル | string スカラー
このドキュメント要素に含まれるテキスト。文字ベクトルとして指定します。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
Bold
— テキストに太字を使用するかどうか
[]
(既定値) | true
または 1
| false
または 0
テキストに太字を使用するかどうか。数値または logical の 1
(true
) または 0
(false
) として指定します。テキストを太字にするには、Bold
を true
または 1
に設定します。
Bold
プロパティを設定すると、対応する mlreportgen.dom.Bold
書式オブジェクトが Style
プロパティに追加されます。Bold
プロパティを空の値に設定すると、そのオブジェクトは削除されます。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
Italic
— テキストにイタリックを使用するかどうか
[]
(既定値) | true
または 1
| false
または 0
テキストにイタリックを使用するかどうか。数値または logical の 1
(true
) または 0
(false
) として指定します。テキストをイタリックにするには、Italic
を true
または 1
に設定します。
Italic
プロパティを設定すると、対応する mlreportgen.dom.Italic
書式オブジェクトが Style
プロパティに追加されます。Italic
プロパティを空の値に設定すると、そのオブジェクトは削除されます。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
Color
— テキストの色
[]
(既定値) | 文字ベクトル | string スカラー
テキストの色。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 |
BackgroundColor
— 背景色
[]
(既定値) | 文字ベクトル | string スカラー
背景色。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 |
Underline
— 下線のタイプ
[]
(既定値) | "single"
| "none"
| ...
下線のタイプ。次の表のいずれかの値として指定します。
下線の値 | 説明 | サポートされる出力タイプ |
---|---|---|
| 一重線 | すべて |
| スペースを除くすべての文字に下線を引く | Word |
| 二重線 | Word |
| 太い線 | Word |
| 点線 | Word |
| 太い点線 | Word |
| 破線 | Word |
| 太い破線で構成される線 | Word |
| 長い破線で構成される線 | Word |
| 太くて長い破線で構成される線 | Word |
| 一点鎖線 | Word |
| 太い一点鎖線 | Word |
| 二点鎖線 | Word |
| 太い破線かつ破線の間に 2 つの点がある線 | Word |
| 波線 | Word |
| 太い波線 | Word |
| 二重波線 | Word |
| 下線なし | すべて |
Underline
プロパティを設定すると、対応する mlreportgen.dom.Underline
書式オブジェクトが Style
プロパティに追加されます。Underline
プロパティを空の値に設定すると、そのオブジェクトは削除されます。
下線の色とタイプの両方を指定する場合は、Underline
プロパティを設定しないでください。代わりに、下線のタイプと色を指定する mlreportgen.dom.Underline
書式オブジェクトを含めるように Style
プロパティを設定します。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
WhiteSpace
— テキスト内の空白と改行
[]
(既定値) | "normal"
| "nowrap"
| ...
テキストで使用する空白と改行のタイプ。次の表にあるいずれかの値として指定します。Document
オブジェクトの Type
プロパティが PDF の場合、WhiteSpace
プロパティは適用されません。
値 | 説明 | サポートされる出力タイプ |
---|---|---|
| 空白と改行は維持されません。 | Word および HTML |
| 連続する空白は単一の空白に折りたたまれます。テキストが次の行に折り返されることはありません。 | HTML |
| 空白を維持します。テキストは必要に応じて、また改行で折り返されます。HTML の | Word および HTML |
| 空白を維持します。テキストは改行でのみ折り返されます。HTML の | HTML |
| 連続する空白は単一の空白に折りたたまれます。テキストは折り返されます。 | HTML |
| 空白を維持します。テキストは必要に応じて、また改行で折り返されます。 | HTML |
MATLAB® ブラウザーで HTML 出力を表示し、空白を維持して改行でのみテキストを折り返す場合は、pre
設定の代わりに preserve
設定を使用します。
WhiteSpace
プロパティを設定すると、対応する WhiteSpace
書式オブジェクトが Style
プロパティに追加されます。WhiteSpace
プロパティ設定を削除すると、WhiteSpace
オブジェクトは削除されます。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
FontFamilyName
— テキストのフォント ファミリの名前
[]
| 文字ベクトル | string スカラー
テキストに使用するフォント ファミリの名前。文字ベクトルまたは string スカラーとして指定します。
FontFamilyName
プロパティを設定すると、対応する mlreportgen.dom.FontFamily
書式オブジェクトが Style
プロパティに追加されます。FontFamilyName
プロパティを設定することは、mlreportgen.dom.FontFamily
オブジェクトの FontName
プロパティを設定することと同じです。FontFamilyName
プロパティを空の値に設定すると、そのオブジェクトは削除されます。
フォントの代替を指定する場合は、このプロパティの設定によってフォント ファミリを指定しないでください。代わりに、mlreportgen.dom.FontFamily
オブジェクトを作成して Style
プロパティに追加します。
例: "Courier New"
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
FontSize
— テキストのフォント サイズ
[]
(既定値) | 文字ベクトル | string スカラー
テキストに使用するフォント サイズ。数値とそれに続く測定単位の略語で構成される文字ベクトルまたは string スカラーとして指定します。たとえば、'12pt'
は 12 ポイントを指定します。有効な略語を以下に示します。
px
— ピクセル (既定)cm
— センチメートルin
— インチmm
— ミリメートルpc
— パイカpt
— ポイント
FontSize
プロパティを設定すると、対応する mlreportgen.dom.FontSize
書式オブジェクトが Style
プロパティに追加されます。FontSize
プロパティを空の値に設定すると、そのオブジェクトは削除されます。
例: "12pt"
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
Strike
— テキストの取り消し線
[]
(既定値) | "none"
| "single"
| "double"
テキストの取り消し線。次のいずれかの値として指定します。
"none"
— 取り消し線なし"single"
— 一重線"double"
— 二重線 (Word レポートの場合のみ)
Strike
プロパティを設定すると、対応する mlreportgen.dom.Strike
書式オブジェクトが、このドキュメント要素の Style
プロパティに追加されます。Strike
プロパティを空の値に設定すると、そのオブジェクトは削除されます。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
StyleName
— テキストのスタイル
文字ベクトル | string スカラー
スタイルは、この Text
オブジェクトを追加するドキュメントのテンプレートのスタイルシートで定義しなければなりません。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
Style
— テキストの書式設定
DOM 書式オブジェクトの cell 配列
テキストの書式設定。DOM 書式オブジェクトの cell 配列として指定します。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
CustomAttributes
— ドキュメント要素のカスタム属性
mlreportgen.dom.CustomAttribute
オブジェクトの配列
このドキュメント要素のカスタム属性。mlreportgen.dom.CustomAttribute
オブジェクトの配列として指定します。カスタム属性は、この Text
オブジェクトが追加される Document
オブジェクトの出力形式でサポートされていなければなりません。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
Parent
— この DOM API オブジェクトの親
DOM API オブジェクト
この DOM API オブジェクトの親。DOM API オブジェクトとして指定します。
属性:
GetAccess | public |
SetAccess | private |
NonCopyable | true |
Children
— この DOM API オブジェクトの子
DOM API オブジェクトの配列
この DOM API オブジェクトの子。DOM API オブジェクトの配列として指定します。
属性:
GetAccess | public |
SetAccess | private |
NonCopyable | true |
Tag
— この DOM API オブジェクトのタグ
文字ベクトル | string スカラー
この DOM API オブジェクトのタグ。文字ベクトルまたは string スカラーとして指定します。
DOM は、このオブジェクトを作成するときに、セッション固有タグを生成します。生成されたタグの形式は CLASS:ID という形式です。ここで、CLASS はオブジェクト クラスです。ID はオブジェクトの Id
プロパティの値です。独自のタグ値を指定すると、ドキュメントの生成中に問題が発生した箇所を容易に特定できるようになります。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
Id
— この DOM API オブジェクトの ID
文字ベクトル | string スカラー
この DOM API オブジェクトの ID。文字ベクトルまたは string スカラーとして指定します。ドキュメント要素を作成するときに、DOM によってセッション固有 ID が生成されます。独自の ID を指定できます。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
メソッド
例
個別の Text オブジェクトを使用した段落テキストの書式設定
この例では、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 で導入
MATLAB コマンド
次の MATLAB コマンドに対応するリンクがクリックされました。
コマンドを MATLAB コマンド ウィンドウに入力して実行してください。Web ブラウザーは MATLAB コマンドをサポートしていません。
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)