booleanFormat

  • [アーティクル]

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

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

構文

      <!-- booleanFormat -->
      <xs:element name="booleanFormat"  minOccurs="0" maxOccurs="1">
        <xs:complexType>
          <xs:attribute name="formatAs">
            <xs:simpleType>
              <xs:restriction base="xs:string">
                <xs:enumeration value="YesNo"/>
                <xs:enumeration value="OnOff"/>
                <xs:enumeration value="TrueFalse"/>
              </xs:restriction>
            </xs:simpleType>
          </xs:attribute>
        </xs:complexType>
      </xs:element>

要素情報

Parent 要素 子要素
displayInfo なし

 

属性

属性 説明
formatAs パブリック。 省略可能。 既定値は "YesNo" です。 有効な値は次のとおりです。
値 説明
はい/いいえ (Yes/No) 既定値。 値を "Yes" または "No" として書式設定します。 プロパティの型をブール値にする必要があります。
OnOff 値を "On" または "Off" として書式設定します。 プロパティの型をブール値にする必要があります。
TrueFalse 値を "True" または "False" として書式設定します。 プロパティの型をブール値にする必要があります。