AF SDK Reference

AFAnalysis.ResetToTemplate Method

Save PDF

TABLE OF CONTENTS

AFAnalysis.ResetToTemplate Method

Save PDF

Last UpdatedNov 18, 2025
2 minute read

This method will reset the AFAnalysis back to its template default values.

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

Syntax

public bool ResetToTemplate()

Public Function ResetToTemplate As Boolean

Dim instance As AFAnalysis
Dim returnValue As Boolean

returnValue = instance.ResetToTemplate()

public:
bool ResetToTemplate()

member ResetToTemplate : unit -> bool

Return Value

Type: Boolean
Returns if the AFAnalysis was modified and reset back to its template default values. Returns if nothing was modified.

Remarks

This method will reset the analysis's GroupID, OutputTime, TimeRulePlugIn, and the time rule's configuration back to the template's default values. If the analysis is not defined by a Template or it already matches the Template, then this method will not make any changes.

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, 2.6

AF SDK Reference