AFNameSubstitution Class
- Last UpdatedNov 18, 2025
- 3 minute read
- PI System
- AF SDK 2024 R2
- Developer
This class provides support for the name substitution used with
setting the names of objects.
Inheritance Hierarchy
SystemObject
OSIsoft.AFAFNameSubstitution
OSIsoft.AFAFNameSubstitution
Namespace: OSIsoft.AF
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public static class AFNameSubstitution
Public NotInheritable Class AFNameSubstitution You do not need to declare an instance of a static class in order to access its members.
public ref class AFNameSubstitution abstract sealed
[<AbstractClassAttribute>] [<SealedAttribute>] type AFNameSubstitution = class end
The AFNameSubstitution type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
  | GetSubstitutionList |
Gets the list of supported name substitutions.
|
| ResolveName(AFObject, String, IFormatProvider) |
Resolves the substitution fields within the new name for the specified object.
|
| ResolveName(AFObject, IAFDataProvider, String, IFormatProvider) |
Resolves the substitution fields within the new name for the specified object and IAFDataProvider.
|
| ResolveName(AFObject, Object, IAFDataProvider, String, IFormatProvider) |
Resolves the substitution fields within the new name for the specified object, time context, and IAFDataProvider.
|
Remarks
Name substitution is used when resolving the naming pattern specified
in the AFElementTemplateNamingPattern
property. The ResolveName
method can be used to resolve object names when setting an object's Name property.
See AFNameSubstitutionType for description of the substitution fields.