AF SDK Reference

AFSearchValueToken Class

Save PDF

TABLE OF CONTENTS

AFSearchValueToken Class

Save PDF

Last UpdatedNov 18, 2025
5 minute read

Represents an attribute value query for AFSearch based searches.

Inheritance Hierarchy

SystemObject
  OSIsoft.AF.SearchAFSearchTokenBase
    OSIsoft.AF.SearchAFSearchFilterToken
      OSIsoft.AF.SearchAFSearchValueToken

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

Syntax

public class AFSearchValueToken : AFSearchFilterToken, 
	IEquatable<AFSearchValueToken>

Public Class AFSearchValueToken
	Inherits AFSearchFilterToken
	Implements IEquatable(Of AFSearchValueToken)

Dim instance As AFSearchValueToken

public ref class AFSearchValueToken : public AFSearchFilterToken, 
	IEquatable<AFSearchValueToken^>

type AFSearchValueToken =  
    class
        inherit AFSearchFilterToken
        interface IEquatable<AFSearchValueToken>
    end

The AFSearchValueToken type exposes the following members.

Constructors

	Name	Description
	AFSearchValueToken(String, String, AFSearchValueType, String)	Creates an AFSearchValueToken instance for the Path and Values. Optionally, the Operator, ValueType, and ValueTypeQualifier may be set.
	AFSearchValueToken(String, String, AFSearchOperator, AFSearchValueType, String)	Creates an AFSearchValueToken instance for the Path and Value. Optionally, the Operator, ValueType, and ValueTypeQualifier may be set.

Properties

	Name	Description
	Filter	The filter to be searched with the current token. (Inherited from AFSearchTokenBase.)
	Operator	The search operator to perform on the search filter with the specified Value or Values. (Inherited from AFSearchFilterToken.)
	Path	The path of an attribute, relative to an element.
	Value	The value to compare the search filter on using the specified Operator. (Inherited from AFSearchFilterToken.)
	Values	The array of values to compare the search filter on using the specified Operator. (Inherited from AFSearchFilterToken.)
	ValueType	This is the value type of the specified Value.
	ValueTypeQualifier	This is a qualifier for the ValueType property.

Methods

	Name	Description
	Equals(Object)	Determines whether the specified Object is equal to the current object. (Overrides AFSearchFilterTokenEquals(Object).)
	Equals(AFSearchFilterToken)	Indicates whether the current object is equal to another object of the same type. (Overrides AFSearchFilterTokenEquals(AFSearchFilterToken).)
	Equals(AFSearchTokenBase)	Indicates whether the current object is equal to another object of the same type. (Overrides AFSearchFilterTokenEquals(AFSearchTokenBase).)
	Equals(AFSearchValueToken)	Indicates whether the current object is equal to another object of the same type.
	GetHashCode	Gets the hash code for this instance of the object which is suitable for use in hashing algorithms and data structures like a hash table. (Overrides AFSearchFilterTokenGetHashCode.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a String that represents the current object. (Overrides AFSearchFilterTokenToString.)

Remarks

This class represents an attribute value query for AFSearch based searches.

The AFSearchFilter, AFSearchOperator, and AFSearchValueType topics provide more information about the filters and operators that can be used in a search token.

Examples

// The following query string and code will generate the same token collections.
IList<AFSearchTokenBase> tokensParsed = AFSearch.ParseQueryString("|Level:50 Name:'Tank*'");
IList<AFSearchTokenBase> tokens = new AFSearchTokenBase[]
{
    new AFSearchValueToken("|Level", "50"),
    new AFSearchFilterToken(AFSearchFilter.Name, "Tank*")
};

' The following query string and code will generate the same token collections.
Dim tokensParsed As IList(Of AFSearchTokenBase) = AFSearch.ParseQueryString("|Level:50 Name:'Tank*'")
Dim tokens As IList(Of AFSearchTokenBase) = New AFSearchTokenBase() {
    New AFSearchValueToken("|Level", "50"),
    New AFSearchFilterToken(AFSearchFilter.Name, "Tank*")
    }

No code example is currently available or this language may not be supported.

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

AF SDK Reference