AF SDK Reference

AFAnalysisRule.DisplayString Property

Save PDF

TABLE OF CONTENTS

AFAnalysisRule.DisplayString Property

Save PDF

Last UpdatedNov 18, 2025
2 minute read

Returns the configuration of the AFAnalysisRule for display purposes.

Namespace: OSIsoft.AF.Analysis
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public virtual string DisplayString { get; }

Public Overridable ReadOnly Property DisplayString As String
	Get

Dim instance As AFAnalysisRule
Dim value As String

value = instance.DisplayString

public:
virtual property String^ DisplayString {
	String^ get ();
}

abstract DisplayString : string with get
override DisplayString : string with get

Property Value

Type: String
Returns the configuration of the AFAnalysisRule a string for display purposes. Unlike ConfigString, it does not necessarily contain all the configuration information, but only what is relevant for presenting the configuration in user interface.

Remarks

Unless overridden it returns ToString.

Version Information

AFSDK

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5, 2.10.0, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7

AF SDK Reference