System.TypInfo.GetSetProp

From Appmethod Libraries
Jump to: navigation, search

Object Pascal

function GetSetProp(Instance: TObject; const PropName: string; Brackets: Boolean): string;
function GetSetProp(Instance: TObject; PropInfo: PPropInfo; Brackets: Boolean): string;

C++

extern DELPHI_PACKAGE System::UnicodeString __fastcall GetSetProp(System::TObject* Instance, const System::UnicodeString PropName, bool Brackets = false)/* 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 a set type.

GetSetProp utilises Object Pascal's RTTI (Run Time Type Information) to return the current value of a component's property where that property is a set of values 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 list if set values is returned as a comma separated string. You may optionally set Brackets true so as to enclose this within square brackets, as shown in the IDE for the property.

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