数値書式のオプションとプロパティ

<< Click to Display Table of Contents >>

マニュアル > Appendix > 数値書式 >

数値書式のオプションとプロパティ

数値書式のオプションとプロパティについて

数値書式には、「オプション」と「プロパティ」が用意されています。これらを使用する場面は、以下のとおりです。

 

数値書式の指定時 ・・・オプションとプロパティを指定可能

ユーザー書式の定義時 ・・・プロパティを指定可能

 

 

■数値書式のオプション指定

 

数値書式を指定する際、以下の書式によってオプションとプロパティを指定することができます。

 

@数値書式名.オプション書式<プロパティ書式>

 

オプションの指定方法としては、「@NUMBER」などの数値書式名の後にドット文字「.」を1文字入れ、その後に任意のオプション書式を付加します。

また、数値書式のオプション書式で複数のオプションを同時に指定したい場合は、 @NUMBER.L16S4 などのように、複数のオプションをまとめて指定することができます(※この例では「L16」「S4」の2つのオプションを指定しています。尚、「@NUMBER.L16.S4」などのように指定することはできません)。

さらに、数値書式の末尾に、<プロパティ=設定値> としてプロパティ書式を指定することができます。複数のプロパティを指定する場合は、<プロパティ1=設定値;プロパティ2=設定値;プロパティ3=設定値>のように、プロパティ単位でセミコロンで区切って指定します。

 

数値書式の指定例:

 

@NUMBER                ・・・ 12345.678

@NUMBER.2                ・・・ 12345.68   ※小数点桁数2桁

@NUMBER.2S                ・・・ 12,345.68   ※小数点桁数2桁でセパレータ「,」が付加される

@NUMBER<H=ABC>        ・・・ ABC12345.678 ※プロパティでヘッダを付加した例

@NUMBER.2<H=Temp$SP;F=$SPdegC>        ・・・ Temp 12345.68 degC ※複数のプロパティを指定した例

 

hint

書式を指定する際に複数のプロパティを指定する方法として、<プロパティ1=設定値;プロパティ2=設定値;プロパティ3=設定値>のようにプロパティ単位でセミコロンで区切る方法の他に、<プロパティ1=設定値><プロパティ2=設定値><プロパティ3=設定値>・・・のように、<>の組を列挙して指定することもできます。

尚、<>の組を列挙する場合、<>と<>の間には文字を入れないようにしてください(スペースも不可)。

 

 

■ユーザー書式の定義

 

NumberFormatConfルートプロパティに対して定義を行うと、ユーザー書式として独自の数値書式を追加することができます。

ユーザー書式では、以下の書式に従ってプロパティを設定することができます。

 

[@数値書式名]

プロパティ名=設定値

 ・・・

 

ユーザー書式の定義例(NumberFormatConfルートプロパティ):

 

[@SAMPLE01]

Base=10

DecimalPlaces=3

PositiveSign=+

 

 

数値書式のオプション書式

数値書式で指定可能なオプションは以下のとおりです。

 

■数値書式のオプション書式一覧

 

オプション書式

[数値]

ドット文字「.」の直後に数値を指定すると小数点桁数を指定することができます。

 

例)@NUMBER.2

 


L[数値]

表示文字数です。「L」に続けて桁数を指定します。

 

例) @BIN.L8 ・・・ 8桁の2進数

 


S[数値]

セパレータを何桁毎に表示するのかを設定します(数値は省略可能)。

「S」のみを指定すると、デフォルトのケタ数区切りで表示し、Sの後に数値を指定すると桁区切りの桁数を変更することもできます。

 

例) @BIN.L16S4 ・・・ 16桁の2進数、4桁区切り

 


P

このオプションを指定すると、正の数の場合にポジティブサイン(通常は「+」)を表示します。

 

例)@NUMBER.P

 


M[数値]

小数点の移動を行います。

(正の数の時、10^x倍、負の数の時、10^1/x)

 

例)@NUMBER.M2 ・・・数値を100倍して表示

 

 

例)Localeが「ja」の場合

 

数値書式の指定例

表示例

@NUMBER

12345.678

@NUMBER.2

12345.68

@NUMBER.2S

12,345.68

@NUMBER.2SP

+12,345.68

@NUMBER.M2

1234567.8

 

 

数値書式のプロパティ書式

数値書式で指定可能なプロパティは以下のとおりです。

 

■数値書式のプロパティ書式一覧

 

プロパティ

仕様

All=数値書式名

数値書式名で指定した数値書式のすべてのプロパティを継承します。

 

例)All=@LOCALE  ・・・@LOCALEの全てのプロパティを引き継ぐ

 

Base=基数

基数を指定します。

2  ・・・2進数

8  ・・・8進数

10  ・・・10進数

16  ・・・16進数(大文字表記。FFFFなど)

16s  ・・・16進数(小文字表記。ffffなど)

 

例)Base=2

 

DecimalPlaces=数値

D=数値

小数点桁数を指定します。(略称:D)

 

例)DecimalPlaces=2

 

DecimalPointMoving=数値

M=数値

小数位置を移動します。(略称:M)

※正の数の時、10^x倍、負の数の時、10^1/x

 

例)DecimalPointMoving=2  ・・100倍して表示

 

DecimalSymbol=文字

DS=文字

小数点を表す文字を指定します。(ピリオドなど。「$SP」でスペースを指定可能。略称:DS)

 

例)DecimalSymbol=, ・・小数点をカンマ1文字で表現

 

Separator=T/F

S=T/F

セパレータ(たとえばカンマ区切りなど)を表示するか否かを「T」か「F」で指定します(略称:S)。セパレータを表示する桁数はSeparatorGroupingの設定に従います。

※本プロパティにTを指定すると、数値書式オプションで「.S」を指定しなくてもセパレータが表示されます。

 

例)Separator=T

 

SeparatorSymbol=文字

SS=文字

セパレータを表す文字を指定します。(カンマなど。「$SP」でスペースを指定可能。略称:SS)

 

例)SeparatorSymbol=$SP ・・セパレータをスペース1文字で表現

 

SeparatorGrouping=設定値

SG=文字

セパレータを何桁毎に表示するのかを表すグループ設定です(略称:SG)。以下のいずれかを指定します。

数値を単体で指定すると、指定した桁数毎にセパレータが表示されます。

又、数値をコロンで区切って「3:2」などのように指定すると、1の位を起点として最初に指定した数の桁数で区切り(この例では3桁)、以降は2つ目で指定した数の桁数で繰り返し区切ります(この例では2桁)。

 

例1)SeparatorGrouping=3  ・・・123,456,789

例2)SeparatorGrouping=3:0  ・・・123456,789

例3)SeparatorGrouping=3:2  ・・・12,34,56,789

 

PositiveSign=文字

P=文字

正の数のときに表示する符号を指定することができます(略称:P)。空文字とすると何も表示されません。

以下は数値「123」の例です

 

例1)PositiveSign=  ・・・123

例2)PositiveSign=+  ・・・+123

 

NegativeSign=文字

N=文字

負の数のときに表示する符号を指定することができます。(略称:N)

以下は数値「-123」の例です

 

例)NegativeSign=-  ・・・-123

 

NegativeNumberFormat=数値

NF=数値

負の数の表示フォーマットを0から4までの5種類の中から選択することができます。(略称:NF)

以下は数値「-1.1」の例です。

 

例1)NegativeNumberFormat=0 ・・・ (1.1)

例2)NegativeNumberFormat=1 ・・・ -1.1

例3)NegativeNumberFormat=2 ・・・ - 1.1

例4)NegativeNumberFormat=3 ・・・ 1.1-

例5)NegativeNumberFormat=4 ・・・ 1.1 -

 

DisplayLeadingZeros=T/F

DZ=T/F

小数以下の数値の整数部の表示仕様を指定します(略称:DZ)。例えば、数値「0.123」の場合、Tの時「0.123」、Fの時 「.123」と表示します。

 

例)DisplayLeadingZeros=T

 

DisplayLength=数値

L=数値

数値表示全体の桁数を指定します(略称:L)。数値表示の文字数がDisplayLengthより小さい場合、PaddingSymbolで指定した文字で埋め合わせます。0を指定された場合はPaddingSymbolによる埋め合わせを行いません。数値表示の文字数がDisplayLengthより大きい場合は埋め合わせ表示を行わす、数値全体を表示します。

 

例)DisplayLength=8

 

PaddingSymbol=文字

PS=文字

数値表示全体の桁数を指定した場合で、桁数未満の場合の埋め合わ文字を指定します。(0など。「$SP」でスペースを指定可能。略称:PS)

 

例)PaddingSymbol=0 ・・ 00000123   ※DisplayLength=8の場合

 

Header=文字

H=文字

数値のヘッダーとして表示したい文字(文字列)を指定します。(「$SP」は表示時にスペースに置き換えられます。略称:H)

 

例)Header=Temp$SP ・・Temp 123

 

Footer=文字

F=文字

数値のフッターとして表示したい文字(文字列)を指定します。(「$SP」は表示時にスペースに置き換えられます。略称:F)

 

例)Footer=$SPdegC ・・123 degC

 

QualityBad=文字

QB=文字

CNumToLocale(NL)ルートメソッドの引数のうち、Number、Faultで渡すパラメータがタグパスの場合に、メソッドの判定結果がBadのときの表示文字を指定することができます。空文字とすると何も表示されません。$VALUEを指定すると、BADの時でも値をそのまま表示します。(略称:QB)

 

例)QualityBad=***

 

QualityUncertain=文字

QU=文字

CNumToLocale(NL)ルートメソッドの引数のうち、Number、Faultで渡すパラメータがタグパスの場合に、メソッドの判定結果がUncertainのときの表示文字を指定します。空文字とすると何も表示されません。(略称:QU)

 

例)QualityUncertain=

 

QualityNA=文字

QN=文字

CNumToLocale(NL)ルートメソッドの引数のうち、Number、Faultで渡すパラメータがタグパスの場合に、メソッドの判定結果がNAのときの表示文字を指定します。空文字とすると何も表示されません。(略称:QN)

 

例)QualityNA=

 

 

hint

プロパティの右辺(プロパティ名=xxx の「xxx」部分)に指定するパラメータの禁則文字は以下のとおりです。

 

「;」 ・・・セミコロン

「><」 ・・・左記が連続した文字列。<Header=<aaa>>はOK。<Header=<aaa><bbb>>はNG。

 

 

hint

上一覧のうち、QualityBad、QualityUncertain、QualityNAの設定値は、ライブラリ部品(部品ライブラリ)の数値表示部品の動作にも関係します。ライブラリ部品では数値書式に「@NUMBER」が使用されており、ユーザー書式で@NUMBERをカスタマイズすることにより、ライブラリ部品の異常時に表示される「***」の表示文字を一括で変更することができます。