An element which can be used to load localized resources from property files. Stringbundles should be placed inside a stringbundleset element.
A property file is a list of property key-value pairs each on a separate line. The key and value is separated with an equals sign. For example, the following defines two properties:
message.displayError=An error occured trying to display this message message.nameAlreadyUsed=The name %S is already being used by another account.
More information is available in the XUL tutorial.
- Attributes
- src
- Properties
- appLocale , src, stringBundle, strings
- Methods
- getFormattedString, getString
Examples
(example needed)
Attributes
src- Type: URI
- The URI of the property file that contains the localized strings.
Inherited from XUL element |
Properties
stringBundle- Type:
nsIStringBundle - Returns the XPCOM string bundle object which implements
nsIStringBundle.
strings- Type:
nsISimpleEnumerator - An enumeration of all of the strings in the string bundle. The enumeration contains
nsIPropertyElementobjects.
Methods
getFormattedString( key, strArray )- Return type: string
- Looks up the format string for the given key name in the string bundle and returns a formatted copy where each occurrence of
%S(uppercase) is replaced by each successive element in the supplied array. Alternatively, numbered indices of the format%n$S(e.g.%1$S,%2$S, etc.) can be used to specify the position of the corresponding parameter explicitly.
If you need to handle substitutions involving plurals, take a look at Localization and Plurals.
-
getString( key ) - Return type: string
- Returns the string with the given <var>key</var> name from the string bundle.