The requested page is not available for the requested platform. You are viewing the content for Default platform.

FunctionOperatorType Enum

Lists functions the Criteria Language supports.

Namespace: DevExpress.Data.Filtering

Assembly: DevExpress.XamarinForms.Core.dll

Declaration

[Serializable]
public enum FunctionOperatorType

Members

Name Description
Abs

Returns the absolute value of the numeric expression.

Category: Math

String analogue: "Abs([FieldName])"

Acos

Returns the angle in radians, whose cosine is the given float expression.

Category: Math

String analogue: "Acos([FieldName])"

AddDays

Returns a new DateTime value that adds the specified number of days to the given value.

Category: DateTime

String analogue: "AddDays([FieldName], Value)"

AddHours

Returns a new DateTime value that adds the specified number of hours to the given value.

Category: DateTime

String analogue: "AddHours([FieldName], Value)"

AddMilliSeconds

Returns a new DateTime value that adds the specified number of milliseconds to the given value.

Category: DateTime

String analogue: "AddMilliSeconds([FieldName], Value)"

AddMinutes

Returns a new DateTime value that adds the specified number of minutes to the given value.

Category: DateTime

String analogue: "AddMinutes([FieldName], Value)"

AddMonths

Returns a new DateTime value that adds the specified number of months to the given value.

Category: DateTime

String analogue: "AddMonths([FieldName], Value)"

AddSeconds

Returns a new DateTime value that adds the specified number of seconds to the given value.

Category: DateTime

String analogue: "AddSeconds([FieldName], Value)"

AddTicks

Returns a new DateTime value that adds the specified number of ticks to the given value.

Category: DateTime

String analogue: "AddTicks([FieldName], Value)"

AddTimeSpan

Returns a new DateTime value that adds the specified time span to the given value.

Category: DateTime

String analogue: "AddTimeSpan([FieldName], Value)"

AddYears

Returns a new DateTime value that adds the specified number of years to the given value.

Category: DateTime

String analogue: "AddYears([FieldName], Value)"

Ascii

Returns the ASCII code of the first character in the specified string expression.

Category: Text

String analogue: "Ascii([FieldName])"

Asin

Returns the angle in radians, whose sine is the given float expression.

Category: Math

String analogue: "Asin([FieldName])"

Atn

Returns the angle in radians, whose tangent is the given float expression.

Category: Math

String analogue: "Atan([FieldName])"

Atn2

Returns the angle in radians, whose tangent is the quotient of two specified numbers.

Category: Math

String analogue: "Atan2([Field1Name], [Field2Name])"

BigMul

Returns a long value that is the full product of two specified int values.

Category: Math

String analogue: "BigMul([Field1Name], [Field2Name])"

Ceiling

Returns a smallest int value that is greater than or equal to the specified value.

Category: Math

String analogue: "Ceiling([FieldName])"

Char

Returns the character whose code the passed integer value specifies.

Category: Text

String analogue: "Char(51)"

CharIndex

Returns the zero-based position of the first string within the second string, beginning from the passed index or zero if it is not specified.

Category: Text

String analogue: "CharIndex('e', 'DevExpress')" or "CharIndex('e', 'DevExpress', 3)"

Concat

Returns a string that is the concatenation of the all strings passed as arguments.

Category: Text

String analogue: "CharIndex('Hello', ', ', 'World!')"

Contains

Returns true, if the first string contains the second; otherwise, false.

Category: Text

String analogue: "Contains('DevExpress', 'e')"

Cos

Returns the cosine of the specified value in radians.

Category: Math

String analogue: "Cos([FieldName])"

Cosh

Returns the hyperbolic cosine of the specified value in radians.

Category: Math

String analogue: "Cosh([FieldName])"

Custom

The custom function the ICustomFunctionOperator interface represents.

You should register all custom operators the Criteria Language recognizes. Use the CriteriaOperator.RegisterCustomFunction or CriteriaOperator.RegisterCustomFunctions method to do this.

DateDiffDay

Returns the count of day boundaries between two specified dates.

Category: DateTime

String analogue: "DateDiffDay(Value1, Value2)"

DateDiffHour

Returns the count of hour boundaries between two specified dates.

Category: DateTime

String analogue: "DateDiffHour(Value1, Value2)"

DateDiffMilliSecond

Returns the count of millisecond boundaries between two specified dates.

Category: DateTime

String analogue: "DateDiffMilliSecond(Value1, Value2)"

DateDiffMinute

Returns the count of minute boundaries between two specified dates.

Category: DateTime

String analogue: "DateDiffMinute(Value1, Value2)"

DateDiffMonth

Returns the count of month boundaries between two specified dates.

Category: DateTime

String analogue: "DateDiffMonth(Value1, Value2)"

DateDiffSecond

Returns the count of second boundaries between two specified dates.

Category: DateTime

String analogue: "DateDiffSecond(Value1, Value2)"

DateDiffTick

Returns the count of tick boundaries between two specified dates.

Category: DateTime

String analogue: "DateDiffTick(Value1, Value2)"

DateDiffYear

Returns the count of year boundaries between two specified dates.

Category: DateTime

String analogue: "DateDiffYear(Value1, Value2)"

EndsWith

Returns true, if the end of the first string matches the second string; otherwise, false.

Category: Text

String analogue: "EndsWith([CompanyName], 'Express')"

Exp

Returns the exponential value of the specified value.

Category: Math

String analogue: "Exp([FieldName])"

Floor

Returns a largest int value that is smaller than or equal to the specified value.

Category: Math

String analogue: "Floor([FieldName])"

GetDate

Returns a date from the specified DateTime expression.

Category: DateTime

String analogue: "GetDate(Value)"

GetDay

Returns a day from the specified DateTime expression.

Category: DateTime

String analogue: "GetDay(Value)"

GetDayOfWeek

Returns a day of the week from the specified DateTime expression.

Category: DateTime

String analogue: "GetDayOfWeek(Value)"

GetDayOfYear

Returns a day of the year from the specified DateTime expression.

Category: DateTime

String analogue: "GetDayOfYear(Value)"

GetHour

Returns an hour from the specified DateTime expression.

Category: DateTime

String analogue: "GetHour(Value)"

GetMilliSecond

Returns a millisecond from the specified DateTime expression.

Category: DateTime

String analogue: "GetMilliSecond(Value)"

GetMinute

Returns a minute from the specified DateTime expression.

Category: DateTime

String analogue: "GetMinute(Value)"

GetMonth

Returns a month from the specified DateTime expression.

Category: DateTime

String analogue: "GetMonth(Value)"

GetSecond

Returns a second from the specified DateTime expression.

Category: DateTime

String analogue: "GetSecond(Value)"

GetTimeOfDay

Returns a time of the day from the specified DateTime expression.

Category: DateTime

String analogue: "GetYear(Value)"

GetYear

Returns a year from the specified DateTime expression.

Category: DateTime

String analogue: "GetYear(Value)"

Iif

Returns one of values, depending on which expression evaluates to true.

The function takes 2N+1 arguments (N - the number of logical expressions):

  • Each odd argument specifies a logical expression to check;
  • Each even argument specifies the value that is returned if the previous expression returns true;
  • The last argument specifies the value that is returned if all logical expressions return false.

Category: Logical

String analogue: "Iif([Expression1], [TrueValue1], ..., [ExpressionN], [TrueValueN], [FalseValue])"

Insert

Returns the string that contains the first string with the inserted second string starting with the specified zero-based position.

Category: Text

String analogue: "Insert([LastName], 0, [FirstName])"

IsNull

Returns the first value if it is not null; otherwise, the second value.

Category: Logical

String analogue: "IsNull([FieldName], Value2)"

IsNullOrEmpty

Returns true, if the specified string is null or an empty string; otherwise, false.

Category: Logical

String analogue: "IsNullOrEmpty([FieldName])"

IsOutlookIntervalBeyondThisYear

Returns whether the specified date is beyond this year (date >= FirstDayOfNextYear).

Category: DateTime

String analogue: "IsOutlookIntervalBeyondThisYear([FieldName])"

IsOutlookIntervalEarlierThisMonth

Returns whether the specified date is earlier in this month (FirstDayOfThisMonth <= date <= FirstDayOfLastWeek).

Category: DateTime

String analogue: "IsOutlookIntervalEarlierThisMonth([FieldName])"

IsOutlookIntervalEarlierThisWeek

Returns whether the specified date is earlier in this week (FirstDayOfThisWeek <= date < Yesterday).

Category: DateTime

String analogue: "IsOutlookIntervalEarlierThisWeek([FieldName])"

IsOutlookIntervalEarlierThisYear

Returns whether the specified date is earlier in this year (FirstDayOfThisYear <= date < FirstDayOfThisMonth).

Category: DateTime

String analogue: "IsOutlookIntervalEarlierThisYear([FieldName])"

IsOutlookIntervalLastWeek

Returns whether the specified date is in last week (FirstDayOfLastWeek <= date < FirstDayOfThisWeek).

Category: DateTime

String analogue: "IsOutlookIntervalLastWeek([FieldName])"

IsOutlookIntervalLaterThisMonth

Returns whether the specified date is later in this month (LastDayOfNextWeek < date < FirstDayOfNextMonth).

Category: DateTime

String analogue: "IsOutlookIntervalLaterThisMonth([FieldName])"

IsOutlookIntervalLaterThisWeek

Returns whether the specified date is later in this week (DayAfterTomorrow < date < FirstDayOfNextWeek).

Category: DateTime

String analogue: "IsOutlookIntervalLaterThisweek([FieldName])"

IsOutlookIntervalLaterThisYear

Returns whether the specified date is later in this year (FirstDayOfNextMonth <= date < FirstDayOfNextYear).

Category: DateTime

String analogue: "IsOutlookIntervalLaterThisYear([FieldName])"

IsOutlookIntervalNextWeek

Returns whether the specified date is in next week (FirstDayOfNextWeek <= date < LastDayOfNextWeek).

Category: DateTime

String analogue: "IsOutlookIntervalNextWeek([FieldName])"

IsOutlookIntervalPriorThisYear

Returns whether the specified date is before this year (date < FirstDayOfThisYear).

Category: DateTime

String analogue: "IsOutlookIntervalPriorThisYear([FieldName])"

IsOutlookIntervalToday

Returns whether the specified date is today.

Category: DateTime

String analogue: "IsOutlookIntervalToday([FieldName])"

IsOutlookIntervalTomorrow

Returns whether the specified date is tomorrow.

Category: DateTime

String analogue: "IsOutlookIntervalTomorrow([FieldName])"

IsOutlookIntervalYesterday

Returns whether the specified date is tomorrow.

Category: DateTime

String analogue: "IsOutlookIntervalYesterday([FieldName])"

IsThisMonth

Returns whether the specified date is in the current month.

Category: DateTime

String analogue: "IsThisMonth([FieldName])"

IsThisWeek

Returns whether the specified date is in the current week.

Category: DateTime

String analogue: "IsThisWeek([FieldName])"

IsThisYear

Returns whether the specified date is in the current year.

Category: DateTime

String analogue: "IsThisYear([FieldName])"

Len

Returns an integer containing either the number of characters in a string or the nominal number of bytes required to store a variable.

Category: All

String analogue: "Len([FieldName])"

LocalDateTimeDayAfterTomorrow

Returns the date-time value that corresponds to the day after tomorrow.

Category: DateTime

String analogue: "LocalDateTimeDayAfterTomorrow()"

LocalDateTimeLastWeek

Returns the date-time value that corresponds to the first day of the previous week.

Category: DateTime

String analogue: "LocalDateTimeLastWeek()"

LocalDateTimeNextMonth

Returns the date-time value that corresponds to the first day of the next month.

Category: DateTime

String analogue: "LocalDateTimeNextMonth()"

LocalDateTimeNextWeek

Returns the date-time value that corresponds to the first day of the next week.

Category: DateTime

String analogue: "LocalDateTimeNextWeek()"

LocalDateTimeNextYear

Returns the date-time value that corresponds to the first day of the next year.

Category: DateTime

String analogue: "LocalDateTimeNextYear()"

LocalDateTimeNow

Returns the date-time value that corresponds to the local date and time.

Category: DateTime

String analogue: "LocalDateTimeNow()"

LocalDateTimeThisMonth

Returns the date-time value that corresponds to the first day of this month.

Category: DateTime

String analogue: "LocalDateTimeThisMonth()"

LocalDateTimeThisWeek

Returns the date-time value that corresponds to the first day of this week.

Category: DateTime

String analogue: "LocalDateTimeThisWeek()"

LocalDateTimeThisYear

Returns the date-time value that corresponds to the first day of this year.

Category: DateTime

String analogue: "LocalDateTimeThisYear()"

LocalDateTimeToday

Returns the date-time value that corresponds to the current day's midnight.

Category: DateTime

String analogue: "LocalDateTimeToday()"

LocalDateTimeTomorrow

Returns the date-time value that corresponds to the tomorrow midnight.

Category: DateTime

String analogue: "LocalDateTimeTomorrow()"

LocalDateTimeTwoWeeksAway

Returns the date-time value that corresponds to the first day of the week after the next.

Category: DateTime

String analogue: "LocalDateTimeTwoWeeksAway()"

LocalDateTimeYesterday

Returns the date-time value that corresponds to the yesterday midnight.

Category: DateTime

String analogue: `"LocalDateTimeYesterday()"

Log

Returns the natural (base e) logarithm of the specified value.

Category: Math

String analogue: "Log([FieldName])"

Log10

Returns the common (base 10) logarithm of the specified value.

Category: Math

String analogue: "Log10([FieldName])"

Lower

Returns the specified string in lowercase.

Category: Text

String analogue: "Lower([FieldName])"

Max

Returns the maximum from specified values.

Category: Math

String analogue: "Max([Field1Name], [Field2Name], ..., [FieldNName])"

Min

Returns the Minimum from specified values.

Category: Math

String analogue: "Min([Field1Name], [Field2Name], ..., [FieldNName])"

None

The function type is not specified.

Now

Returns the current system date and time.

Category: DateTime

String analogue: "Now()"

PadLeft

Returns the left-aligned string, filled with the specified character (whitespace by default) up to the specified string length.

Category: Text

String analogue: "PadLeft([FieldName], Length)" or "PadLeft([FieldName], Length, Filler)"

PadRight

Returns the right-aligned string, filled with the specified character (whitespace by default) up to the specified string length.

Category: Text

String analogue: "PadRight([FieldName], Length)" or "PadRight([FieldName], Length, Filler)"

Power

Returns the specified numeric value raised to the specified power.

Category: Math

String analogue: "Power([Field1Name], Value)"

Remove

Returns a new string in which a specified number of characters (all, by default) in the passed string beginning at a given position, are removed.

Category: Text

String analogue: "Remove([FieldName], StartIndex)" or "Remove([FieldName], StartIndex, Length)"

Replace

Returns a new string that is the first string in which the second string is replaced with the third string. Category: Text String analogue: "Remove([FieldName], 'StringToReplace', 'NewString')"

Reverse

Returns a new string that is the specified string reversed. Category: Text String analogue: "Reverse([FieldName])"

Rnd

Returns a random number that is greater than or equal to zero and less than one.

Category: Math

String analogue: "Rnd()"

Round

Rounds the specified value to the nearest integer or to the passed number of decimal places.

Category: Math

String analogue: "Round([FieldName])" or "Round([FieldName], Value)"

Sign

Returns a value indicating the sign of a number represented by a specified operand. The function returns one of the following values:

  • 1, for positive numbers;
  • 0, if the number is equal to zero.
  • -1, for negative numbers;

Category: Math

String analogue: "Sign([FieldName])"

Sin

Returns the sine of the specified value in radians.

Category: Math

String analogue: "Sin([FieldName])"

Sinh

Returns the hyperbolic sine of the specified value in radians.

Category: Math

String analogue: "Sinh([FieldName])"

Sqr

Returns the square root of the specified value.

Category: Math

String analogue: "Sqr([FieldName])"

StartsWith

Returns true, if the start of the first string matches the second string; otherwise, false.

Category: Text

String analogue: "StartsWith([CompanyName], 'Dev')"

Substring

Returns a new string that is substring of the one specified. The substring starts at StartIndex and has a specified Length (up to the end by default).

Category: Text

String analogue: "StartsWith([CompanyName], StartIndex)" or "StartsWith([CompanyName], StartIndex, Length)"

Tan

Returns the tangent of the specified value in radians.

Category: Math

String analogue: "Tan([FieldName])"

Tanh

Returns the hyperbolic tangent of the specified value in radians.

Category: Math

String analogue: "Tanh([FieldName])"

ToDecimal

Returns the decimal value that is an equivalent of the specified value.

Category: Math

String analogue: "ToDecimal([FieldName])"

ToDouble

Returns the double value that is an equivalent of the specified value.

Category: Math

String analogue: "ToDouble([FieldName])"

ToFloat

Returns the float value that is an equivalent of the specified value.

Category: Math

String analogue: "ToFloat([FieldName])"

ToInt

Returns the int value that is an equivalent of the specified value.

Category: Math

String analogue: "ToInt([FieldName])"

ToLong

Returns the long value that is an equivalent of the specified value.

Category: Math

String analogue: "ToLong([FieldName])"

ToStr

Returns a string representation of the specified object.

Category: All

String analogue: "ToStr([Version])"

Today

Returns the current system date. Regardless of the actual time, this function returns midnight of the current date.

Category: DateTime

String analogue: "Today()"

Trim

Removes all leading and trailing whitespaces from the specified string.

Category: Text

String analogue: "Trim([CompanyName])"

Upper

Returns the specified string in uppercase.

Category: Text

String analogue: "Upper([FieldName])"

UtcNow

Returns the current system date and time, expressed as Coordinated Universal Time (UTC).

Category: DateTime

String analogue: "UtcNow()"

Remarks

The FunctionOperator.OperatorType field uses types this enumeration contains.

All values contain a string equivalent that produces the same function when you pass it to the CriteriaOperator.Parse method

See Also