このページの翻訳は最新ではありません。ここをクリックして、英語の最新版を参照してください。

mlreportgen.dom.Heading3 クラス

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

Heading3 段落の作成

説明

mlreportgen.dom.Heading3 段落オブジェクトを作成します。

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

作成

説明

headingObj = Heading3() は、空の Heading3 オブジェクトを作成します。

headingObj = Heading3(text) は、指定されたテキストを含む見出しを作成します。

headingObj = Heading3(text,styleName) は、指定されたスタイルを使用する見出しを作成します。

headingObj = Heading3(domObj) は、指定された DOM オブジェクトを含む見出しを作成します。

入力引数

text — 見出しのテキスト

文字ベクトル

見出しのテキスト。文字ベクトルとして指定します。

styleName — 見出しのスタイル

文字ベクトル

スタイル名。文字ベクトルとして指定します。スタイルは、この見出しを含むドキュメントの作成に使用されるテンプレートで定義されていなければなりません。

domObj — 見出しに含める DOM オブジェクト

mlreportgen.dom.ExternalLink オブジェクト | mlreportgen.dom.Image オブジェクト | mlreportgen.dom.InternalLink オブジェクト | mlreportgen.dom.LinkTarget オブジェクト | mlreportgen.dom.Text オブジェクト

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

• ExternalLink

• Image

• InternalLink

• LinkTarget

• Text

プロパティ

BackgroundColor — 背景色

[] (既定値) | 文字ベクトル | string スカラー

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

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

例: 'blue'

例: '#0000ff'

Bold — テキストに太字を使用するかどうか

[] (既定値) | true または 1 | false または 0

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

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

Children — ドキュメント要素の子

DOM オブジェクトの配列

このドキュメント要素の子。DOM オブジェクトの配列として指定します。このプロパティは読み取り専用です。

Color — テキストの色

[] (既定値) | 文字ベクトル | string スカラー

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

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

例: 'blue'

例: '#0000ff'

CustomAttributes — この要素のカスタム属性

mlreportgen.dom.CustomAttribute オブジェクトの配列

この要素のカスタム属性。mlreportgen.dom.CustomAttribute オブジェクトの配列として指定します。出力形式でサポートされているカスタム属性を使用します。

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'

FontFamilyName — テキストのフォント ファミリの名前

[] | 文字ベクトル | string スカラー

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

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

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

例: 'Courier New'

FontSize — テキストのフォント サイズ

[] (既定値) | 文字ベクトル | string スカラー

テキストに使用するフォント サイズ。数値とそれに続く測定単位の略語で構成される文字ベクトルまたは string スカラーとして指定します。たとえば、'12pt' は 12 ポイントを指定します。有効な略語を以下に示します。

• px — ピクセル (既定)

• cm — センチメートル

• in — インチ

• mm — ミリメートル

• pc — パイカ

• pt — ポイント

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

例: '12pt'

Id — このドキュメント要素の ID

文字ベクトル | string スカラー

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

属性:

GetAccess	public
SetAccess	public
NonCopyable	true

データ型: char | string

Italic — テキストにイタリックを使用するかどうか

[] (既定値) | true または 1 | false または 0

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

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

OuterLeftMargin — 段落の左インデント

[] | 文字ベクトル | string スカラー

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

• px — ピクセル (既定)

• cm — センチメートル

• in — インチ

• mm — ミリメートル

• pc — パイカ

• pt — ポイント

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

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

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

OutlineLevel — 段落のアウトライン レベル

[] (既定値) | 整数

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

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

Parent — ドキュメント要素の親

DOM オブジェクト

このドキュメント要素の親。DOM オブジェクトとして指定します。このプロパティは読み取り専用です。

属性:

GetAccess	public
SetAccess	private
NonCopyable	true

Strike — テキストの取り消し線

[] (既定値) | 'none' | 'single' | 'double'

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

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

• 'single' — 一重線

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

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

Style — 書式指定

書式オブジェクトの配列

ドキュメント要素の書式を指定する書式オブジェクト。

StyleName — スタイル シートから適用するスタイル

文字ベクトル

スタイル シートから適用するスタイルの名前。文字ベクトルとして指定します。

Tag — このドキュメント要素のタグ

文字ベクトル | string スカラー

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

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

属性:

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

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

WhiteSpace — テキスト内の空白の処理方法

[] (既定値) | 'normal' | 'nowrap' | ...

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

値	説明	サポートされる出力タイプ
'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 プロパティを空の値に設定すると、そのオブジェクトは削除されます。

メソッド

パブリック メソッド

メソッド	目的
append Heading3.append は Paragraph.append と同じように使用します。	見出しへのコンテンツの追加。
clone Heading3.clone は Paragraph.clone と同じように使用します。	見出しのコピー。

例

3 つのレベルの見出しの作成

この例では、レベルに応じてそれぞれ書式設定された 3 つのレベルの見出しを追加する方法を示します。この例では、3 つの見出しオブジェクト (Heading1、Heading2、および Heading3) をドキュメントに挿入します。

import mlreportgen.dom.*;
d = Document('mydoc','docx');
open(d);

title = append(d, Paragraph('Document Title'));
title.Bold = true;
title.FontSize = '28pt';

h1 = append(d,Heading1('Chapter 1'));
h1.Style = {PageBreakBefore(true)};
p1 = append(d,Paragraph('Hello World'));

h2 = append(d,Heading2('Section 1.1'));
p2 = append(d,Paragraph('Text for this section.'));

h3 = append(d,Heading3('My Subsection 1.1.a'));
p3 = append(d,Paragraph('Text for this subsection'));

close(d);
rptview(d.OutputPath);

バージョン履歴

R2016a で導入

参考

mlreportgen.dom.Paragraph | mlreportgen.dom.Heading | mlreportgen.dom.Heading1 | mlreportgen.dom.Heading2 | mlreportgen.dom.Heading4 | mlreportgen.dom.Heading5 | mlreportgen.dom.Heading6

トピック

• レポートの書式設定方法

×

例を開く

この例の変更されたバージョンがあります。編集された方の例を開きますか?

いいえ、変更されたバージョンを上書きします。 はい