Main Content

mlreportgen.dom.Number クラス

パッケージ: mlreportgen.dom

書式設定済みテキストとしてドキュメントに含める数値

説明

mlreportgen.dom.Number クラスのオブジェクトを使用して、ドキュメントに含めることができる書式設定済みテキストに数値を変換します。

この変換では、以下の書式指定のうち最初に検出したものを使用します。

  1. Number オブジェクトの Style プロパティに含まれる mlreportgen.dom.NumberFormat オブジェクトでの指定

  2. Number オブジェクトを含む段落、リスト、テーブルなどの要素の Style プロパティに含まれる NumberFormat オブジェクトでの指定

  3. mlreportgen.dom.setDefaultNumberFormat によって指定された既定の指定セット

変換時に書式指定が見つからなかった場合、その数値を正確に表すのに必要な最大の桁数を使用して変換が行われます。

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

クラス属性

ConstructOnLoad
true
HandleCompatible
true

クラス属性の詳細については、クラスの属性を参照してください。

作成

説明

numberObj = mlreportgen.dom.Number() は、空の Number オブジェクトを作成します。Value プロパティを使用して、書式設定済みテキストに変換する数値を指定します。

numberObj = mlreportgen.dom.Number(value) は、Value プロパティを value に設定した Number オブジェクトを作成します。

numberObj = mlreportgen.dom.Number(value,stylename) は、Value プロパティを value に設定し、StyleName プロパティを stylename に設定した Number オブジェクトを作成します。

プロパティ

すべて展開する

書式設定済みテキストに変換する数値。スカラーとして指定します。複素数はサポートされていません。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | logical

この数値がテキストに変換されるときのスタイルシート定義スタイルの名前。文字ベクトルまたは string スカラーとして指定します。

StyleName プロパティで指定されたスタイルは、この Number オブジェクトを追加するドキュメントまたはドキュメント パーツのスタイルシートで定義されていなければなりません。指定されたスタイルは、出力ドキュメントにおける数値のテキスト表現の外観を定義します。Style プロパティで指定された書式は、スタイルシートで定義された書式設定をオーバーライドします。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

この数値がテキストに変換されるときのスタイルを定義する書式設定。DOM 書式オブジェクトの cell 配列として指定します。変換される数値の精度を指定するには、mlreportgen.dom.NumberFormat オブジェクトを使用します。この書式は、StyleName プロパティで指定したスタイルシートのスタイルで定義した対応する書式をオーバーライドします。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

変換後の数値を含むドキュメント要素のカスタム属性。mlreportgen.dom.CustomAttribute オブジェクトの cell 配列として指定します。出力形式はカスタム属性をサポートしていなければなりません。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

この数値オブジェクトの親。ドキュメント要素オブジェクトとして指定します。

属性:

GetAccess
public
SetAccess
private
NonCopyable
true

このプロパティは無視されます。

属性:

GetAccess
public
SetAccess
private
NonCopyable
true

この DOM API オブジェクトのタグ。文字ベクトルまたは string スカラーとして指定します。

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

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

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

メソッド

すべて展開する

すべて折りたたむ

Number オブジェクトとして数値を表します。NumberFormat オブジェクトを使用して、小数点以下 4 桁の精度を指定します。

import mlreportgen.dom.*
  
rpt = Document("Report with NumberFormat","pdf");

n = Number(pi);
n.Style = [n.Style {NumberFormat("%0.4f")}];
append(rpt,n);
  
close(rpt);
rptview(rpt);

バージョン履歴

R2021a で導入