AF SDK Reference

AFSearch.ObjectFieldAttribute Class

Save PDF

TABLE OF CONTENTS

AFSearch.ObjectFieldAttribute Class

Save PDF

Last UpdatedNov 18, 2025
4 minute read

Attribute used on a field or property to specify the object field mapping.

Inheritance Hierarchy

SystemObject
SystemAttribute
OSIsoft.AF.SearchAFSearchObjectFieldAttribute

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

Syntax

[AttributeUsageAttribute(AttributeTargets.Property|AttributeTargets.Field, Inherited = true, 
	AllowMultiple = false)]
public sealed class ObjectFieldAttribute : Attribute

<AttributeUsageAttribute(AttributeTargets.Property Or AttributeTargets.Field, Inherited := true, 
	AllowMultiple := false)>
Public NotInheritable Class ObjectFieldAttribute
	Inherits Attribute

Dim instance As AFSearch.ObjectFieldAttribute

[AttributeUsageAttribute(AttributeTargets::Property|AttributeTargets::Field, Inherited = true, 
	AllowMultiple = false)]
public ref class ObjectFieldAttribute sealed : public Attribute

[<SealedAttribute>]
[<AttributeUsageAttribute(AttributeTargets.Property|AttributeTargets.Field, Inherited = true, 
	AllowMultiple = false)>]
type ObjectFieldAttribute =  
    class
        inherit Attribute
    end

The AFSearchObjectFieldAttribute type exposes the following members.

Constructors

	Name	Description
	AFSearchObjectFieldAttribute	Initializes a new instance of the AFSearchObjectFieldAttribute class.

Properties

	Name	Description
	TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
	Value	Gets the object field name that maps to this field or property.

Methods

	Name	Description
	Equals	Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
	GetHashCode	Returns the hash code for this instance. (Inherited from Attribute.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsDefaultAttribute	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
	Match	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Remarks

The FindObjectFieldsTObject(Int32, Int32) method is used to return specific fields of an object in the specified object type. If the fields and/or properties in the type do not match the object field names, then this Attribute must be used to specify the mapping from the object field name to the associated field or property.

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

AF SDK Reference