AFDataReference Properties
- Last UpdatedNov 18, 2025
- 5 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFDataReference type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
| Attribute |
This property returns the attribute that owns this object.
| |
| ConfigString |
This property represents the current configuration of the Data Reference as a string suitable
for displaying to an end-user and/or setting its configuration.
| |
| ConfigStringStored |
Returns the currently stored configuration string.
| |
| Database |
This read-only property returns the AFDatabase where this object is defined.
| |
| Description |
Read-only property that provides more detailed description of the object.
| |
| DisplayDigits |
The DisplayDigits property controls the format of numeric values on displays and in reports.
| |
| EditorType |
This method returns the Type of the editor that is used to configure this
data reference.
| |
| ID |
Read-only property that provides a unique identifier for the object to be used for
quick access that is not dependent upon the index.
(Inherited from AFObject.) | |
| Identity |
This read-only property contains identity of the object.
(Inherited from AFObject.) | |
| IsConfigured |
This method returns if the DR instance is properly configured.
| |
| IsDeleted |
This read-only property indicates whether the object has been deleted.
(Inherited from AFObject.) | |
| IsInitializing |
Indicates that the AFDataReference is in the process
of being initialized.
| |
| Name |
Read-only property that identifies the name of the object.
| |
| Path |
This read-only property returns the path name to this object.
| |
| PIPoint |
Returns the PIPoint associated with this AFDataReference.
| |
| PISystem |
This read-only property allows access to the PISystem associated with this
object.
(Inherited from AFObject.) | |
| PlugIn |
This read-only property returns the AFPlugIn used to create
this instance of the plugin.
| |
| ServerTime |
Gets the current time of the server associated with this AFDataReference.
| |
| ServerTimeSource |
Gets the server time source associated with this AFDataReference.
| |
| ServerTimeZone |
Gets the current time zone of the server associated with this AFDataReference.
| |
| Span |
This property represents the span of values for this AFDataReference.
| |
| Step |
This property returns if the value returned for this
AFDataReference is stepped.
| |
| SupportedContexts |
This read-only property specifies which of the data reference contexts are
supported when getting and/or setting values.
| |
| SupportedDataMethods |
This read-only property specifies which of the data methods are supported by
the data reference.
| |
| SupportedMethods |
This read-only property specifies which of the data reference methods are supported.
| |
| Template |
This property returns the attribute template that owns this object.
| |
| UniqueID |
Read-only property that provides the object's ID as a String.
(Inherited from AFObject.) | |
| UOM |
This property represents the source unit of measure (UOM) for the values
represented by the DataReference.
| |
| ValueEditorType |
This method returns the Type of the editor that is used to display and modify a value
provided by this data reference.
| |
| Zero |
This property represents the zero or low range value for this AFDataReference.
|
See Also
In This Topic
Related Links
- Attribute Property
- ConfigString Property
- ConfigStringStored Property
- Database Property
- Description Property
- DisplayDigits Property
- EditorType Property
- IsConfigured Property
- IsInitializing Property
- Name Property
- Path Property
- PIPoint Property
- PlugIn Property
- ServerTime Property
- ServerTimeSource Property
- ServerTimeZone Property
- Span Property
- Step Property
- SupportedContexts Property
- SupportedDataMethods Property
- SupportedMethods Property
- Template Property
- UOM Property
- ValueEditorType Property
- Zero Property