このページの内容は最新ではありません。最新版の英語を参照するには、ここをクリックします。

mlreportgen.dom.Number クラス

名前空間: mlreportgen.dom

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

R2021a 以降

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

説明

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 スカラーとして指定します。スタイル名は、この要素を追加するドキュメントまたはドキュメント パーツのスタイル シートで指定したスタイルの名前です。指定されたスタイルは、この要素の Style プロパティで指定された書式によってオーバーライドされない限り、出力ドキュメントでのこの要素の外観を定義します。スタイル シートの使用の詳細については、スタイル シートのスタイルの使用を参照してください。

メモ

Microsoft® Word 出力ではスタイル名が無視されます。

属性:

NonCopyable
true

データ型: char | string

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

属性:

NonCopyable
true

データ型: cell

このドキュメント要素のカスタム属性。mlreportgen.dom.CustomAttribute オブジェクトの配列として指定します。カスタム属性は、このオブジェクトが追加されるドキュメント要素の出力形式でサポートされていなければなりません。

属性:

NonCopyable
true

mlreportgen.dom.Number オブジェクトの親。ドキュメント要素オブジェクトとして指定します。ドキュメント要素の親は 1 つでなければなりません。

属性:

SetAccess
private
NonCopyable
true

クラスはこのプロパティを無視します。

属性:

SetAccess
private
NonCopyable
true

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

属性:

NonCopyable
true

データ型: char | string

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

属性:

NonCopyable
true

データ型: char | string

メソッド

すべて展開する

例

すべて折りたたむ

ライブ スクリプトを開く

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

参考

| |

トピック