AF SDK Reference

AFNotificationContact.Description Property

Save PDF

TABLE OF CONTENTS

AFNotificationContact.Description Property

Save PDF

Last UpdatedNov 18, 2025
2 minute read

Read/write property that provides a more detailed description of the object.

Namespace: OSIsoft.AF.Notification
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 AFNotificationContact
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

IAFNotificationContactDescription

Remarks

If this notification contact was created from an AFNotificationContactTemplate or an AFNotificationTemplate, then the value of this property is defined by the template and cannot be changed. In this case when the value is defined by a template, then changing the template's Description property will also change the value of this property. If the notification contact was NOT created from a template, then this property can be modified.

AF SDK Reference