System.TypInfo.GetObjectProp

From Appmethod Libraries
Jump to: navigation, search

Object Pascal

function GetObjectProp(Instance: TObject; const PropName: string; MinClass: TClass): TObject;
function GetObjectProp(Instance: TObject; PropInfo: PPropInfo; MinClass: TClass): TObject;

C++

extern DELPHI_PACKAGE System::TObject* __fastcall GetObjectProp(System::TObject* Instance, const System::UnicodeString PropName, System::TClass MinClass = 0x0)/* 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 an object type.

GetObjectProp utilises Object Pascal's RTTI (Run Time Type Information) to return the current value of a component's property where that property is an object type.

In one form of this function, the object Instance's property is defined by a PropInfo record. 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 an object, or nil if the property is not an object type.

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