このページの内容は最新ではありません。最新版の英語を参照するには、ここをクリックします。
mlreportgen.dom.AutoNumber クラス
名前空間: mlreportgen.dom
自動生成番号
作成
説明
入力引数
stream
— 番号生成用の番号付けストリーム
文字ベクトル
mlreportgen.dom.AutoNumberStream
オブジェクトの StreamName
プロパティの値を使用して、番号付けストリームを指定します。
指定されたストリームが存在しない場合、DOM インターフェイスは、指定された名前と初期値 0 をもつアラビア数字ストリームを作成します。ローマ数字などの他のプロパティをもつストリームを使用するには、mlreportgen.dom.Document.createAutoNumberStream
を使用してストリームを作成します。
styleName
— テンプレートで定義された番号スタイルの名前
文字ベクトル
テンプレートで定義された番号スタイルの名前。文字ベクトルとして指定します。styleName
で指定するスタイルは、番号が追加されるドキュメントの作成に使用されるテンプレートで定義されていなければなりません。
プロパティ
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
— 番号に太字を使用するオプション
[]
(既定値) | logical 値
テキストを太字にするには、このプロパティを true
または 1
に設定します。このプロパティが空で、このドキュメント要素の StyleName
プロパティがスタイル シート スタイルを指定している場合、そのスタイルによって番号の太さが決定されます。Bold
プロパティを設定すると、対応する mlreportGen.dom.Bold
書式オブジェクトがこのドキュメント要素の Style
プロパティに追加されます。Bold
プロパティ設定を削除すると、そのオブジェクトは削除されます。
データ型: 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'
CustomAttributes
— ドキュメント要素のカスタム属性
mlreportgen.dom.CustomAttribute
オブジェクトの配列
このドキュメント要素のカスタム属性。mlreportgen.dom.CustomAttribute
オブジェクトの配列として指定します。カスタム属性は、出力形式でサポートされていなければなりません。
FontFamilyName
— テキストのフォント ファミリの名前
[]
| 文字ベクトル | string スカラー
テキストに使用するフォント ファミリの名前。文字ベクトルまたは string スカラーとして指定します。
FontFamilyName
プロパティを設定すると、対応する mlreportgen.dom.FontFamily
書式オブジェクトが Style
プロパティに追加されます。FontFamilyName
プロパティを設定することは、mlreportgen.dom.FontFamily
オブジェクトの FontName
プロパティを設定することと同じです。FontFamilyName
プロパティを空の値に設定すると、そのオブジェクトは削除されます。
フォントの代替を指定する場合は、このプロパティの設定によってフォント ファミリを指定しないでください。代わりに、mlreportgen.dom.FontFamily
オブジェクトを作成して Style
プロパティに追加します。
例: 'Courier New'
FontSize
— フォント サイズ
文字ベクトル
このフォントの代替を指定する必要がある場合は、このプロパティを設定しないでください。代わりに、mlreportgen.dom.FontFamily
オブジェクトを作成して、このドキュメント要素の Style
プロパティに追加します。
FontSize
プロパティを設定すると、対応する mlreportGen.dom.FontSize
書式オブジェクトが、このドキュメント要素の Style
プロパティに追加されます。FontSize
プロパティ設定を削除すると、そのオブジェクトは削除されます。
フォント サイズ。valueUnits
の形式で指定します。ここで、Units
は単位の略語です。単位には、次のいずれかの略語を使用します。
px
— ピクセル (既定)cm
— センチメートルin
— インチmm
— ミリメートルpc
— パイカpt
— ポイント
Id
— このドキュメント要素の ID
文字ベクトル | string スカラー
このドキュメント要素の ID。文字ベクトルまたは string スカラーとして指定します。ドキュメント要素を作成するときに、DOM によってセッション固有 ID が生成されます。独自の ID を指定できます。
属性:
GetAccess | public |
SetAccess | public |
NonCopyable | true |
データ型: char
| string
Italic
— 番号にイタリックを使用するオプション
[]
(既定値) | logical 値
番号にイタリックを使用するには、このプロパティを true
に設定します。このプロパティが空で、このドキュメント要素の StyleName
プロパティがスタイル シート スタイルを指定している場合、そのスタイルによって番号の傾斜が決定されます。Italic
プロパティを設定すると、対応する mlreportGen.dom.Italic
書式オブジェクトがこのドキュメント要素の Style
プロパティに追加されます。Italic
プロパティ設定を削除すると、そのオブジェクトは削除されます。
データ型: logical
Strike
— テキストの取り消し線
[] (既定値) | 'none'
| 'single'
| 'double'
テキストの取り消し線。次のいずれかの値として指定します。
'none'
— 取り消し線なし'single'
— 一重線'double'
— 二重線 (Word レポートの場合のみ)
Strike
プロパティを設定すると、対応する mlreportgen.dom.Strike
書式オブジェクトが、このドキュメント要素の Style
プロパティに追加されます。Strike
プロパティを空の値に設定すると、そのオブジェクトは削除されます。
Style
— 要素のスタイルを定義する書式
書式オブジェクトの配列
このプロパティで指定された書式は、この要素の StyleName
プロパティで指定されたスタイル シートのスタイルで定義された対応する書式をオーバーライドします。この要素に適用されない書式は無視されます。
StyleName
— 番号のスタイル
文字ベクトル
styleName
で指定するスタイルは、この番号を追加するドキュメント要素の作成に使用されるテンプレートで定義されていなければなりません。
Tag
— このドキュメント要素のタグ
文字ベクトル | string スカラー
このドキュメント要素のタグ。文字ベクトルまたは string スカラーとして指定します。
DOM は、このオブジェクトを作成するときに、セッション固有タグを生成します。生成されたタグの形式は CLASS:ID という形式です。ここで、CLASS はオブジェクト クラスです。ID はオブジェクトの Id
プロパティの値です。独自のタグ値を指定すると、ドキュメントの生成中に問題が発生した箇所を容易に特定できるようになります。
属性:
GetAccess | public |
SetAccess | public |
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
プロパティを空の値に設定すると、そのオブジェクトは削除されます。
下線の色とタイプの両方を指定する場合は、Underline
プロパティを設定しないでください。代わりに、下線のタイプと色を指定する mlreportgen.dom.Underline
書式オブジェクトを含めるように Style
プロパティを設定します。
WhiteSpace
— テキスト内の空白の処理方法
[]
(既定値) | 'normal'
| 'nowrap'
| ...
テキスト内の空白の処理方法。次の表のいずれかの値として指定します。
値 | 説明 | サポートされる出力タイプ |
---|---|---|
| HTML や PDF の場合、この値を設定すると、テキストの最初と最後のスペースが削除されます。テキスト内の複数のスペースは単一のスペースに折りたたまれます。 Word の場合、この値を設定すると、テキストの最初と最後のスペースが削除されます。 | すべて |
| 連続する空白は単一の空白に折りたたまれます。テキストが次の行に折り返されることはありません。 | HTML |
| 空白を維持します。テキストは改行でのみ折り返されます。HTML の | HTML および PDF |
| 連続する空白は単一の空白に折りたたまれます。テキストは必要に応じて、また改行で折り返されます。 | HTML および PDF |
| 空白を維持します。テキストは必要に応じて、また改行で折り返されます。 | HTML および PDF |
| 'pre' と同様です。 | すべて |
WhiteSpace
プロパティを設定すると、対応する mlreportgen.dom.WhiteSpace
書式オブジェクトが Style
プロパティに追加されます。WhiteSpace
プロパティを空の値に設定すると、そのオブジェクトは削除されます。
メソッド
例
章とテーブルでの自動生成番号の使用
import mlreportgen.dom.*; doctype = 'html'; d = Document('test',doctype); p = Paragraph('Chapter '); p.Style = {CounterInc('chapter'),CounterReset('table'),... WhiteSpace('preserve')}; append(p,AutoNumber('chapter')); append(d,p); p = Paragraph('Table '); append(p,AutoNumber('chapter')); append(p,'.'); append(p,AutoNumber('table')); p.Style = {CounterInc('table'),WhiteSpace('preserve')}; append(d,p); p = Paragraph('Chapter '); p.Style = {CounterInc('chapter'),CounterReset('table'),... WhiteSpace('preserve')}; append(p,AutoNumber('chapter')); append(d,p); p = Paragraph('Table '); append(p, AutoNumber('chapter')); append(p,'.'); append(p,AutoNumber('table')); p.Style = {CounterInc('table'),WhiteSpace('preserve')}; append(d,p); close(d); rptview('test',doctype);
バージョン履歴
R2014b で導入
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)