Port CollectionComponent Description Property
Gets and sets the description of the component.
Definition
Namespace: CapeOpen
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
The description of the component.
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
C#
public string ComponentDescription { get; set; }VB
Public Property ComponentDescription As String
Get
SetProperty Value
StringThe description of the component.
Implements
ICapeIdentificationComponentDescriptionRemarks
A particular Use Case in a system may contain several CAPE-OPEN components of the same class. The user should be able to assign different names and descriptions to each instance in order to refer to them unambiguously and in a user-friendly way. Since not always the software components that are able to set these identifications and the software components that require this information have been developed by the same vendor, a CAPE-OPEN standard for setting and getting this information is required.
So, the component will not usually set its own name and description: the user of the component will do it.
Exceptions
| ECapeUnknown | The error to be raised when other error(s), specified for this operation, are not suitable. |