C++ Builder 参考手册 ➙ 枚举控件所有的属性、事件和方法
- 获取控件的成员
- 枚举所有的属性和事件
- 枚举所有的方法
- 枚举所有的成员变量
- 完整的例子
一. 获取控件的成员
所有从 TObject 继承的类都可以获取成员信息，不仅仅是控件。
1. 获取 TRttiType
首先使用 TRttiContext 的 GetType 方法获取 TObject 继承的类的类型信息 TRttiType：
TRttiType *GetType(System::TClass AClass);
这个函数的参数是 System::TClass 类型的。
- 如果是从 TObject 继承的类，可以通过 TObject 的 ClassType() 方法获得 System::TClass，例如
Button1->ClassType()； - 如果要通过类型来获取 System::TClass，可以通过 __classid(类型)，例如
__classid(TButton)。
获取 TRttiType * 的完整的写法：
TRttiContext RttiCtx;
TRttiType *pRttiType = RttiCtx.GetType(Button1->ClassType());
或者
TRttiContext RttiCtx;
TRttiType *pRttiType = RttiCtx.GetType(__classid(TButton));
2. 获取属性、事件、方法和变量表
通过 TRttiType 的 GetProperties 方法获取属性和事件表；
通过 TRttiType 的 GetMethods 方法获取方法 (成员函数) 表；
通过 TRttiType 的 GetFields 方法获取成员变量表。
DynamicArray<TRttiProperty *> aProperties = pRttiType->GetProperties();
DynamicArray<TRttiMethod *> aMethods = pRttiType->GetMethods();
DynamicArray<TRttiField *> aFields = pRttiType->GetFields();
二. 枚举所有的属性和事件
通过 TRttiType 的 GetProperties 方法获取属性和事件表放在了 DynamicArray<TRttiProperty *> 动态数组里面，数组的每一个元素是一个 TRttiProperty *。
- 通过 TRttiProperty 的 PropertyType 属性可以获取属性的变量类型；
- 通过 TRttiProperty 的 Name 属性可以获取这个属性的名字；
- 通过 TRttiProperty 的 TValue GetValue(TObject *pObject) 方法，可以获取 pObject 对象的这个属性的属性值。
属性名称和属性的类型是类型的属性，通过类型信息就可以直接获取到，而属性的值是类的每个对象的属性，所以获取属性值必须指定具体的对象。
三. 枚举所有的方法
通过 TRttiType 的 GetMethods 方法获取方法 (成员函数) 表放在了 DynamicArray<TRttiMethod *> 动态数组里面，数组的每一个元素是一个 TRttiMethod *。
- 通过 TRttiMethod 的 Name 属性可以获取这个方法的函数名；
- 通过 TRttiMethod 的 ReturnType 属性可以获取这个方法的函数返回值的类型；
- 通过 TRttiMethod 的 GetParameters 方法可以获取这个方法的函数的每个参数，存放在 DynamicArray<TRttiParameter *> 数组里面；
- 通过 TRttiParameter 的 Name 属性可以获取函数的参数的名称；
- 通过 TRttiParameter 的 ParamType 属性可以获取函数的参数的变量类型。
四. 枚举所有的成员变量
通过 TRttiType 的 GetFields 方法获取成员变量表放在了 DynamicArray<TRttiField *> 动态数组里面，数组的每一个元素是一个 TRttiField *。
- 通过 TRttiField 的 Name 属性可以获取这个变量的变量名；
- 通过 TRttiField 的 FieldType 属性可以获取这个变量的变量类型；
- 通过 TRttiField 的 TValue GetValue(TObject *pObject) 方法，可以获取 pObject 对象的这个变量的变量值。
变量名和变量类型是类型的属性，通过类型信息就可以直接获取到，而变量的值是类的每个对象的属性，所以获取变量值必须指定具体的对象。
五. 完整的例子
- 函数 ShowAllMembers 参数可以是任意从 TObject 继承过来的类的对象，包括控件，可以显示这个对象所有的成员及成员的值；
- 模板函数 EnumValName 把枚举型的值转成这个值的名字的字符串；
- 函数 ValueToStr 把 TValue 值转成字符串；
- 函数 ShowProperties 把属性显示到 Memo1 里面，把事件显示到 Memo2 里面；
- 函数 ShowMethods 把方法显示到 Memo3 里面；
- 函数 ShowFields 把变量显示到 Memo4 里面。
这个例子显示 Edit1 编辑框的所有的成员，包括属性、事件、方法、变量，如果要显示其他控件的成员，只需要 ShowAllMembers 的参数改成要显示的控件就可以了。
void __fastcall TForm1::Button1Click(TObject *Sender)
{
ShowAllMembers(Edit1);
}
//---------------------------------------------------------------------------
template<class T>
UnicodeString EnumValName(T t)
{
return Typinfo::GetEnumName(__delphirtti(T), (int)t);
}
//---------------------------------------------------------------------------
UnicodeString ValueToStr(TValue &Val)
{
UnicodeString sValue;
try
{
if(Val.IsEmpty)
{
sValue = L"NULL";
}
else
{
sValue = Val.ToString();
}
}
catch(Exception &e)
{
sValue = L"Error (" + e.ClassName() + L"): " + e.Message;
}
return sValue;
}
//---------------------------------------------------------------------------
void TForm1::ShowAllMembers(TObject *pObject)
{
TRttiContext RttiCtx;
TRttiType *pRttiType = RttiCtx.GetType(pObject->ClassType());
if(pRttiType)
{
DynamicArray<TRttiProperty *> aProperties = pRttiType->GetProperties();
DynamicArray<TRttiMethod *> aMethods = pRttiType->GetMethods();
DynamicArray<TRttiField *> aFields = pRttiType->GetFields();
ShowProperties(pObject, aProperties);
ShowMethods(pObject, aMethods);
ShowFields(pObject, aFields);
}
}
//---------------------------------------------------------------------------
void TForm1::ShowProperties(TObject *pObject, DynamicArray<TRttiProperty *> &aProperties)
{
for(int i=0; i<aProperties.Length; i++)
{
TRttiProperty *pProperty = aProperties[i];
TTypeKind TpKind = pProperty->PropertyType->TypeKind; // 属性的类型
UnicodeString sName = pProperty->Name; // 属性的名字
UnicodeString sValue;
try
{
TValue Val = pProperty->GetValue(pObject);
sValue = ValueToStr(Val);
}
catch(Exception &e)
{
sValue = L"Error (" + e.ClassName() + L"): " + e.Message;
}
if(TpKind == tkMethod) // 事件
Memo2->Lines->Add(sName + L" = " + sValue);
else // 属性
Memo1->Lines->Add(sName + L" = " + sValue);
}
}
//---------------------------------------------------------------------------
void TForm1::ShowMethods(TObject *pObject, DynamicArray<TRttiMethod *> &aMethods)
{
for(int iMethodIdx=0; iMethodIdx<aMethods.Length; iMethodIdx++)
{
TRttiMethod *pMethod = aMethods[iMethodIdx];
UnicodeString sMethodName = pMethod->Name;
DynamicArray<TRttiParameter *> aParameters = pMethod->GetParameters();
UnicodeString sRetType;
if(pMethod->ReturnType)
{
TTypeKind tRetKind = pMethod->ReturnType->TypeKind;
sRetType = EnumValName(tRetKind);
}
else
{
sRetType = L"void";
}
UnicodeString sMethodStr = sRetType + L" " + sMethodName + L"(";
for(int iParamIdx=0; iParamIdx<aParameters.Length; iParamIdx++)
{
TRttiParameter *pParameter = aParameters[iParamIdx];
UnicodeString sPmName = pParameter->Name;
UnicodeString sPmType;
if(pParameter->ParamType)
{
TTypeKind tPmKind = pParameter->ParamType->TypeKind;
sPmType = EnumValName(tPmKind);
}
else
{
sPmType = L"void *";
}
if(iParamIdx)
sMethodStr += L", ";
sMethodStr += sPmType + L" " + sPmName;
}
sMethodStr += L");";
Memo3->Lines->Add(sMethodStr);
}
}
//---------------------------------------------------------------------------
void TForm1::ShowFields(TObject *pObject, DynamicArray<TRttiField *> &aFields)
{
for(int i=0; i<aFields.Length; i++)
{
TRttiField *pField = aFields[i];
UnicodeString sName = pField->Name;
UnicodeString sValue;
try
{
TValue Val = pField->GetValue(pObject);
sValue = ValueToStr(Val);
}
catch(Exception &e)
{
sValue = L"Error (" + e.ClassName() + L"): " + e.Message;
}
Memo4->Lines->Add(sName + L" = " + sValue);
}
}
//---------------------------------------------------------------------------
运行结果：
运行结果：Edit1 的属性
运行结果：Edit1 的事件
运行结果：Edit1 的方法
运行结果：Edit1 的变量
相关：
C++ Builder 参考手册 ➙ 枚举控件所有的属性、事件和方法
