mlreportgen.dom.Paragraph クラス

名前空間: mlreportgen.dom

書式設定されたテキスト ブロック

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

説明

mlreportgen.dom.Paragraph クラスのオブジェクトを使用して、段落を定義します。イメージなどのドキュメント要素を段落に追加できます。

mlreportgen.dom.Paragraph オブジェクトを追加できる DOM オブジェクトを確認するには、mlreportgen.dom.Paragraph オブジェクトを DOM クラス オブジェクトに追加を参照してください。

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

クラス属性

ConstructOnLoad
true
HandleCompatible
true

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

作成

説明

paragraphObj = mlreportgen.dom.Paragraph は、空の段落を作成します。

paragraphObj = mlreportgen.dom.Paragraph(text) は、指定のないテキストを含む段落を作成します。

例

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

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

入力引数

すべて展開する

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

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

プロパティ

すべて展開する

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

形式値
CSS の色名CSS の色名を指定します。CSS の色名のリストについては、https://www.w3.org/wiki/CSS/Properties/color/keywords を参照してください。
16 進数の RGB 値"#RRGGBB" の形式を使用します。最初の文字として # を使用し、赤、緑、および青の値に 2 桁の 16 進数を使用します。大文字と小文字のいずれも使用できます。
10 進数の RGB カラー値"rgb(r,g,b)" 形式を使用します。r、g、b は、それぞれ赤、緑、青の値を指定する正の整数で、コンマで区切ります。各値の範囲は 0 と 255 の範囲内でなければなりません。

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

例: "red" は、CSS の色名を使用して赤色を指定します。

例: "#0000ff" は、16 進数の RGB 値を使用して青色を指定します。

例: "rgb(128,0,128)" は、10 進数の RGB カラー値を使用して紫色を指定します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

このドキュメント要素に太字を使用するかどうか。logical の 1 (true) または 0 (false) として指定します。指定内容は以下のとおりです。

  • 1 (true) — ドキュメント要素を太字でレンダリングする。

  • 0 (false) — ドキュメント要素を標準的な太さでレンダリングする。

メモ

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: logical

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

形式値
CSS の色名CSS の色名を指定します。CSS の色名のリストについては、https://www.w3.org/wiki/CSS/Properties/color/keywords を参照してください。
16 進数の RGB 値"#RRGGBB" の形式を使用します。最初の文字として # を使用し、赤、緑、および青の値に 2 桁の 16 進数を使用します。大文字と小文字のいずれも使用できます。
10 進数の RGB カラー値"rgb(r,g,b)" 形式を使用します。r、g、b は、それぞれ赤、緑、青の値を指定する正の整数で、コンマで区切ります。各値の範囲は 0 と 255 の範囲内でなければなりません。

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

例: "red" は、CSS の色名を使用して赤色を指定します。

例: "#0000ff" は、16 進数の RGB 値を使用して青色を指定します。

例: "rgb(128,0,128)" は、10 進数の RGB カラー値を使用して紫色を指定します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

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

  • "px" — ピクセル

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

  • "in" — インチ

  • "mm" — ミリメートル

  • "pc" — パイカ

  • "pt" — ポイント

単位を省略することで、ピクセルとして指定することもできます。たとえば、"5" は 5 ピクセルを指定します。

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

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

例: "0.5in"

属性:

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

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

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

"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

ドキュメント要素にイタリックを使用するかどうか。logical の 1 (true) または 0 (false) として指定します。指定内容は以下のとおりです。

  • 1 (true) — ドキュメント要素をイタリックでレンダリングする。

  • 0 (false) — ドキュメント要素を直立体のテキストでレンダリングする。

メモ

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: logical

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

  • "px" — ピクセル

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

  • "in" — インチ

  • "mm" — ミリメートル

  • "pc" — パイカ

  • "pt" — ポイント

単位を省略することで、ピクセルとして指定することもできます。たとえば、"5" は 5 ピクセルを指定します。

左インデントは、この段落の左外側の境界とそのコンテナーの左内側の境界の間のスペースです。これは、Microsoft® Word の段落の左インデント プロパティに相当します。

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

ヒント

ページの左余白と右余白の両方から段落をインデントする場合は、このプロパティを設定しないでください。代わりに、左右のインデントを指定する mlreportgen.dom.OuterMargin を作成し、そのオブジェクトをこの段落の Style プロパティに追加します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

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

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: int32

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

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: cell

ドキュメント要素のカスタム属性。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

メソッド

すべて展開する

例

すべて折りたたむ

ライブ スクリプトを開く

テキストをもつ段落と外部リンクをもつ別の段落を追加します。 

import mlreportgen.dom.*
doc = Document("mydoc","html");

p1 = Paragraph("This will be bold text");
p1.Bold = true;
link = ExternalLink("https://www.mathworks.com/", "MathWorks");
p2 = Paragraph(link);
p2.BackgroundColor = "yellow";
append(doc,p1);
append(doc,p2);

close(doc);
rptview(doc);
ライブ スクリプトを開く
import mlreportgen.dom.*;
d = Document('mydoc','html');

para = Paragraph('Results: ');
append(d,para);
append(para,'Study 1');

close(d);
rptview(d.OutputPath);
import mlreportgen.dom.*;
doc = Document("mydoc","docx");

para = Paragraph("Results: ","Title");
para.WhiteSpace = "pre";
append(doc,para);
append(para,"Study 2");

close(doc);
rptview("mydoc","docx");
ライブ スクリプトを開く
import mlreportgen.dom.*;
docLink = Document('mydocLink','html');

mathWorksLink = ExternalLink...
   ('https://www.mathworks.com/','MathWorks site');
para = Paragraph('Go to the ');
append(para, mathWorksLink);
append(docLink,para);

close(docLink);
rptview(docLink.OutputPath);
ライブ スクリプトを開く
import mlreportgen.dom.*;
d = Document('myDoc','html');

para1 = Paragraph('This is a paragraph');
para1.Bold = true;
append(d,para1);
para1Copy = clone(para1);
para1Copy
para1Copy = 
  Paragraph with properties:

        OutlineLevel: []
                Bold: 1
              Italic: []
               Color: []
     BackgroundColor: []
           Underline: []
          WhiteSpace: []
      FontFamilyName: []
            FontSize: []
              Strike: []
              HAlign: []
     OuterLeftMargin: []
     FirstLineIndent: []
           StyleName: []
               Style: {[1×1 mlreportgen.dom.Bold]}
    CustomAttributes: []
              Parent: []
            Children: [1×1 mlreportgen.dom.Text]
                 Tag: 'dom.Paragraph:617'
                  Id: '617'

詳細

すべて展開する

バージョン履歴

R2014b で導入

参考

| | | | | | | | | | | | |

トピック