DesignEditors.TPropertyEditor.GetEditValue
Delphi
function GetEditValue(out Value: string): Boolean; overload;
function GetEditValue(out Value: WideString): Boolean; overload;
C++
bool __fastcall GetEditValue(/* out */ System::UnicodeString &Value)/* overload */;
bool __fastcall GetEditValue(/* out */ System::WideString &Value)/* overload */;
Properties
| Type | Visibility | Source | Unit | Parent |
|---|---|---|---|---|
| function | protected | DesignEditors.pas DesignEditors.hpp |
DesignEditors | TPropertyEditor |
Description
Retrieves a string to represent the property's value, or, if the value is not available, an error message.
The Object Inspector calls GetEditValue (through the IProperty interface) to obtain the string it displays as the property value.
GetValue formats the string displayed in the Object Inspector to represent the property value and returns it as the Value parameter. Unlike the GetValue method, which is the read access method for the Value property, GetEditValue does not raise an exception when the property value is unavailable. Instead, it assigns an error message to Value and returns false.
GetValue returns true if Value returns a string representation of the property value.
Note: GetEditValue is not a virtual method. To provide a method that supplies the string that appears in the Object Inspector, override the GetValue method instead. GetEditValue calls GetValue to fetch this string.