Main Content

mlreportgen.dom.AutoNumber クラス

パッケージ: mlreportgen.dom

説明

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

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

作成

説明

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

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

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

入力引数

すべて展開する

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

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

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

プロパティ

すべて展開する

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

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

例: 'blue'

例: '#0000ff'

テキストを太字にするには、このプロパティを true または 1 に設定します。このプロパティが空で、このドキュメント要素の StyleName プロパティがスタイル シート スタイルを指定している場合、そのスタイルによって番号の太さが決定されます。Bold プロパティを設定すると、対応する mlreportGen.dom.Bold 書式オブジェクトがこのドキュメント要素の Style プロパティに追加されます。Bold プロパティ設定を削除すると、そのオブジェクトは削除されます。

データ型: logical

テキストの色。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 オブジェクトの配列として指定します。カスタム属性は、出力形式でサポートされていなければなりません。

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

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

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

例: 'Courier New'

このフォントの代替を指定する必要がある場合は、このプロパティを設定しないでください。代わりに、mlreportgen.dom.FontFamily オブジェクトを作成して、このドキュメント要素の Style プロパティに追加します。

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

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

  • px — ピクセル (既定)

  • cm — センチメートル

  • in — インチ

  • mm — ミリメートル

  • pc — パイカ

  • pt — ポイント

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

番号にイタリックを使用するには、このプロパティを true に設定します。このプロパティが空で、このドキュメント要素の StyleName プロパティがスタイル シート スタイルを指定している場合、そのスタイルによって番号の傾斜が決定されます。Italic プロパティを設定すると、対応する mlreportGen.dom.Italic 書式オブジェクトがこのドキュメント要素の Style プロパティに追加されます。Italic プロパティ設定を削除すると、そのオブジェクトは削除されます。

データ型: logical

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

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

  • 'single' — 一重線

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

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

このプロパティで指定された書式は、この要素の StyleName プロパティで指定されたスタイル シートのスタイルで定義された対応する書式をオーバーライドします。この要素に適用されない書式は無視されます。

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

このドキュメント要素のタグ。文字ベクトルまたは 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 プロパティを空の値に設定すると、そのオブジェクトは削除されます。

メソッド

すべて展開する

すべて折りたたむ

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