Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

AFAttributeTemplate.IsExcluded Property

  • Last UpdatedNov 18, 2025
  • 3 minute read
AFAttributeTemplate.IsExcluded Property
This property is the default value for the IsExcluded property of the attribute created from this template.

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 AFAttributeTemplate
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: Boolean
The default value for the IsExcluded property of the attribute created from this template. The default value is .

Implements

IAFAttributeIsExcluded

Remarks

When a new AFAttribute is created from this template, the initial value of its IsExcluded property will be set to the value of this property. Then the value can be changed in each attribute instance to indicate if the attribute is being used in the instance. Future changes to this property value will not affect the setting in existing attributes.

When an attribute's IsExcluded property is , then the attribute will be excluded from being returned from search results. It will also not be returned when iterating through an attributes collection, but it will be returned when looked up by name or index from the attributes collection.

Note Notes to Callers
This property can only be set if its Parent is not excluded. Setting this property will also set the property for all child attribute templates.

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

See Also

In This Topic
TitleResults for “How to create a CRG?”Also Available in