Label Data type
Version: Available or changed with runtime version 1.0.
Denotes a string constant that can be optionally translated into multiple languages.
Instance methods
The following methods are available on instances of the Label data type.
| Method name | Description |
|---|---|
| Contains(Text) | Returns a value indicating whether a specified substring occurs within this string. |
| EndsWith(Text) | Determines whether the end of this string instance matches the specified string. |
| IndexOf(Text [, Integer]) | Reports the one-based index of the first occurrence of the specified string in this instance. |
| IndexOfAny(Text [, Integer]) | Reports the one-based index of the first occurrence of the specified string in this instance. The search starts at a specified character position. |
| IndexOfAny(List of [Char] [, Integer]) | Reports the one-based index of the first occurrence in this instance of any character in a specified array of Unicode characters. The search starts at a specified character position. |
| LastIndexOf(Text [, Integer]) | Reports the one-based index position of the last occurrence of a specified string in this instance. |
| PadLeft(Integer [, Char]) | Returns a new Text that right-aligns the characters in this instance by padding them on the left, for a specified total length. |
| PadRight(Integer [, Char]) | Returns a new string that left-aligns the characters in this string by padding them with spaces on the right, for a specified total length. |
| Remove(Integer [, Integer]) | Returns a new Text in which a specified number of characters from the current string are deleted. |
| Replace(Text, Text) | Returns a new Text in which all occurrences of a specified string in the current instance are replaced with another specified string. |
| Split([Text,...]) | Splits a string into a maximum number of substrings based on a collection of separators. |
| Split(List of [Text]) | Splits a string into a maximum number of substrings based on a collection of separators. |
| Split(List of [Char]) | Splits a string into a maximum number of substrings based on a collection of separators. |
| StartsWith(Text) | Determines whether the beginning of this instance matches a specified string. |
| Substring(Integer [, Integer]) | Retrieves a substring from this instance. |
| ToLower() | Returns a copy of this string converted to lowercase. |
| ToUpper() | Returns a copy of this string converted to uppercase. |
| Trim() | Returns a new Text in which all leading and trailing white-space characters from the current Text object are removed. |
| TrimEnd([Text]) | Removes all trailing occurrences of a set of characters specified in an array from the current Text object. |
| TrimStart([Text]) | Removes all leading occurrences of a set of characters specified in an array from the current Text object. |
Parameters
All of the parameters below are optional and the order is not enforced.
| Attribute | Description |
|---|---|
| Comment | Used for general comments about the label, specifically about the placeholders in that label. |
| Locked | When Locked is set to true, the label should not be translated. Default value is false. |
| MaxLength | Determines how much of the label is used. ` If no maximum length is specified, the string can be any length. |
Syntax example
var
a : Label 'Label Text', Comment='Foo', MaxLength=999, Locked=true;
Remarks
The Label data type is used in .xlf files for translations. For more information, see Working with Translation Files.
For information about naming, see CodeCop Rule AA0074.