AFAttributeTemplate.Description Property
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
Read/write property that provides a more detailed description of the object.
Namespace: OSIsoft.AF.Asset
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public string Description { get; set; }
Public Property Description As String Get Set Dim instance As AFAttributeTemplate 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
Type: StringThe detailed description of the object. The maximum length of this property is 1000 characters.
Implements
IAFAttributeDescription
Remarks
Any attributes created from this template will have its Description defined by the value of this property unless it is modified to be different from the template value. If the attribute's description is defined by this template, then changing the value of this property will also change the attribute's description.
| If the value of the attribute is defined by this template, then setting the value of attribute's description to be the same as the template's value or an empty string will reset it back to be defined by the template's value. Calling ResetToTemplate can also be used to reset all attribute settings back to the template default values. |