このページの内容は最新ではありません。最新版の英語を参照するには、ここをクリックします。
mlreportgen.dom.Heading1 クラス
名前空間: mlreportgen.dom
スーパークラス: mlreportgen.dom.Heading
Heading1 段落の作成
作成
説明
入力引数
text
— 見出しのテキスト
文字ベクトル | string スカラー
見出しに使用するテキスト。文字ベクトルまたは string スカラーとして指定します。
データ型: char
| string
styleName
— テキストのスタイル
文字ベクトル | string スカラー
styleName
で指定するスタイルには、この見出しが追加されるドキュメントの作成に使用されるテンプレートで定義されている段落スタイルを指定しなければなりません。
データ型: char
| string
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 の色名または 16 進数の RGB 値で構成される背景色。文字ベクトルまたは string スカラーとして指定します。
CSS の色名のリストについては、https://www.w3.org/wiki/CSS/Properties/color/keywordsを参照してください。
16 進数の RGB 書式を指定するには、最初の文字として
#
を使用し、赤、緑、および青の値に 2 桁の 16 進数を使用します。たとえば、"#0000ff"
は青を指定します。
メモ
BackgroundColor
プロパティを設定すると、mlreportgen.dom.BackgroundColor
書式オブジェクトが Style
プロパティに追加されます。BackgroundColor
プロパティを空の値に設定すると、そのオブジェクトは削除されます。
例: "blue"
例: "#0000ff"
属性:
NonCopyable | true |
データ型: char
| string
Bold
— ドキュメント要素に太字を使用するオプション
[]
(既定値) | true
または 1
| false
または 0
このドキュメント要素に太字を使用するオプション。数値または logical の 1
(true
) または 0
(false
) として指定します。ドキュメント要素を太字にするには、Bold
を true
または 1
に設定します。
メモ
Bold
プロパティを設定すると、対応する mlreportgen.dom.Bold
書式オブジェクトが Style
プロパティに追加されます。Bold
プロパティを空の値に設定すると、そのオブジェクトは削除されます。
属性:
NonCopyable | true |
データ型: logical
Color
— ドキュメント要素の色
[]
(既定値) | 文字ベクトル | string スカラー
CSS の色名 (https://www.w3.org/wiki/CSS/Properties/color/keywordsを参照) または #RRGGBB
形式の 16 進数の RGB (トゥルーカラー) 値で構成されるドキュメント要素の色。文字ベクトルまたは string スカラーとして指定します。
メモ
Color
プロパティを設定すると、対応する mlreportgen.dom.Color
書式オブジェクトが Style
プロパティに追加されます。Color
プロパティを空の値に設定すると、そのオブジェクトは削除されます。
例: "blue"
例: "#0000ff"
属性:
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"
属性:
NonCopyable | true |
データ型: char
| string
FontFamilyName
— テキストのフォント ファミリの名前
[]
| 文字ベクトル | string スカラー
テキストに使用するフォント ファミリの名前。文字ベクトルまたは string スカラーとして指定します。フォントの代替を指定する場合は、このプロパティの設定によってフォント ファミリを指定しないでください。代わりに、mlreportgen.dom.FontFamily
オブジェクトを作成して Style
プロパティに追加します。
メモ
FontFamilyName
プロパティを設定すると、対応する mlreportgen.dom.FontFamily
書式オブジェクトが Style
プロパティに追加されます。FontFamilyName
プロパティを設定することは、mlreportgen.dom.FontFamily
オブジェクトの FontName
プロパティを設定することと同じです。FontFamilyName
プロパティを空の値に設定すると、そのオブジェクトは削除されます。
例: "Courier New"
属性:
NonCopyable | true |
データ型: char
| string
FontSize
— ドキュメント要素のフォント サイズ
[]
(既定値) | 文字ベクトル | string スカラー
ドキュメント要素に使用するフォント サイズ (数値とそれに続く測定単位の略語で構成される)。文字ベクトルまたは string スカラーとして指定します。たとえば、"12pt"
は 12 ポイントを指定します。有効な略語を以下に示します。
"px"
— ピクセル"cm"
— センチメートル"in"
— インチ"mm"
— ミリメートル"pc"
— パイカ"pt"
— ポイント
メモ
FontSize
プロパティを設定すると、対応する mlreportgen.dom.FontSize
書式オブジェクトが Style
プロパティに追加されます。FontSize
プロパティを空の値に設定すると、そのオブジェクトは削除されます。
例: "12pt"
属性:
NonCopyable | true |
データ型: char
| string
HAlign
— 段落の水平方向の配置
"center"
| "distribute"
| ... | ...
ページの余白またはテーブルのセルの境界を基準にした、この段落の水平方向の配置。次の表のいずれかの値として指定します。
値 | 説明 | サポートされる出力タイプ |
---|---|---|
| 段落を中央に配置します。 | すべて |
| 文字を均等割り付けします。 | Word |
| 段落の左側をページの左側またはテーブル エントリの左側に配置し、段落の右側をページの右側またはテーブル エントリの右側に配置します。 | すべて |
| 幅の最も広いカシーダを使用します。 カシーダは、アラビア語やペルシア語などのいくつかの筆記体に使用される行端揃えの一種です。 | Word |
| 最も幅の狭いカシーダを使用します。 | Word |
| 中程度の幅のカシーダを使用します。 | Word |
| 段落を左揃えにします。 | すべて |
| 段落を右揃えにします。 | すべて |
| タイ語の行端揃えを設定します。 | Word |
メモ
HAlign
プロパティを設定すると、対応する mlreportgen.dom.HAlign
書式オブジェクトが、このドキュメント要素の Style
プロパティに追加されます。HAlign
プロパティを空の値に設定すると、そのオブジェクトは削除されます。
属性:
NonCopyable | true |
データ型: char
| string
Italic
— ドキュメント要素にイタリックを使用するオプション
[]
(既定値) | true
または 1
| false
または 0
ドキュメント要素にイタリックを使用するオプション。数値または logical の 1
(true
) または 0
(false
) として指定します。ドキュメント要素をイタリックにするには、Italic
を true
または 1
に設定します。
メモ
Italic
プロパティを設定すると、対応する mlreportgen.dom.Italic
書式オブジェクトが Style
プロパティに追加されます。Italic
プロパティを空の値に設定すると、そのオブジェクトは削除されます。
属性:
NonCopyable | true |
データ型: logical
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
プロパティに追加します。
属性:
NonCopyable | true |
データ型: char
| string
OutlineLevel
— 段落のアウトライン レベル
[]
(既定値) | 整数
段落のアウトライン レベル。整数として指定します。OutlineLevel
プロパティを設定すると、この段落が目次などの自動生成されるアウトラインに含まれるようになります。値はアウトラインの段落のレベルを指定します。たとえば、段落をアウトラインの最上位に表示するには、OutlineLevel
プロパティを 1
に設定します。
メモ
OutlineLevel
プロパティを設定すると、対応する mlreportgen.dom.OutlineLevel
書式オブジェクトが Style
プロパティに追加されます。OutlineLevel
プロパティを空の値に設定すると、そのオブジェクトは削除されます。
属性:
NonCopyable | true |
データ型: int32
Strike
— テキストの取り消し線
[]
(既定値) | "none"
| "single"
| "double"
テキストの取り消し線。次のいずれかの値として指定します。
"none"
— 取り消し線なし"single"
— 一重線"double"
— 二重線 (Word レポートの場合のみ)
メモ
Strike
プロパティを設定すると、対応する mlreportgen.dom.Strike
書式オブジェクトが、このドキュメント要素の Style
プロパティに追加されます。Strike
プロパティを空の値に設定すると、そのオブジェクトは削除されます。
属性:
NonCopyable | true |
データ型: char
| string
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
プロパティを設定すると、対応する mlreportgen.dom.Underline
書式オブジェクトが Style
プロパティに追加されます。Underline
プロパティを空の値に設定すると、そのオブジェクトは削除されます。
属性:
NonCopyable | true |
データ型: char
| string
WhiteSpace
— テキスト内の空白の処理方法
[]
(既定値) | "normal"
| "nowrap"
| ...
テキスト内の空白と改行の処理方法。次の表のいずれかの値として指定します。
値 | 説明 | サポートされる出力タイプ |
---|---|---|
| HTML や PDF の場合、この値を設定すると、テキストの最初と最後のスペースが削除されます。テキスト内の複数のスペースは単一のスペースに折りたたまれます。 Microsoft Word の場合、この値を設定すると、テキストの最初と最後のスペースが削除されます。 | すべて |
| 連続する空白は単一の空白に折りたたまれます。テキストが次の行に折り返されることはありません。 | HTML |
| 空白を維持します。テキストは改行でのみ折り返されます。HTML の | HTML および PDF |
| "pre" と同様です。 | すべて |
| 連続する空白は単一の空白に折りたたまれます。テキストは必要に応じて、また改行で折り返されます。 | HTML および PDF |
| 空白を維持します。テキストは必要に応じて、また改行で折り返されます。 | HTML および PDF |
メモ
WhiteSpace
プロパティを設定すると、対応する mlreportgen.dom.WhiteSpace
書式オブジェクトが Style
プロパティに追加されます。WhiteSpace
プロパティを空の値に設定すると、そのオブジェクトは削除されます。
データ型: char
| string
StyleName
— 要素のスタイルシート定義スタイル名
[]
(既定値) | 文字ベクトル | string スカラー
スタイル名。文字ベクトルまたは string スカラーとして指定します。スタイル名は、この要素を追加するドキュメントまたはドキュメント パーツのスタイル シートで指定したスタイルの名前です。指定されたスタイルは、この要素の Style
プロパティで指定された書式によってオーバーライドされない限り、出力ドキュメントでのこの要素の外観を定義します。スタイル シートの使用の詳細については、スタイル シートのスタイルの使用を参照してください。
メモ
Microsoft Word 出力ではスタイル名が無視されます。
属性:
NonCopyable | true |
データ型: char
| string
Style
— 書式指定
{}
(既定値) | 書式オブジェクトの配列
このドキュメント要素オブジェクトの書式指定。書式オブジェクトの配列として指定します。このプロパティで指定された書式は、この要素の StyleName
プロパティで指定された対応する書式をオーバーライドします。この要素に適用されない書式は無視されます。
属性:
NonCopyable | true |
データ型: cell
CustomAttributes
— ドキュメント要素のカスタム属性
[]
(既定値) | mlreportgen.dom.CustomAttribute
オブジェクトの配列
このドキュメント要素のカスタム属性。mlreportgen.dom.CustomAttribute
オブジェクトの配列として指定します。カスタム属性は、このオブジェクトが追加されるドキュメント要素の出力形式でサポートされていなければなりません。
属性:
NonCopyable | true |
Parent
— mlreportgen.dom.Heading1
オブジェクトの親
ドキュメント要素オブジェクト
mlreportgen.dom.Heading1
オブジェクトの親。ドキュメント要素オブジェクトとして指定します。ドキュメント要素の親は 1 つでなければなりません。
属性:
SetAccess | private |
NonCopyable | true |
Children
— mlreportgen.dom.Heading1
オブジェクトの子
ドキュメント要素オブジェクトの配列
mlreportgen.dom.Heading1
オブジェクトの子。ドキュメント要素オブジェクトの配列として指定します。このプロパティには、append
メソッドを使用して追加されたドキュメント要素オブジェクトが含まれます。
属性:
SetAccess | private |
NonCopyable | true |
Tag
— mlreportgen.dom.Heading1
オブジェクトのタグ
文字ベクトル | string スカラー
mlreportgen.dom.Heading1
オブジェクトのタグ。文字ベクトルまたは string スカラーとして指定します。DOM API は、このオブジェクトを作成するときに、セッション固有タグを生成します。生成されるタグの形式は CLASS:ID
という形式です。ここで、CLASS
はオブジェクト クラスです。ID
はオブジェクトの Id
プロパティの値です。独自のタグ値を指定すると、ドキュメント生成中に問題が発生したときにどこを確認すればよいかを特定しやすくなります。
属性:
NonCopyable | true |
データ型: char
| string
Id
— mlreportgen.dom.Heading1
オブジェクトの識別子
文字ベクトル | string スカラー
mlreportgen.dom.Heading1
オブジェクトのオブジェクト識別子。文字ベクトルまたは string スカラーとして指定します。DOM API は、ドキュメント要素オブジェクトの作成時にセッション固有識別子を生成します。Id
には独自の値を指定できます。
属性:
NonCopyable | true |
データ型: char
| string
メソッド
例
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 で導入
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)