SingletonString Element

System.Object
  PropertyType
    ModifiablePropertyType
      SingletonString
Client Declaration
  public class SingletonString
Represents a Content Engine property that holds a single string value.

Element Structure

Elements
  • String Value: Optional element specifying the string value held by the property.
    • [request] If this attribute is omitted in a request, the property's current value is erased; otherwise, it is overwritten with the new value. An empty string (note that this is not equivalent to having no value) is represented by an empty Value element.
    • [response] If this attribute is omitted in a response, the property has no value. An empty string is represented by an empty Value element.
Attributes
  • StringEncodingType encoding: [request][response] Optional expression specifying how the string value is encoded. If this attribute is set to H9, any characters that are illegal in XML are replaced with a legal character sequence.
Attributes Specific to .NET Clients
  • Boolean encodingSpecified: Optional expression specifying whether encoding has a value (true) or not (false).

Base Element Inheritance

Attributes
  • String propertyId:
    • [request] Required expression identifying the Content Engine property. This attribute can specify either a symbolic name or a GUID.
    • [response] Required expression specifying the symbolic name of the Content Engine property.
  • Boolean settable: [response] Optional expression specifying whether the specified Content Engine property is settable by the user (true) or not (false). If true, this attribute's value is "1"; otherwise, this attribute is omitted in the response.
Attributes Specific to .NET Clients
  • Boolean settableSpecified: Optional expression specifying whether settable has a value (true) or not (false).

XML Schema

<xsd:complexType name="SingletonString">
   <xsd:complexContent>
      <xsd:extension base="ModifiablePropertyType">
         <xsd:sequence>
            <xsd:element minOccurs="0" name="Value" type="xsd:string"/>
         </xsd:sequence>
         <xsd:attribute name="encoding" type="StringEncodingType"/>
      </xsd:extension>
   </xsd:complexContent>
</xsd:complexType>