toString

クラス: mlreportgen.dom.Number
名前空間: mlreportgen.dom

数値から書式設定済みテキストへの変換

R2021a 以降

構文

formattedNumber = toString(numberObj)

formattedNumber = toString(numberObj) は、numberObj で指定された数値を書式設定済みテキストに変換します。

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

numberObj で指定した mlreportgen.dom.Number オブジェクトの Style プロパティに含まれる mlreportgen.dom.NumberFormat オブジェクトでの指定
指定した Number オブジェクトを含む段落、リスト、テーブルなどの要素の Style プロパティに含まれる NumberFormat オブジェクトでの指定
mlreportgen.dom.setDefaultNumberFormat によって指定された既定の指定セット

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

このメソッドを使用することで、mlreportgen.dom.Number オブジェクトをレポートに追加したときにどのような書式設定済みテキストとなるかを確認できます。

変換する数値。mlreportgen.dom.Number オブジェクトとして指定します。

書式設定済み数値。文字ベクトルとして返されます。

この例では、toString は Number オブジェクトの Style プロパティに含まれる NumberFormat オブジェクトで指定された書式を使用します。

import mlreportgen.dom.*
numberObj = Number(pi);
numberObj.Style = [numberObj.Style {NumberFormat("%0.2f")}];
formattedNumber = toString(numberObj)

formattedNumber = 
'3.14'

R2021a で導入