hyperx.api.DesignProperty Class Reference

Inheritance diagram for hyperx.api.DesignProperty:

Public Member Functions
	__init__ (self, _api.DesignProperty designProperty)
PropertyAssignmentStatus	AssignTo (self, tuple[int] entityIds)
	Assigns the hyperx.api.DesignProperty to a collection of entityIds where the entity type is determined by the hyperx.api.AssignablePropertyWithFamilyCategory.FamilyCategory property.
DesignProperty	Copy (self, str newName=None)
	Creates and returns a copy of this hyperx.api.DesignProperty.
Public Member Functions inherited from hyperx.api.AssignablePropertyWithFamilyCategory
	__init__ (self, _api.AssignablePropertyWithFamilyCategory assignablePropertyWithFamilyCategory)
Public Member Functions inherited from hyperx.api.AssignableProperty
	__init__ (self, _api.AssignableProperty assignableProperty)
Public Member Functions inherited from hyperx.api.IdNameEntity
	__init__ (self, _api.IdNameEntity idNameEntity)
Public Member Functions inherited from hyperx.api.IdEntity
	__init__ (self, _api.IdEntity idEntity)

Additional Inherited Members
Protected Attributes inherited from hyperx.api.IdEntity
	_Entity = idEntity
Properties inherited from hyperx.api.AssignablePropertyWithFamilyCategory
	FamilyCategory = property
Properties inherited from hyperx.api.IdNameEntity
	Name = property
Properties inherited from hyperx.api.IdEntity
	Id = property

Constructor & Destructor Documentation

__init__()

hyperx.api.DesignProperty.__init__	(		self,
		_api.DesignProperty	designProperty )

Member Function Documentation

AssignTo()

PropertyAssignmentStatus hyperx.api.DesignProperty.AssignTo	(		self,
		tuple[int]	entityIds )

Assigns the hyperx.api.DesignProperty to a collection of entityIds where the entity type is determined by the hyperx.api.AssignablePropertyWithFamilyCategory.FamilyCategory property.

Returns

hyperx.api.PropertyAssignmentStatus.Success if the operation executes successfully.

Copy()

DesignProperty hyperx.api.DesignProperty.Copy	(		self,
		str	newName = None )

Creates and returns a copy of this hyperx.api.DesignProperty.

Returns

The new copied hyperx.api.DesignProperty.

---

The documentation for this class was generated from the following file:

• C:/Dev/HyperX/HyperX/HyperX.Scripting.Wrapper/hyperx/api/__init__.py