System.TypInfo.GetUnicodeStrProp

From Appmethod Libraries
Jump to: navigation, search

Object Pascal

function GetUnicodeStrProp(Instance: TObject; const PropName: string): UnicodeString;
function GetUnicodeStrProp(Instance: TObject; PropInfo: PPropInfo): UnicodeString;

C++

extern DELPHI_PACKAGE System::UnicodeString __fastcall GetUnicodeStrProp _DEPRECATED_ATTRIBUTE1("use GetStrProp") (System::TObject* Instance, const System::UnicodeString PropName)/* overload */;

Properties

Type Visibility Source Unit Parent
function public
System.TypInfo.pas
System.TypInfo.hpp
System.TypInfo System.TypInfo

Description

Returns the value of a component property that is of UnicodeString type.

GetUnicodeStrProp utilises Object Pascal's RTTI (Run Time Type Information) to return the current value of a component's property where that property is a UnicodeString. An empty string is returned if the property is not of this type.

In one form of this function, the property is looked up by using the data in the PropInfo parameter. GetPropInfo and GetPropList can be used to obtain such a record.

In the other form of this function, the name of the property, PropName, is explicitly given.

In both forms of the function, the current value of the property is returned as a string.

The intrinsic value of this function is to allow retrieval of component properties without the need to hard code the property name. This allows mass visual component processing at run time.

Use GetPropValue to retrieve a property value where the type is unknown - it is returned in a Variant type.

Note: If the specified property does not exist, or is not a published property, an EPropertyError exception is thrown.

See Also