AFAttribute Properties
- Last UpdatedNov 18, 2025
- 6 minute read
- PI System
- AF SDK 2024 R2
- Developer
The AFAttribute type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
| Attributes |
This is a collection of child attributes that have been added to this attribute.
| |
| Categories |
This is a user-defined collection of categories for the object that can be used for
querying and/or reporting purposes.
| |
| CategoriesString |
This read-only property returns the list of categories in a string separated by semicolons.
| |
| ConfigString |
This property returns the current configuration of the attribute's data reference
as a string suitable for displaying to an end-user.
| |
| Data |
This read-only property returns the data access object for this AFAttribute.
| |
| Database |
This read-only property returns the AFDatabase where this object is defined.
| |
| DataReference |
The instance of the data reference used by the AFAttribute to
get and set values in a data source.
| |
| DataReferencePlugIn |
The data reference plugin property is used to specify which
data reference will be used by the AFAttribute to
retrieve and set values in a data source.
| |
| DefaultUOM |
This property defines the default unit of measure (UOM) for the attribute's value.
| |
| Description |
Read/write property that provides a more detailed description of the object.
| |
| DisplayDigits |
The DisplayDigits property controls the format of numeric values on displays and in reports.
| |
| DisplayUOM |
This property returns the display unit of measure (UOM) for the attribute's value.
| |
| Element |
This read-only property returns the AFBaseElement that owns
this AFAttribute.
| |
| HasChildren |
This read-only property returns if the attribute has child attributes.
| |
| 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.) | |
| IsAnyDataMethodSupported |
Returns if the attribute supports any AFDataMethods.
If , data access calls to this AFAttribute can be made via the AFData
instance returned by the Data property.
If , data access should be performed via GetValue Overload or GetValues Overload.
| |
| IsConfigurationItem |
This property determines whether this attribute is a configuration item
for the associated element.
| |
| IsDataReferenceDefinedByTemplate |
This read-only property indicates if this attribute's
DataReference and ConfigString
are fully defined by the AFElementTemplate.
| |
| IsDeleted |
This read-only property indicates whether the object has been deleted.
(Inherited from AFObject.) | |
| IsDynamic |
This property indicates if this attribute is dynamic.
| |
| IsExcluded |
This property determines whether this attribute is excluded for the associated element.
| |
| IsHidden |
This property determines whether this attribute is hidden in client applications.
| |
| IsManualDataEntry |
This property determines whether this attribute is used for manual data entry.
| |
| Name |
This property defines the name that identifies the object.
| |
| Parent |
This read-only property returns the AFAttribute that is the parent
of this attribute.
| |
| PIPoint |
The PIPoint associated with this attribute.
| |
| PISystem |
This read-only property allows access to the PISystem associated with this
object.
(Inherited from AFObject.) | |
| RawPIPoint | Obsolete.
Returns the raw PISDK.PIPoint associated with this attribute.
| |
| ServerTime |
Gets the current time of the server associated with this AFAttribute.
| |
| ServerTimeSource |
Gets the server time source associated with this AFAttribute.
| |
| ServerTimeZone |
Gets the current time zone of the server associated with this AFAttribute.
| |
| SourceUOM |
This property specifies the source unit of measure (UOM) for the attribute's value.
| |
| Step |
This property returns if the attribute's value 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 for
getting and/or setting values are supported.
| |
| Template |
This read-only property returns the AFAttributeTemplate
that was used to create this AFAttribute.
| |
| Trait |
This property specifies the attribute trait for this attribute.
| |
| Type |
This property specifies the type of the attribute's value.
| |
| TypeQualifier |
Specifies a further qualification of the types of values available for this attribute.
| |
| UniqueID |
Read-only property that provides the object's ID as a String.
(Inherited from AFObject.) |
See Also
In This Topic
Related Links
- Attributes Property
- Categories Property
- CategoriesString Property
- ConfigString Property
- Data Property
- Database Property
- DataReference Property
- DataReferencePlugIn Property
- DefaultUOM Property
- Description Property
- DisplayDigits Property
- DisplayUOM Property
- Element Property
- HasChildren Property
- IsAnyDataMethodSupported Property
- IsConfigurationItem Property
- IsDataReferenceDefinedByTemplate Property
- IsDynamic Property
- IsExcluded Property
- IsHidden Property
- IsManualDataEntry Property
- Name Property
- Parent Property
- PIPoint Property
- RawPIPoint Property
- ServerTime Property
- ServerTimeSource Property
- ServerTimeZone Property
- SourceUOM Property
- Step Property
- SupportedContexts Property
- SupportedDataMethods Property
- SupportedMethods Property
- Template Property
- Trait Property
- Type Property
- TypeQualifier Property