View.GetLocalizedDescription Method
Gets a localized version of the view description in a specific language.
GetLocalizedDescription(System.String language)
Gets a localized version of the view description in a specific language.Syntax
public System.String GetLocalizedDescription (
System.String language
)Parameters
The requested language.
Return Value
The description in the requested language or the default language.
Remarks
The value returned by this method will come from one of four different places:
If an ISO metadata document is specified for the requested language (see the GetLocalizedIsoMetadataDocument method), and that document specifies an abstract, that abstract is returned.
If a description in the requested language is specified in the configuration file or set by the SetLocalizedDescription method, that description is returned.
If an ISO metadata document is specified for the default language (see the IsoMetadataDocument property), and that document specifies an abstract, that abstract is returned.
If a description is still not found, the value of the Description property is returned. Note that even this may be omitted, in which case the method returns an empty string.
To find out which languages are available in a loaded configuration, use Configuration.DefaultLanguage and Configuration.AdditionalLanguages. You can also check if a value is actually set for a specific language or if the default value would be returned, see HasLocalizedDescription.
Platforms
Windows, Linux, Android