Skip to content

Latest commit

 

History

History
102 lines (77 loc) · 2.45 KB

propdesc-schema-booleanformat.md

File metadata and controls

102 lines (77 loc) · 2.45 KB
description ms.assetid title ms.topic ms.date
Specifies how IPropertyDescription::FormatForDisplay should format the booleanFormat property's value as a string.
f6384910-4411-4ac2-884d-3476c1b6ff96
booleanFormat
article
05/31/2018

booleanFormat

Specifies how IPropertyDescription::FormatForDisplay should format the property's value as a string. This is applicable only if <displayInfo displayType="String">. There should be only one booleanFormat element for each displayInfo element.

If there are multiple elements, the last one is used. If no booleanFormat element is provided, then the default attribute settings are applied to the property description.

Syntax

      <!-- 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>

Element Information

Parent Element Child Elements
displayInfo None

 

Attributes

Attribute Description
formatAs Public. Optional. Default is "YesNo". The following are valid values.
Value Meaning
YesNo Default. Formats the value as either "Yes" or "No". Requires the property type to be Boolean.
OnOff Formats the value as either "On" or "Off". Requires the property type to be Boolean.
TrueFalse Formats the value as either "True" or "False". Requires the property type to be Boolean.