numberFormat

  • [アーティクル]

IPropertyDescription::FormatForDisplay でプロパティの値を文字列として書式設定する方法を指定します。 これは displayInfo displayType="Number"> の場合<にのみ適用されます。 displayInfo 要素ごとに numberFormat 要素は 1 つだけ必要です。

複数の要素がある場合は、最後の要素が使用されます。 numberFormat 要素が指定されていない場合、既定の属性設定がプロパティの説明に適用されます。

構文

      <!-- numberFormat -->
      <xs:element name="numberFormat"  minOccurs="0" maxOccurs="1">
        <xs:complexType>
          <xs:attribute name="formatAs">
            <xs:simpleType>
              <xs:restriction base="xs:string">
                <xs:enumeration value="General"/>
                <xs:enumeration value="Percentage"/>
                <xs:enumeration value="ByteSize"/>
                <xs:enumeration value="KBSize"/>
                <xs:enumeration value="SampleSize"/>
                <xs:enumeration value="Bitrate"/>
                <xs:enumeration value="SampleRate"/>
                <xs:enumeration value="FrameRate"/>
                <xs:enumeration value="Pixels"/>
                <xs:enumeration value="DPI"/>
                <xs:enumeration value="Duration"/>
              </xs:restriction>
            </xs:simpleType>
          </xs:attribute>
          <xs:attribute name="formatDurationAs">
              <xs:restriction base="xs:string">
                <xs:enumeration value="hh:mm"/>
                <xs:enumeration value="hh:mm:ss"/>
                <xs:enumeration value="hh:mm:ss.fff"/>
              </xs:restriction>
            </xs:simpleType>
          </xs:attribute>
        </xs:complexType>
      </xs:element>

要素情報

Parent 要素 子要素
displayInfo None

 

属性

属性 説明
formatAs パブリック。 省略可能。 既定値は "General" です。 表示形式を指定します。 有効な値は次のとおりです。
値 説明
全般 既定値。 値を書式設定されていない数値として表示します。
パーセント 値をパーセンテージで書式設定します。 プロパティが UInt32 である必要があります。
ByteSize 必要に応じて、値をバイト、"KB"、"MB"、または "GB" として書式設定します。 プロパティが UInt64 である必要があります。
KBSize 値が何であっても、値を "KB" として書式設定します。 プロパティが UInt64 である必要があります。
SampleSize 値をビット数として書式設定します。 プロパティが UInt32 である必要があります。
ビットレート 値を "Kbps" で書式設定します。 プロパティが UInt32 である必要があります。 値は、"ビット/秒" 単位で格納する必要があります。
SampleRate 値を "KHz" で書式設定します。 プロパティが UInt32 である必要があります。 値は "Hertz" 単位で格納する必要があります。
FrameRate 値をフレーム/秒で書式設定します。 プロパティが UInt32 である必要があります。 値は、"キロフレーム/秒" 単位で格納する必要があります。
ピクセル 値をピクセル単位で書式設定します。 プロパティが UInt32 である必要があります。
DPI 値をドット/インチ単位で書式設定します。 プロパティが UInt32 である必要があります。
Duration 値を期間として書式設定します。 期間の形式を指定するには、formatDurationAs> を使用<します。 プロパティが UInt64 である必要があります。

 
formatDurationAs パブリック。 省略可能。 既定値は "hh:mm:ss" です。 formatAs="Duration" の場合にのみ適用されます。 プロパティが UInt64 である必要があります。 有効な値は次のとおりです。
値 説明
hh:mm 値の書式を時間と分単位で設定します。
hh:mm:ss 既定値。 値を時間、分、秒で書式設定します。
hh:mm:ss.fff 値を時間、分、秒、ミリ秒で書式設定します。