ToString(Language,String) Method

In This Topic

Used in conversion of the PropertyValue object to MultiLangString.

If the type of property is MultiLangString, only the specified language is returned. In case of a transient PropertyValue object, the stored value is returned without any cast.

Syntax

C#
C++/CLI

public string ToString( 
   ISOCode.Language language,
   string default_value
)

public:
String^ ToString( 
   ISOCode.Language language,
   String^ default_value
)

Parameters

Parameter Name	Description
language	Language to extract from MultiLangString value.
default_value	Default value to be retuned if property cannot be read.

Return Value

Returns the string value of the PropertyValue object or the default_value if the property cannot be read from the object or the properties list.

Exceptions

Exception	Description
NotIndexedPropertyException	Thrown if the source is indexed, but the destination is an unindexed property.
IndexedPropertyException	Thrown if the source is not an indexed property, but the destination is indexed.

Remarks

If the property cannot be read, the given default_value is returned instead of throwing an EmptyPropertyException.

Reference

PropertyValue Class
PropertyValue Members
Overload List

Use the Eplan Global Support Portal for feedback and support