RAD Studio VCL Reference
ContentsIndex
PreviousUpNext
TypInfo.SetVariantProp Function

Sets the value of a component property that is a variant type.

Pascal
procedure SetVariantProp(Instance: TObject; const PropName: string; const Value: Variant); overload;
procedure SetVariantProp(Instance: TObject; PropInfo: PPropInfo; const Value: Variant); overload;
C++
SetVariantProp(TObject * Instance, const AnsiString PropName, const Variant Value);
SetVariantProp(TObject * Instance, PPropInfo PropInfo, const Variant Value);

SetVariantProp utilises Delphi's RTTI (Run Time Type Information) to set the value of a component's property where that property is a variant 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 new property value is defined by Value.  

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

Use SetPropValue to set a property value where the type is unknown. This would normally be used when using GetPropValue from another property.

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

 

Copyright(C) 2009 Embarcadero Technologies, Inc. All Rights Reserved.
What do you think about this topic? Send feedback!