AFAttribute.IsExcluded Property
- Last UpdatedNov 18, 2025
- 3 minute read
- PI System
- AF SDK 2024 R2
- Developer
This property determines whether this attribute is excluded for the associated element.
Namespace: OSIsoft.AF.Asset
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public bool IsExcluded { get; set; }
Public Property IsExcluded As Boolean Get Set Dim instance As AFAttribute Dim value As Boolean value = instance.IsExcluded instance.IsExcluded = value
public: virtual property bool IsExcluded { bool get () sealed; void set (bool value) sealed; }
abstract IsExcluded : bool with get, set override IsExcluded : bool with get, set
Property Value
Type: BooleanDetermines whether this attribute is excluded for the associated element. The initial value of this property is determined by the IsExcluded property of the attribute template but can be changed in the attribute instance. Changing the AFAttributeTemplate.IsExcluded property will not change the value of this property.
Implements
IAFAttributeIsExcluded
Remarks
Unless the ShowExcludedAttributes is , an excluded attribute will not be returned when iterating through the Attributes collection. Excluded attributes will always be returned when using any lookup (e.g. when looked up by name, ID, or index) in the attributes collection. Excluded attributes are not returned by the Find methods when looking up attributes by path unless the ShowExcludedAttributes is .
| This property can only be set if the attribute was created from an AFAttributeTemplate and its Parent is not excluded. If the attribute was NOT created from a template, then the attribute should just be deleted in order to have it excluded from the element. Setting this property will also set the property for all child attributes. |