String Property Type

The string property data type stores any character values as a single string. Definable behaviors of a string property include the ability to word wrap its contents upon display, to trim leading or trailing spaces within the string, and to treat the value as a password.

String Property Attributes

  • Name: This is the unique identifier for the property definition. This value must be unique among all properties within the same parent definition.
  • Display Name: This attribute sets the default display name to label or otherwise identify the property value on the Agentry Client. This will also be the default label for any screen control that displays this property.
  • Case: This attribute specifies the case of the characters within the string property. This also can affect how multiple parent definitions, such as objects, are sorted based on the value of the property. The options for this attribute are: Lowercase Only, Uppercase Only, Mixed (case-insensitive), and Mixed (case-sensitive). The lower and uppercase settings will force any characters within the property to either lower or uppercase, respectively. The two Mixed case options will preserve the case of the characters as entered. The case-sensitive and case-insensitive settings specify how the value of the property is compared, either with respect to case or ignore it.
  • Format: This attribute specifies how the value contained within the string property should be treated by the device or, more specifically, the operating system of the device. The options available for this attribute include email address, telephone number, and URL. Specifying this one of these options will result in the value being passed to the operating system with instructions to “open” the value in the corresponding application for the selected format; e.g. specifying the option URL will open the device’s web browser and navigate to the value in the string property.
  • Minimum Length: This attribute specifies the minimum number of characters the property will accept. For transaction string properties, the user will not be able to advance the wizard unless this minimum number of characters is entered or set for the property.
  • Maximum Length: This attribute specifies the maximum number of characters the property can contain. Editable fields displaying this property will not allow the entry of more than this number of characters. Object properties will truncate any value to this maximum number of characters for the string property.
  • Carriage Return: This attribute will affect properties that are displayed in fields with multiple lines. If set to true, when the user hits the Enter key, or if a carriage return value exists in the string, a new line will be started within the multi-line field.
  • Word Wrap: This attribute is another that affects properties displayed in multi-line fields. When set to true, if the text contained within the property is longer than the width of the field in which it is displayed, it will automatically wrap to the next line of the field, rather than scrolling past the far right edge.
  • Password: This attribute controls whether the value entered for the property should be displayed or hidden. When set to true, the value for the property will not be displayed, but rather each character will be replaced by an asterisk (*). This is also true when users enter a value for this property.
  • Trim: This attribute specifies whether white space characters at the beginning or end of the string should be preserved. When set to true, any leading or trailing white space will be trimmed from the value. Any white space within the string will not be trimmed.
Parent topic: Property Data Types