Main Content

mlreportgen.dom.Heading クラス

パッケージ: mlreportgen.dom
スーパークラス: mlreportgen.dom.Paragraph

可変レベルを使用した見出し段落

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

説明

特定のレベルの見出し段落またはレポート生成時にレベルが計算される見出し段落を作成します。

ヒント

実行時に見出しレベルを決定する必要がある場合は、このクラスを使用します。それ以外の場合は、レベルを明示的に設定しなくてもよいように、Heading1、Heading2 などのクラスを使用できます。

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

作成

説明

headingObj = Heading(level) は、指定されたレベルで空の見出しを作成します。

headingObj = Heading(level,text) は、指定されたテキストを含む指定されたレベルの見出しを作成します。

headingObj = Heading(level,text,styleName) は、指定されたテキストを含む指定されたレベルの見出しを、指定されたスタイルを使用して作成します。

headingObj = Heading(level,domObj) は、指定された DOM オブジェクトを含む指定されたレベルの見出しを作成します。

入力引数

すべて展開する

見出しレベル。数値または変数として指定します。レポート生成時に計算された値を使用してレベル番号を決定するには、変数を使用します。

データ型: double

見出しに使用するテキスト。文字ベクトルとして指定します。

styleName で指定するスタイルには、この見出しが追加されるドキュメントの作成に使用されるテンプレートで定義されている段落スタイルを指定しなければなりません。

見出しに含める DOM オブジェクト。次のいずれかのタイプの DOM オブジェクトとして指定します。

  • ExternalLink

  • Image

  • InternalLink

  • LinkTarget

  • Text

プロパティ

すべて展開する

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

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

例: 'blue'

例: '#0000ff'

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

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

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

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

例: 'blue'

例: '#0000ff'

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

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

  • px — ピクセル (既定)

  • cm — センチメートル

  • in — インチ

  • mm — ミリメートル

  • pc — パイカ

  • pt — ポイント

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

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

例: '0.5in'

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

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

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

例: 'Courier New'

テキストのフォント サイズ。valueUnits 形式。ここで、Units は単位の略語です。単位には、次のいずれかの略語を使用します。

  • px — ピクセル (既定)

  • cm — センチメートル

  • in — インチ

  • mm — ミリメートル

  • pc — パイカ

  • pt — ポイント

  • px — ピクセル

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

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

'center'

段落を中央に配置します。

すべて

'distribute'

文字を均等割り付けします。

Word

'justify'

段落の左側をページの左側またはテーブル エントリの左側に配置し、段落の右側をページの右側またはテーブル エントリの右側に配置します。

すべて

'KashidaHigh'

幅の最も広いカシーダを使用します。

カシーダは、アラビア語やペルシア語などのいくつかの筆記体に使用される行端揃えの一種です。

Word

'KashidaLow'

最も幅の狭いカシーダを使用します。

Word

'KashidaMedium'

中程度の幅のカシーダを使用します。

Word

'left'

段落を左揃えにします。

すべて

'right'

段落を右揃えにします。

すべて

'ThaiDistribute'

タイ語の行端揃えを設定します。

Word

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

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

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

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

valueUnits 形式の左インデント。Units は単位の略語です。有効な略語を以下に示します。

  • px — ピクセル (既定)

  • cm — センチメートル

  • in — インチ

  • mm — ミリメートル

  • pc — パイカ

  • pt — ポイント

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

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

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

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

  • 'single' — 一重線

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

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

テキストの書式を指定する mlreportgen.dom.DOCXSection オブジェクトの配列。

styleName で指定するスタイルは、このテキストを追加するドキュメント要素の作成に使用されるテンプレートで定義されていなければなりません。

データ型: char

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

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

属性:

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 プロパティを空の値に設定すると、そのオブジェクトは削除されます。

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

テキスト内の空白の処理方法。次の表のいずれかの値として指定します。

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

'normal'

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

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

すべて

'nowrap'

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

HTML

'pre'

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

HTML および PDF

'pre-line'

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

HTML および PDF

'pre-wrap'

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

HTML および PDF

'preserve'

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

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

メソッド

すべて展開する

バージョン履歴

R2014b で導入

参考

|