AFAttribute.Description Property

public string Description { get; set; }

Public Property Description As String
	Get
	Set

Dim instance As AFAttribute
Dim value As String

value = instance.Description

instance.Description = value

public:
virtual property String^ Description {
	String^ get () sealed;
	void set (String^ value) sealed;
}

abstract Description : string with get, set
override Description : string with get, set

Property Value

Implements

The attribute's description can be modified if it is not defined by an AFAttributeTemplate or the server supports overriding a description defined by a template. You can call the Supports(PISystemFeatures) method to determine if the ModifyAttributeDescription feature is supported by the server.

Caution
Caution should be used when overriding the description defined by the template because it increases the memory requirement for each attribute.

If this attribute was created from an AFAttributeTemplate, then the value of this property is defined by the template's Description unless it is modified to be different from the template value. When the value is defined by a template, then changing the template's Description property will also change the value of this property of the AFAttribute.

Important
If the attribute was created from an AFAttributeTemplate and the description was overridden, then setting the value of this property to be the same as the template's value or an empty string will reset it back to being defined by the template's value. Calling ResetToTemplate can also be used to reset all settings back to the template default values.

AFSDK

Reference