Class IsExactTypeFunction

Namespace

DevExpress.Xpo.Metadata

Assembly

DevExpress.Xpo.v24.1.dll

A custom function that determines whether a particular object has a specified type.

public class IsExactTypeFunction : ICustomFunctionOperatorBrowsable, ICustomFunctionOperator, ICustomFunctionDisplayAttributes, ICustomFunctionOperatorConvertibleToExpression, ICustomFunctionOperatorCompileable

Inheritance

object

IsExactTypeFunction

Implements

ICustomFunctionOperatorBrowsable

ICustomFunctionOperator

ICustomFunctionDisplayAttributes

ICustomFunctionOperatorConvertibleToExpression

ICustomFunctionOperatorCompileable

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Fields

FunctionName

Specifies the name of the IsExactTypeFunction custom function operator.

public const string FunctionName = "IsExactType"

Field Value

string

Properties

Category

Designates the IsExactTypeFunction custom function operator’s category.

public FunctionCategory Category { get; }

Property Value

FunctionCategory

A DevExpress.Data.Filtering.FunctionCategory value specifying the custom function’s category.

Description

Specifies the IsExactTypeFunction custom function operator’s description.

public string Description { get; }

Property Value

string

A text describing the custom function’s syntax and purpose.

DisplayName

This member supports the internal infrastructure and is not intended to be used directly from your code.

public string DisplayName { get; }

Property Value

string

Image

This member supports the internal infrastructure and is not intended to be used directly from your code.

public object Image { get; }

Property Value

object

MaxOperandCount

Specifies the maximum number of operands (parameters) the IsExactTypeFunction function operator can accept.

public int MaxOperandCount { get; }

Property Value

int

An integer value specifying the maximum number of function operands (parameters) the custom function can accept. -1 indicates that a custom function accepts an infinite number of operands.

MinOperandCount

Specifies the minimum number of operands (parameters) required by the IsExactTypeFunction function operator.

public int MinOperandCount { get; }

Property Value

int

An integer value specifying the least possible number of function operands (parameters) required by the custom function. 0 indicates that operands can be omitted.

Name

Specifies name of the IsExactTypeFunction custom function operator.

public string Name { get; }

Property Value

string

A string used to identify a custom function.

Methods

Convert(ICriteriaToExpressionConverter, params Expression[])

public Expression Convert(ICriteriaToExpressionConverter converter, params Expression[] operands)

Parameters

converter ICriteriaToExpressionConverter

operands Expression[]

Returns

Expression

Create(params Expression[])

public Expression Create(params Expression[] operands)

Parameters

operands Expression[]

Returns

Expression

Evaluate(params object[])

Evaluates the IsExactTypeFunction custom function operator on the client.

public object Evaluate(params object[] operands)

Parameters

operands object[]

An array of objects specifying function operands (parameters).

Returns

object

An object specifying the custom function’s return value, calculated based on the operands.

IsExactType(object, Type)

public static bool IsExactType(object obj, Type type)

Parameters

obj object

type Type

Returns

bool

IsValidOperandCount(int)

Determines whether the IsExactTypeFunction custom function operator can accept a specified number of operands (parameters).

public bool IsValidOperandCount(int count)

Parameters

count int

An integer value specifying the number of operands (parameters) passed to the custom function.

Returns

bool

true if the number of operands (parameters) passed as the count is valid for the custom function; otherwise, false.

IsValidOperandType(int, int, Type)

Determines whether a certain type can be passed as a specified operand to the IsExactTypeFunction custom function operator.

public bool IsValidOperandType(int operandIndex, int operandCount, Type type)

Parameters

operandIndex int

A zero-based integer value specifying an operand’s index among a custom function’s operands.

operandCount int

An integer value specifying the total number of operands passed to the custom function.

type Type

Returns

bool

true if the custom function accepts the type; otherwise, false.

Register()

Registers the IsExactTypeFunction custom function operator by calling the CriteriaOperator.RegisterCustomFunction method.

public static void Register()

ResultType(params Type[])

Determines the IsExactTypeFunction custom function operator result type based on the type of operands passed to the operator.

public Type ResultType(params Type[] operands)

Parameters

operands Type[]

An array of function operator (parameter) types.

Returns

Type

A Type object specifying the return value type of the custom function.