AnyCAD::API::PropertiesElement类 参考

Support user defined parameters and script. 更多...

#include <APIPropertiesElement.h>

类 AnyCAD::API::PropertiesElement 继承关系图:

Public 成员函数
void	AddParameter (ParameterId paramId, const ParameterValue &pParameter)
ParameterValue	RemoveParameter (ParameterId paramId)
void	AddParameterUI (ParameterId paramId, const ParameterUI &pParameterUI)
ParameterUI	GetParameterUI (ParameterId paramId) const
ParameterUI	RemoveParameterUI (ParameterId paramId)
ParameterUISet	GetParameterUISet () const
virtual ParameterValue	GetParameterValue (ParameterId paramId) const
virtual bool	SetParameterValue (ParameterId paramId, const ParameterValue &pValue)
Public 成员函数 继承自 AnyCAD::API::Element
ElementId	GetId () const
String	GetName () const
void	SetName (const String &strName)
String	GetCategory () const
void	SetCategory (const String &category)
ParameterUISet	GetSystemParameterUISet () const
Document	GetOwnerDocument () const
Public 成员函数 继承自 AnyCAD::API::Object
String	GetObjectClassId () const
StringList	ListParentClassIds () const

详细描述

Support user defined parameters and script.

TODO:

成员函数说明

void AnyCAD::API::PropertiesElement::AddParameter	(	ParameterId	paramId,
		const ParameterValue &	pParameter
	)

Add customized parameter. Use GetParameterValue to get the parameter value.

参数

paramId	the parameter id.
pParameter	the parameter value

void AnyCAD::API::PropertiesElement::AddParameterUI	(	ParameterId	paramId,
		const ParameterUI &	pParameterUI
	)

Add customized ParameterUI.

参数

paramId	the parameter id.
pParameterUI	the ParameterUI

ParameterUI AnyCAD::API::PropertiesElement::GetParameterUI

(

ParameterId

paramId

)

const

Get ParameterUI.

参数

paramId

the parameter id.

返回

the ParameterUI.

ParameterUISet AnyCAD::API::PropertiesElement::GetParameterUISet

(

)

const

Get all of the user defined ParameterUI.

返回

the ParameterUISet.

virtual ParameterValue AnyCAD::API::PropertiesElement::GetParameterValue ( ParameterId  paramId ) const

virtual

Get the parameter value

参数

paramId

the parameter id.

返回

the parameter value. null if failed to get the value.

重载 AnyCAD::API::Element .

ParameterValue AnyCAD::API::PropertiesElement::RemoveParameter

(

ParameterId

paramId

)

Remove customized parameter

参数

paramId

the parameter id.

返回

the parameter value

ParameterUI AnyCAD::API::PropertiesElement::RemoveParameterUI

(

ParameterId

paramId

)

Remove customized ParameterUI.

参数

paramId

the parameter id.

返回

the ParameterUI

virtual bool AnyCAD::API::PropertiesElement::SetParameterValue ( ParameterId  paramId, const ParameterValue &  pValue  )

virtual

Set the parameter value

参数

paramId	the parameter id.
pValue	the parameter value

返回

false if failed to set the value

重载 AnyCAD::API::Element .

---

该类的文档由以下文件生成:

• E:/Depot/sdk.cpp.ent/inc/Core/APIPropertiesElement.h