Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

AFAttributeTemplate.Description Property

  • Last UpdatedNov 18, 2025
  • 2 minute read
AFAttributeTemplate.Description Property
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: String
The 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.

Note Note
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.

Changing the value of this property changes the value of the Description property of all AFAttribute objects created from this template.

Version Information

AFSDK


See Also

In This Topic
TitleResults for “How to create a CRG?”Also Available in