mlreportgen.dom.AutoNumber クラス

名前空間: mlreportgen.dom

自動生成番号

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

説明

DOM ドキュメント要素オブジェクト用の自動生成番号。

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

作成

説明

autoObj = AutoNumber は、番号ストリームを指定せずに自動生成番号を作成します。

例

autoObj = AutoNumber(stream) は、指定された番号付けストリームに基づいて番号を作成します。

autoObj = AutoNumber(stream,styleName) は、指定されたスタイルを使用して番号を作成します。

入力引数

すべて展開する

`stream` — 番号生成用の番号付けストリーム
文字ベクトル

mlreportgen.dom.AutoNumberStream オブジェクトの StreamName プロパティの値を使用して、番号付けストリームを指定します。

指定されたストリームが存在しない場合、DOM インターフェイスは、指定された名前と初期値 0 をもつアラビア数字ストリームを作成します。ローマ数字などの他のプロパティをもつストリームを使用するには、mlreportgen.dom.Document.createAutoNumberStream を使用してストリームを作成します。

`styleName` — テンプレートで定義された番号スタイルの名前
文字ベクトル

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

プロパティ

すべて展開する

`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

`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

`Italic` — ドキュメント要素にイタリックを使用するオプション
`[]` (既定値) | `true` または `1` | `false` または `0`

ドキュメント要素にイタリックを使用するオプション。数値または logical の 1 (true) または 0 (false) として指定します。ドキュメント要素をイタリックにするには、Italic を true または 1 に設定します。

メモ

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

属性:

NonCopyable true

データ型: logical

`Strike` — テキストの取り消し線
`[]` (既定値) | `"none"` | `"single"` | `"double"`

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

"none" — 取り消し線なし
"single" — 一重線
"double" — 二重線 (Word レポートの場合のみ)

メモ

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

属性:

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

属性:

NonCopyable true

データ型: char | string

`WhiteSpace` — テキスト内の空白の処理方法
`[]` (既定値) | `"normal"` | `"nowrap"` | ...

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

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

データ型: 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

`Tag` — `mlreportgen.dom.AutoNumber` オブジェクトのタグ
文字ベクトル | string スカラー

mlreportgen.dom.AutoNumber オブジェクトのタグ。文字ベクトルまたは string スカラーとして指定します。DOM API は、このオブジェクトを作成するときに、セッション固有タグを生成します。生成されるタグの形式は CLASS:ID という形式です。ここで、CLASS はオブジェクトクラスです。ID はオブジェクトの Id プロパティの値です。独自のタグ値を指定すると、ドキュメント生成中に問題が発生したときにどこを確認すればよいかを特定しやすくなります。

属性:

NonCopyable true

データ型: char | string

`Id` — `mlreportgen.dom.AutoNumber` オブジェクトの識別子
文字ベクトル | string スカラー

mlreportgen.dom.AutoNumber オブジェクトのオブジェクト識別子。文字ベクトルまたは string スカラーとして指定します。DOM API は、ドキュメント要素オブジェクトの作成時にセッション固有識別子を生成します。Id には独自の値を指定できます。

属性:

NonCopyable true

データ型: char | string

メソッド

すべて展開する

パブリックメソッド

メソッド	目的
`append` `ExternalLink.append` を使用するのと同様の方法で `AutoNumber.append` を使用します。	この番号にカスタム要素を追加します。
`clone` `Paragraph.clone` を使用するのと同様の方法で `AutoNumber.clone` を使用します。	番号オブジェクトをコピーします。

メソッド

目的

append

ExternalLink.append を使用するのと同様の方法で AutoNumber.append を使用します。

この番号にカスタム要素を追加します。

clone

Paragraph.clone を使用するのと同様の方法で AutoNumber.clone を使用します。

番号オブジェクトをコピーします。

例

すべて折りたたむ

章とテーブルでの自動生成番号の使用

ライブスクリプトを開く

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 で導入

参考

createAutoNumberStream | getAutoNumberStream | mlreportgen.dom.CounterInc | mlreportgen.dom.CounterReset

トピック

ドキュメントのコンテンツへの自動番号付け

mlreportgen.dom.AutoNumber クラス

説明

作成

説明

入力引数

stream — 番号生成用の番号付けストリーム 文字ベクトル

styleName — テンプレートで定義された番号スタイルの名前 文字ベクトル

プロパティ

BackgroundColor — 背景色 [] (既定値) | 文字ベクトル | string スカラー

属性:

Bold — ドキュメント要素に太字を使用するオプション [] (既定値) | true または 1 | false または 0

属性:

Color — ドキュメント要素の色 [] (既定値) | 文字ベクトル | string スカラー

属性:

FontFamilyName — テキストのフォント ファミリの名前 [] | 文字ベクトル | string スカラー

属性:

FontSize — ドキュメント要素のフォント サイズ [] (既定値) | 文字ベクトル | string スカラー

属性:

Italic — ドキュメント要素にイタリックを使用するオプション [] (既定値) | true または 1 | false または 0

属性:

Strike — テキストの取り消し線 [] (既定値) | "none" | "single" | "double"

属性:

Underline — 下線のタイプ [] (既定値) | "single" | "none" | ...

属性:

WhiteSpace — テキスト内の空白の処理方法 [] (既定値) | "normal" | "nowrap" | ...

StyleName — 要素のスタイルシート定義スタイル名 [] (既定値) | 文字ベクトル | string スカラー

属性:

Style — 書式指定 {} (既定値) | 書式オブジェクトの配列

属性:

CustomAttributes — ドキュメント要素のカスタム属性 [] (既定値) | mlreportgen.dom.CustomAttribute オブジェクトの配列

属性:

Tag — mlreportgen.dom.AutoNumber オブジェクトのタグ 文字ベクトル | string スカラー

属性:

Id — mlreportgen.dom.AutoNumber オブジェクトの識別子 文字ベクトル | string スカラー

属性:

メソッド

パブリック メソッド

例

章とテーブルでの自動生成番号の使用

バージョン履歴

参考

トピック

`stream` — 番号生成用の番号付けストリーム
文字ベクトル

`styleName` — テンプレートで定義された番号スタイルの名前
文字ベクトル

`BackgroundColor` — 背景色
`[]` (既定値) | 文字ベクトル | string スカラー

`Bold` — ドキュメント要素に太字を使用するオプション
`[]` (既定値) | `true` または `1` | `false` または `0`

`Color` — ドキュメント要素の色
`[]` (既定値) | 文字ベクトル | string スカラー

`FontFamilyName` — テキストのフォントファミリの名前
`[]` | 文字ベクトル | string スカラー

`FontSize` — ドキュメント要素のフォントサイズ
`[]` (既定値) | 文字ベクトル | string スカラー

`Italic` — ドキュメント要素にイタリックを使用するオプション
`[]` (既定値) | `true` または `1` | `false` または `0`

`Strike` — テキストの取り消し線
`[]` (既定値) | `"none"` | `"single"` | `"double"`

`Underline` — 下線のタイプ
`[]` (既定値) | `"single"` | `"none"` | ...

`WhiteSpace` — テキスト内の空白の処理方法
`[]` (既定値) | `"normal"` | `"nowrap"` | ...

`StyleName` — 要素のスタイルシート定義スタイル名
`[]` (既定値) | 文字ベクトル | string スカラー

`Style` — 書式指定
`{}` (既定値) | 書式オブジェクトの配列

`CustomAttributes` — ドキュメント要素のカスタム属性
`[]` (既定値) | `mlreportgen.dom.CustomAttribute` オブジェクトの配列

`Tag` — `mlreportgen.dom.AutoNumber` オブジェクトのタグ
文字ベクトル | string スカラー

`Id` — `mlreportgen.dom.AutoNumber` オブジェクトの識別子
文字ベクトル | string スカラー

パブリックメソッド