Edit

Share via

stringFormat

  • Article

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 stringFormat element for each displayInfo element.

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

Syntax

<!-- stringFormat -->
<xs:element name="stringFormat"  minOccurs="0" maxOccurs="1">
    <xs:complexType>
        <xs:attribute name="formatAs">
            <xs:simpleType>
                <xs:restriction base="xs:string">
                    <xs:enumeration value="General"/>
                    <xs:enumeration value="FileName"/>
                    <xs:enumeration value="FilePath"/>
                    <xs:enumeration value="Hyperlink"/>
                </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 "General". The following are valid values.
Value Meaning
General Default. Returns the value as an unformatted string.
FileName Formats the value as a file name. Hides the extension according to user settings. Requires the property type to be String.
FilePath Formats the value as a file path. Hides the extension according to user settings. Requires the property type to be String.
Hyperlink Formats the value as a hyperlink.