Class Operator

Defines a CAML operator. This is an abstract class. To instanciate an operator use public static methods.

Inheritance

System.Object

Statement

Operator

Inherited Members

Statement.GetCaml()

Namespace: CamlBuilder

Assembly: PnP.Framework.dll

Syntax

public abstract class Operator : Statement

Constructors

Operator(OperatorType, FieldReference)

Declaration

protected Operator(OperatorType operatorType, FieldReference fieldRef)

Parameters

OperatorType operatorType

FieldReference fieldRef

Properties

FieldReference

Gets the name of the field on which this operator acts on.

Declaration

public FieldReference FieldReference { get; }

Property Value

FieldReference

OperatorType

Gets the operator type.

Declaration

public OperatorType OperatorType { get; }

Property Value

OperatorType

Methods

BeginsWith(FieldReference, Value)

Instanciates a new BeginsWith operator which will perform on specified fieldRef.

Declaration

public static Operator BeginsWith(FieldReference fieldRef, Value value)

Parameters

FieldReference fieldRef Reference to the field to operate on.

Value value Value against which the value returned by the field element is compared to.

Returns

Operator BeginsWith operator instance.

BeginsWith(FieldReference, ValueType, Object)

Instanciates a new BeginsWith operator which will perform on specified fieldRef.

Declaration

public static Operator BeginsWith(FieldReference fieldRef, ValueType valueType, object value)

Parameters

FieldReference fieldRef Reference to the field to operate on.

ValueType valueType Field type

System.Object value Value against which the value returned by the field element is compared to.

Returns

Operator BeginsWith operator instance.

Contains(FieldReference, Value)

Instanciates a new Contains operator which will perform on specified fieldRef.

Declaration

public static Operator Contains(FieldReference fieldRef, Value value)

Parameters

FieldReference fieldRef Reference to the field to operate on.

Value value Value against which the value returned by the field element is compared to.

Returns

Operator Contains operator instance.

Contains(FieldReference, ValueType, Object)

Instanciates a new Contains operator which will perform on specified fieldRef.

Declaration

public static Operator Contains(FieldReference fieldRef, ValueType valueType, object value)

Parameters

FieldReference fieldRef Reference to the field to operate on.

ValueType valueType Field type

System.Object value Value against which the value returned by the field element is compared to.

Returns

Operator Contains operator instance.

DateRangesOverlap(FieldReference, Value)

Instanciates a new DateRangesOverlap operator which will perform on specified fieldRef.

Declaration

public static Operator DateRangesOverlap(FieldReference fieldRef, Value value)

Parameters

FieldReference fieldRef Reference to the field to operate on.

Value value Value against which the value returned by the field element is compared to.

Returns

Operator DateRangesOverlap operator instance.

DateRangesOverlap(FieldReference, ValueType, Object)

Instanciates a new DateRangesOverlap operator which will perform on specified fieldRef.

Declaration

public static Operator DateRangesOverlap(FieldReference fieldRef, ValueType valueType, object value)

Parameters

FieldReference fieldRef Reference to the field to operate on.

ValueType valueType Field type

System.Object value Value against which the value returned by the field element is compared to.

Returns

Operator DateRangesOverlap operator instance.

Equal(FieldReference, Value)

Instanciates a new Equal operator which will perform on specified fieldRef.

Declaration

public static Operator Equal(FieldReference fieldRef, Value value)

Parameters

FieldReference fieldRef Reference to the field to operate on.

Value value Value against which the value returned by the field element is compared to.

Returns

Operator Equal operator instance.

Equal(FieldReference, ValueType, Object)

Instanciates a new Equal operator which will perform on specified fieldRef.

Declaration

public static Operator Equal(FieldReference fieldRef, ValueType valueType, object value)

Parameters

FieldReference fieldRef Reference to the field to operate on.

ValueType valueType Field type

System.Object value Value against which the value returned by the field element is compared to.

Returns

Operator Equal operator instance.

GreaterThan(FieldReference, Value)

Instanciates a new GreaterThan operator which will perform on specified fieldRef.

Declaration

public static Operator GreaterThan(FieldReference fieldRef, Value value)

Parameters

FieldReference fieldRef Reference to the field to operate on.

Value value Value against which the value returned by the field element is compared to.

Returns

Operator GreaterThan operator instance.

GreaterThan(FieldReference, ValueType, Object)

Instanciates a new GreaterThan operator which will perform on specified fieldRef.

Declaration

public static Operator GreaterThan(FieldReference fieldRef, ValueType valueType, object value)

Parameters

FieldReference fieldRef Reference to the field to operate on.

ValueType valueType Field type

System.Object value Value against which the value returned by the field element is compared to.

Returns

Operator GreaterThan operator instance.

GreaterThanOrEqualTo(FieldReference, Value)

Instanciates a new GreaterThanOrEqualTo operator which will perform on specified fieldRef.

Declaration

public static Operator GreaterThanOrEqualTo(FieldReference fieldRef, Value value)

Parameters

FieldReference fieldRef Reference to the field to operate on.

Value value Value against which the value returned by the field element is compared to.

Returns

Operator GreaterThanOrEqualTo operator instance.

GreaterThanOrEqualTo(FieldReference, ValueType, Object)

Instanciates a new GreaterThanOrEqualTo operator which will perform on specified fieldRef.

Declaration

public static Operator GreaterThanOrEqualTo(FieldReference fieldRef, ValueType valueType, object value)

Parameters

FieldReference fieldRef Reference to the field to operate on.

ValueType valueType Field type

System.Object value Value against which the value returned by the field element is compared to.

Returns

Operator GreaterThanOrEqualTo operator instance.

In(FieldReference, IEnumerable<Value>)

Instanciates a new In operator which will perform on specified fieldRef.

Declaration

public static Operator In(FieldReference fieldRef, IEnumerable<Value> values)

Parameters

FieldReference fieldRef Reference to the field to operate on.

IEnumerable<Value> values Values against which the value returned by the field element is compared to.

Returns

Operator In operator instance.

Includes(FieldReference, Value)

Instanciates a new Includes operator which will perform on specified fieldRef.

Declaration

public static Operator Includes(FieldReference fieldRef, Value value)

Parameters

FieldReference fieldRef Reference to the field to operate on.

Value value Value against which the value returned by the field element is compared to.

Returns

Operator Includes operator instance.

Includes(FieldReference, ValueType, Object)

Instanciates a new Includes operator which will perform on specified fieldRef.

Declaration

public static Operator Includes(FieldReference fieldRef, ValueType valueType, object value)

Parameters

FieldReference fieldRef Reference to the field to operate on.

ValueType valueType Field type

System.Object value Value against which the value returned by the field element is compared to.

Returns

Operator Includes operator instance.

IsNotNull(FieldReference)

Instanciates a new IsNotNull operator to perform on specified fieldRef.

Declaration

public static Operator IsNotNull(FieldReference fieldRef)

Parameters

FieldReference fieldRef Reference to the field to operate on.

Returns

Operator IsNotNull operator instance.

IsNull(FieldReference)

Instanciates a new IsNull operator to perform on specified fieldRef.

Declaration

public static Operator IsNull(FieldReference fieldRef)

Parameters

FieldReference fieldRef Reference to the field to operate on.

Returns

Operator IsNull operator instance.

LowerThan(FieldReference, Value)

Instanciates a new LowerThan operator which will perform on specified fieldRef.

Declaration

public static Operator LowerThan(FieldReference fieldRef, Value value)

Parameters

FieldReference fieldRef Reference to the field to operate on.

Value value Value against which the value returned by the field element is compared to.

Returns

Operator LowerThan operator instance.

LowerThan(FieldReference, ValueType, Object)

Instanciates a new LowerThan operator which will perform on specified fieldRef.

Declaration

public static Operator LowerThan(FieldReference fieldRef, ValueType valueType, object value)

Parameters

FieldReference fieldRef Reference to the field to operate on.

ValueType valueType Field type

System.Object value Value against which the value returned by the field element is compared to.

Returns

Operator LowerThan operator instance.

LowerThanOrEqualTo(FieldReference, Value)

Instanciates a new LowerThanOrEqualTo operator which will perform on specified fieldRef.

Declaration

public static Operator LowerThanOrEqualTo(FieldReference fieldRef, Value value)

Parameters

FieldReference fieldRef Reference to the field to operate on.

Value value Value against which the value returned by the field element is compared to.

Returns

Operator LowerThanOrEqualTo operator instance.

LowerThanOrEqualTo(FieldReference, ValueType, Object)

Instanciates a new LowerThanOrEqualTo operator which will perform on specified fieldRef.

Declaration

public static Operator LowerThanOrEqualTo(FieldReference fieldRef, ValueType valueType, object value)

Parameters

FieldReference fieldRef Reference to the field to operate on.

ValueType valueType Field type

System.Object value Value against which the value returned by the field element is compared to.

Returns

Operator LowerThanOrEqualTo operator instance.

Membership(FieldReference, MembershipType)

Instanciates a new Membership operator which will perform on specified fieldRef.

Declaration

public static Operator Membership(FieldReference fieldRef, MembershipType membershipType)

Parameters

FieldReference fieldRef Reference to the field to operate on.

MembershipType membershipType Type of membership for the operator to use to filter for.

Returns

Operator Membership operator instance.

NotEqual(FieldReference, Value)

Instanciates a new NotEqual operator which will perform on specified fieldRef.

Declaration

public static Operator NotEqual(FieldReference fieldRef, Value value)

Parameters

FieldReference fieldRef Reference to the field to operate on.

Value value Value against which the value returned by the field element is compared to.

Returns

Operator NotEqual operator instance.

NotEqual(FieldReference, ValueType, Object)

Instanciates a new NotEqual operator which will perform on specified fieldRef.

Declaration

public static Operator NotEqual(FieldReference fieldRef, ValueType valueType, object value)

Parameters

FieldReference fieldRef Reference to the field to operate on.

ValueType valueType Field type

System.Object value Value against which the value returned by the field element is compared to.

Returns

Operator NotEqual operator instance.

NotIncludes(FieldReference, Value)

Instanciates a new NotIncludes operator which will perform on specified fieldRef.

Declaration

public static Operator NotIncludes(FieldReference fieldRef, Value value)

Parameters

FieldReference fieldRef Reference to the field to operate on.

Value value Value against which the value returned by the field element is compared to.

Returns

Operator NotIncludes operator instance.

NotIncludes(FieldReference, ValueType, Object)

Instanciates a new NotIncludes operator which will perform on specified fieldRef.

Declaration

public static Operator NotIncludes(FieldReference fieldRef, ValueType valueType, object value)

Parameters

FieldReference fieldRef Reference to the field to operate on.

ValueType valueType Field type

System.Object value Value against which the value returned by the field element is compared to.

Returns

Operator NotIncludes operator instance.

Extension Methods

ValidationExtensions.ValidateNotNullOrEmpty<T>(T, String)

ObjectExtensions.Set<TObject, T>(TObject, Expression<Func<TObject, T>>, T, Boolean, Boolean)

ObjectExtensions.GetPublicInstancePropertyValue(Object, String)

ObjectExtensions.GetPublicInstanceProperty(Object, String)

ObjectExtensions.SetPublicInstancePropertyValue(Object, String, Object)

Extensions.ToByteArray(Object)