mlreportgen.dom.Preformatted クラス

名前空間: mlreportgen.dom
スーパークラス: mlreportgen.dom.Paragraph

書式設定済みのテキストブロック

説明

mlreportgen.dom.Preformatted クラスのオブジェクトを使用して、テキストの空白書式設定を保持します。空白書式設定では、スペース、改行、等幅フォントを使用してテキストを複数行にレンダリングし、インデントを制御します。たとえば、mlreportgen.dom.Preformatted オブジェクトを使用して、プログラムコードをレポートに追加します。

FontFamilyName プロパティまたは Whitespace プロパティを設定しなかった場合、DOM API によってレポートタイプ (HTML、Microsoft^® Word、または PDF) の既定値が使用され、空白書式設定が保持されます。FontFamilyName または Whitespace プロパティを設定して、既定値をオーバーライドすることができます。

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

クラス属性

`ConstructOnLoad`	`true`
`HandleCompatible`	`true`

クラス属性の詳細については、クラスの属性を参照してください。

作成

説明

preObj = mlreportgen.dom.Preformatted は、書式設定済みの空の段落を作成します。

例

preObj = mlreportgen.dom.Preformatted(text) は、指定されたテキストを含む書式設定済みの段落を作成します。

例

preObj = mlreportgen.dom.Preformatted(text,styleName) は、指定されたスタイルをもつ書式設定済みの段落を作成します。styleName プロパティで指定されたスタイルは、この段落が追加されるドキュメント要素に使用されるテンプレートで定義されていなければなりません。

preObj = mlreportgen.dom.Preformatted(docElementObj) は、docElementObj で指定されたドキュメント要素を含む段落を作成します。

入力引数

すべて展開する

`text` — 段落のテキスト
文字ベクトル | string スカラー

段落のテキスト。文字ベクトルまたは string スカラーとして指定します。

`styleName` — 段落のスタイル
文字ベクトル | string スカラー

この段落のスタイル。文字ベクトルまたは string スカラーとして指定します。スタイルは、この段落が追加されるドキュメントの作成に使用されるテンプレートで定義されていなければなりません。

`docElementObj` — 段落に含めるドキュメント要素
DOM オブジェクト

この段落に含めるドキュメント要素 (DOM オブジェクト)。以下の DOM オブジェクトを指定できます。

プロパティ

すべて展開する

`BackgroundColor` — 背景色
`[]` (既定値) | 文字ベクトル | 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

`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`

データ型: logical

`Color` — ドキュメント要素オブジェクトの色
`[]` (既定値) | 文字ベクトル | 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

`FirstLineIndent` — 段落の 1 行目のインデント量
`[]` | 文字ベクトル | string スカラー

この段落の 1 行目のインデント量 (数値とそれに続く測定単位の略語で構成される)。文字ベクトルまたは string スカラーとして指定します。たとえば、"0.5in" は 0.5 インチを指定します。有効な略語を以下に示します。

"px" — ピクセル
"cm" — センチメートル
"in" — インチ
"mm" — ミリメートル
"pc" — パイカ
"pt" — ポイント

インデント量とは、この段落の 1 行目を後続の行に対してインデントする量です。1 行目を除くすべての行がインデントされるぶら下げインデントを作成するには、負の数値を使用します。

メモ

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

例: "0.5in"

属性:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

データ型: char | string

`FontFamilyName` — テキストのフォントファミリの名前
`[]` | 文字ベクトル | 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

`FontSize` — ドキュメント要素のフォントサイズ
`[]` (既定値) | 文字ベクトル | 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

`HAlign` — 段落の水平方向の配置
`"center"` | `"distribute"` | ... | ...

ページの余白またはテーブルのセルの境界を基準にした、この段落の水平方向の配置。次の表のいずれかの値として指定します。

値	説明	サポートされる出力タイプ
`"center"`	段落を中央に配置します。	すべて
`"distribute"`	文字を均等割り付けします。	Word
`"justify"`	段落の左側をページの左側またはテーブルエントリの左側に配置し、段落の右側をページの右側またはテーブルエントリの右側に配置します。	すべて
`"KashidaHigh"`	幅の最も広いカシーダを使用します。カシーダは、アラビア語やペルシア語などのいくつかの筆記体に使用される行端揃えの一種です。	Word
`"KashidaLow"`	最も幅の狭いカシーダを使用します。	Word
`"KashidaMedium"`	中程度の幅のカシーダを使用します。	Word
`"left"`	段落を左揃えにします。	すべて
`"right"`	段落を右揃えにします。	すべて
`"ThaiDistribute"`	タイ語の行端揃えを設定します。	Word

メモ

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

属性:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

データ型: char | string

`OutlineLevel` — 段落のアウトラインレベル
`[]` (既定値) | 整数

段落のアウトラインレベル。整数として指定します。OutlineLevel プロパティを設定すると、この段落が目次などの自動生成されるアウトラインに含まれるようになります。値はアウトラインの段落のレベルを指定します。たとえば、段落をアウトラインの最上位に表示するには、OutlineLevel プロパティを 1 に設定します。

メモ

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

属性:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

データ型: int32

`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`

データ型: logical

`Strike` — テキストの取り消し線
`[]` (既定値) | `"none"` | `"single"` | `"double"`

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

"none" — 取り消し線なし
"single" — 一重線
"double" — 二重線 (Word レポートの場合のみ)

メモ

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

属性:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

データ型: char | string

`Underline` — 下線のタイプ
`[]` (既定値) | `"single"` | `"none"` | ...

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

下線の値	説明	サポートされる出力タイプ
`"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

`WhiteSpace` — テキスト内の空白の処理方法
`[]` (既定値) | `"normal"` | `"nowrap"` | ...

テキスト内の空白と改行の処理方法。次の表のいずれかの値として指定します。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

`StyleName` — スタイルシート定義スタイル名
`[]` (既定値) | 文字ベクトル | string スカラー

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

メモ

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

属性:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

データ型: char | string

`Style` — 書式指定
`{}` (既定値) | DOM 書式オブジェクトの配列

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

属性:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`CustomAttributes` — ドキュメント要素のカスタム属性
`[]` (既定値) | `mlreportgen.dom.CustomAttribute` オブジェクトの配列

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

属性:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`Parent` — このオブジェクトの親
ドキュメント要素オブジェクト

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

属性:

`GetAccess`	`public`
`SetAccess`	`private`
`NonCopyable`	`true`

`Children` — このオブジェクトの子
ドキュメント要素オブジェクトの配列

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

属性:

`GetAccess`	`public`
`SetAccess`	`private`
`NonCopyable`	`true`

`Tag` — タグ
文字ベクトル | string スカラー

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

属性:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

データ型: char | string

`Id` — オブジェクト識別子
文字ベクトル | string スカラー

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

属性:

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

データ型: char | string

メソッド

すべて展開する

パブリックメソッド

`append`	段落へのコンテンツの追加
`clone`	Copy paragraph object

例

すべて折りたたむ

レポート内のコードの書式設定

ライブスクリプトを開く

mlreportgen.dom.Preformatted オブジェクトを使用してレポート内のコードを書式設定します。空白と改行文字は出力で保持されます。コードのフォントは等幅です。

import mlreportgen.dom.*
import mlreportgen.report.*
rpt = Report('myReport','docx');

p = Paragraph("This is my code:");
pr = Preformatted("  a = 1;" + newline + "  b = 2;" + newline + "  c = a + b;");

add(rpt, p);
add(rpt,pr);

close(rpt);
rptview(rpt);

生成されたレポートにおいて、コードは次のようになります。

バージョン履歴

R2020a で導入

参考

mlreportgen.dom.Preformatted クラス

説明

クラス属性

作成

説明

入力引数

text — 段落のテキスト 文字ベクトル | string スカラー

styleName — 段落のスタイル 文字ベクトル | string スカラー

docElementObj — 段落に含めるドキュメント要素 DOM オブジェクト

プロパティ

BackgroundColor — 背景色 [] (既定値) | 文字ベクトル | string スカラー

属性:

Bold — ドキュメント要素に太字を使用するオプション [] (既定値) | true または 1 | false または 0

属性:

Color — ドキュメント要素オブジェクトの色 [] (既定値) | 文字ベクトル | string スカラー

属性:

FirstLineIndent — 段落の 1 行目のインデント量 [] | 文字ベクトル | string スカラー

属性:

FontFamilyName — テキストのフォント ファミリの名前 [] | 文字ベクトル | string スカラー

属性:

FontSize — ドキュメント要素のフォント サイズ [] (既定値) | 文字ベクトル | string スカラー

属性:

HAlign — 段落の水平方向の配置 "center" | "distribute" | ... | ...

属性:

OutlineLevel — 段落のアウトライン レベル [] (既定値) | 整数

属性:

Italic — ドキュメント要素にイタリックを使用するオプション [] (既定値) | true または 1 | false または 0

属性:

Strike — テキストの取り消し線 [] (既定値) | "none" | "single" | "double"

属性:

Underline — 下線のタイプ [] (既定値) | "single" | "none" | ...

属性:

WhiteSpace — テキスト内の空白の処理方法 [] (既定値) | "normal" | "nowrap" | ...

属性:

StyleName — スタイルシート定義スタイル名 [] (既定値) | 文字ベクトル | string スカラー

属性:

Style — 書式指定 {} (既定値) | DOM 書式オブジェクトの配列

属性:

CustomAttributes — ドキュメント要素のカスタム属性 [] (既定値) | mlreportgen.dom.CustomAttribute オブジェクトの配列

属性:

Parent — このオブジェクトの親 ドキュメント要素オブジェクト

属性:

Children — このオブジェクトの子 ドキュメント要素オブジェクトの配列

属性:

Tag — タグ 文字ベクトル | string スカラー

属性:

Id — オブジェクト識別子 文字ベクトル | string スカラー

属性:

メソッド

パブリック メソッド

例

レポート内のコードの書式設定

バージョン履歴

参考

トピック

`text` — 段落のテキスト
文字ベクトル | string スカラー

`styleName` — 段落のスタイル
文字ベクトル | string スカラー

`docElementObj` — 段落に含めるドキュメント要素
DOM オブジェクト

`BackgroundColor` — 背景色
`[]` (既定値) | 文字ベクトル | string スカラー

`Bold` — ドキュメント要素に太字を使用するオプション
`[]` (既定値) | `true` または `1` | `false` または `0`

`Color` — ドキュメント要素オブジェクトの色
`[]` (既定値) | 文字ベクトル | string スカラー

`FirstLineIndent` — 段落の 1 行目のインデント量
`[]` | 文字ベクトル | string スカラー

`FontFamilyName` — テキストのフォントファミリの名前
`[]` | 文字ベクトル | string スカラー

`FontSize` — ドキュメント要素のフォントサイズ
`[]` (既定値) | 文字ベクトル | string スカラー

`HAlign` — 段落の水平方向の配置
`"center"` | `"distribute"` | ... | ...

`OutlineLevel` — 段落のアウトラインレベル
`[]` (既定値) | 整数

`Italic` — ドキュメント要素にイタリックを使用するオプション
`[]` (既定値) | `true` または `1` | `false` または `0`

`Strike` — テキストの取り消し線
`[]` (既定値) | `"none"` | `"single"` | `"double"`

`Underline` — 下線のタイプ
`[]` (既定値) | `"single"` | `"none"` | ...

`WhiteSpace` — テキスト内の空白の処理方法
`[]` (既定値) | `"normal"` | `"nowrap"` | ...

`StyleName` — スタイルシート定義スタイル名
`[]` (既定値) | 文字ベクトル | string スカラー

`Style` — 書式指定
`{}` (既定値) | DOM 書式オブジェクトの配列

`CustomAttributes` — ドキュメント要素のカスタム属性
`[]` (既定値) | `mlreportgen.dom.CustomAttribute` オブジェクトの配列

`Parent` — このオブジェクトの親
ドキュメント要素オブジェクト

`Children` — このオブジェクトの子
ドキュメント要素オブジェクトの配列

`Tag` — タグ
文字ベクトル | string スカラー

`Id` — オブジェクト識別子
文字ベクトル | string スカラー

パブリックメソッド