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

AF SDK Reference

AFAttribute.IsHidden Property

  • Last UpdatedNov 18, 2025
  • 3 minute read
AFAttribute.IsHidden Property
This property determines whether this attribute is hidden in client applications.

Namespace:  OSIsoft.AF.Asset
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public bool IsHidden { get; set; }
Public Property IsHidden As Boolean
	Get
	Set

Dim instance As AFAttribute
Dim value As Boolean

value = instance.IsHidden

instance.IsHidden = value
public:
virtual property bool IsHidden {
	bool get () sealed;
	void set (bool value) sealed;
}
abstract IsHidden : bool with get, set
override IsHidden : bool with get, set

Property Value

Type: Boolean
Determines whether this attribute is hidden in client applications. The default value is if the attribute is not created from a template.

Implements

IAFAttributeIsHidden

Exceptions

ExceptionCondition
InvalidOperationException Cannot set this property if the attribute is defined by a template.

Remarks

This property is used to indicate to client applications whether the attribute should be displayed to the user in normal viewing situations. Some applications may ignore this setting or choose to toggle viewing of hidden attributes on or off. If this property is , then client applications that honor this setting will not display the attribute.

If this attribute was created from an AFAttributeTemplate, then the value of this property is defined by the template and cannot be changed. In this case, changing the AFAttributeTemplate.IsHidden property also changes the value of this property. If the attribute was NOT created from a template, then this property can be modified and defaults to a value of .

Note Notes to Callers
This property can only be set if its Parent is not hidden and not defined by a template. Setting this property will also set the property for all child attributes.

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