Show / Hide Table of Contents

Class StdFunctions

Contains standard functions registered in the "Data" window.

Inheritance
System.Object
StdFunctions
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: FastReport.Functions
Assembly: FastReport.OpenSource.dll
Syntax
public static class StdFunctions

Methods

AddDays(DateTime, Double)

Adds the specified number of days to the original date.

Declaration
public static DateTime AddDays(DateTime date, double value)
Parameters
Type Name Description
System.DateTime date

The original date.

System.Double value

A number of whole and fractional days.

Returns
Type Description
System.DateTime

A new DateTime value.

AddHours(DateTime, Double)

Adds the specified number of hours to the original date.

Declaration
public static DateTime AddHours(DateTime date, double value)
Parameters
Type Name Description
System.DateTime date

The original date.

System.Double value

A number of whole and fractional hours.

Returns
Type Description
System.DateTime

A new DateTime value.

AddMinutes(DateTime, Double)

Adds the specified number of minutes to the original date.

Declaration
public static DateTime AddMinutes(DateTime date, double value)
Parameters
Type Name Description
System.DateTime date

The original date.

System.Double value

A number of whole and fractional minutes.

Returns
Type Description
System.DateTime

A new DateTime value.

AddMonths(DateTime, Int32)

Adds the specified number of months to the original date.

Declaration
public static DateTime AddMonths(DateTime date, int value)
Parameters
Type Name Description
System.DateTime date

The original date.

System.Int32 value

A number of months.

Returns
Type Description
System.DateTime

A new DateTime value.

AddSeconds(DateTime, Double)

Adds the specified number of seconds to the original date.

Declaration
public static DateTime AddSeconds(DateTime date, double value)
Parameters
Type Name Description
System.DateTime date

The original date.

System.Double value

A number of whole and fractional seconds.

Returns
Type Description
System.DateTime

A new DateTime value.

AddYears(DateTime, Int32)

Adds the specified number of years to the original date.

Declaration
public static DateTime AddYears(DateTime date, int value)
Parameters
Type Name Description
System.DateTime date

The original date.

System.Int32 value

A number of years.

Returns
Type Description
System.DateTime

A new DateTime value.

Asc(Char)

Returns an integer value representing the character code corresponding to a character.

Declaration
public static int Asc(char c)
Parameters
Type Name Description
System.Char c

Character to convert.

Returns
Type Description
System.Int32

The character code.

Choose(Double, Object[])

Selects and returns a value from a list of arguments.

Declaration
public static object Choose(double index, params object[] choice)
Parameters
Type Name Description
System.Double index

A value between 1 and the number of elements passed in the "choice" argument.

System.Object[] choice

Object parameter array.

Returns
Type Description
System.Object

One of the values in the "choice" argument.

Chr(Int32)

Returns the character associated with the specified character code.

Declaration
public static char Chr(int i)
Parameters
Type Name Description
System.Int32 i

Character code to convert.

Returns
Type Description
System.Char

The character.

DateDiff(DateTime, DateTime)

Subtracts the specified date and time from the original date.

Declaration
public static TimeSpan DateDiff(DateTime date1, DateTime date2)
Parameters
Type Name Description
System.DateTime date1

The original date.

System.DateTime date2

The date and time to subtract.

Returns
Type Description
System.TimeSpan

A TimeSpan interval between two dates.

DateSerial(Int32, Int32, Int32)

Initializes a new instance of the DateTime.

Declaration
public static DateTime DateSerial(int year, int month, int day)
Parameters
Type Name Description
System.Int32 year

The year.

System.Int32 month

The month.

System.Int32 day

The day.

Returns
Type Description
System.DateTime

A new DateTime value.

Day(DateTime)

Gets the day of the month.

Declaration
public static int Day(DateTime date)
Parameters
Type Name Description
System.DateTime date

The date value.

Returns
Type Description
System.Int32

The day component.

DayOfWeek(DateTime)

Gets the localized name of the day of the week.

Declaration
public static string DayOfWeek(DateTime date)
Parameters
Type Name Description
System.DateTime date

The date value.

Returns
Type Description
System.String

The name of the day of the week.

DayOfYear(DateTime)

Gets the day of the year.

Declaration
public static int DayOfYear(DateTime date)
Parameters
Type Name Description
System.DateTime date

The date value.

Returns
Type Description
System.Int32

The day of the year.

DaysInMonth(Int32, Int32)

Returns the number of days in the specified month and year.

Declaration
public static int DaysInMonth(int year, int month)
Parameters
Type Name Description
System.Int32 year

The year.

System.Int32 month

The month.

Returns
Type Description
System.Int32

The number of days in month for the specified year.

Format(String, Object[])

Replaces the format item in a specified String with the text equivalent of the value of a corresponding Object instance in a specified array.

Declaration
public static string Format(string format, params object[] args)
Parameters
Type Name Description
System.String format

A String containing zero or more format items.

System.Object[] args

An Object array containing zero or more objects to format.

Returns
Type Description
System.String

A copy of format in which the format items have been replaced by the String equivalent of the corresponding instances of Object in args.

FormatCurrency(Object)

Returns a string formatted as a currency value.

Declaration
public static string FormatCurrency(object value)
Parameters
Type Name Description
System.Object value

The value to format.

Returns
Type Description
System.String

The formatted string.

FormatCurrency(Object, Int32)

Returns a string formatted as a currency value with specified number of decimal digits.

Declaration
public static string FormatCurrency(object value, int decimalDigits)
Parameters
Type Name Description
System.Object value

The value to format.

System.Int32 decimalDigits

Number of decimal digits.

Returns
Type Description
System.String

The formatted string.

FormatDateTime(DateTime)

Returns a string formatted as a date/time value.

Declaration
public static string FormatDateTime(DateTime value)
Parameters
Type Name Description
System.DateTime value

The value to format.

Returns
Type Description
System.String

The formatted string.

FormatDateTime(DateTime, String)

Returns a string formatted as a date/time value.

Declaration
public static string FormatDateTime(DateTime value, string format)
Parameters
Type Name Description
System.DateTime value

The value to format.

System.String format

The format specifier, one of the "Long Date", "Short Date", "Long Time", "Short Time" values.

Returns
Type Description
System.String

The formatted string.

FormatNumber(Object)

Returns a string formatted as a numeric value.

Declaration
public static string FormatNumber(object value)
Parameters
Type Name Description
System.Object value

The value to format.

Returns
Type Description
System.String

The formatted string.

FormatNumber(Object, Int32)

Returns a string formatted as a numeric value with specified number of decimal digits.

Declaration
public static string FormatNumber(object value, int decimalDigits)
Parameters
Type Name Description
System.Object value

The value to format.

System.Int32 decimalDigits

Number of decimal digits.

Returns
Type Description
System.String

The formatted string.

FormatPercent(Object)

Returns a string formatted as a percent value.

Declaration
public static string FormatPercent(object value)
Parameters
Type Name Description
System.Object value

The value to format.

Returns
Type Description
System.String

The formatted string.

FormatPercent(Object, Int32)

Returns a string formatted as a percent value with specified number of decimal digits.

Declaration
public static string FormatPercent(object value, int decimalDigits)
Parameters
Type Name Description
System.Object value

The value to format.

System.Int32 decimalDigits

Number of decimal digits.

Returns
Type Description
System.String

The formatted string.

Hour(DateTime)

Gets the hour component of the date.

Declaration
public static int Hour(DateTime date)
Parameters
Type Name Description
System.DateTime date

The date.

Returns
Type Description
System.Int32

The hour component.

IIf(Boolean, Object, Object)

Returns one of two objects, depending on the evaluation of an expression.

Declaration
public static object IIf(bool expression, object truePart, object falsePart)
Parameters
Type Name Description
System.Boolean expression

The expression you want to evaluate.

System.Object truePart

Returned if Expression evaluates to True.

System.Object falsePart

Returned if Expression evaluates to False.

Returns
Type Description
System.Object

Either truePart os falsePart.

Insert(String, Int32, String)

Inserts a specified string at a specified index position in the original string.

Declaration
public static string Insert(string s, int startIndex, string value)
Parameters
Type Name Description
System.String s

The original string.

System.Int32 startIndex

The index position of the insertion.

System.String value

The string to insert.

Returns
Type Description
System.String

A new string.

IsNull(Report, String)

Checks if the specified object is null.

Declaration
public static bool IsNull(Report thisReport, string name)
Parameters
Type Name Description
Report thisReport

The report instance.

System.String name

Either a name of DB column, or a parameter name, or a total name to check.

Returns
Type Description
System.Boolean

true if the object's value is null.

Length(String)

Gets the number of characters in a string.

Declaration
public static int Length(string s)
Parameters
Type Name Description
System.String s

The original string.

Returns
Type Description
System.Int32

The number of characters.

LowerCase(String)

Converts a specified string to lowercase.

Declaration
public static string LowerCase(string s)
Parameters
Type Name Description
System.String s

The string to convert.

Returns
Type Description
System.String

A string in lowercase.

Maximum(Decimal, Decimal)

Returns the larger of two decimal numbers.

Declaration
public static decimal Maximum(decimal val1, decimal val2)
Parameters
Type Name Description
System.Decimal val1

The first of two values to compare.

System.Decimal val2

The second of two values to compare.

Returns
Type Description
System.Decimal

Parameter val1 or val2, whichever is larger.

Maximum(Double, Double)

Returns the larger of two double-precision floating-point numbers.

Declaration
public static double Maximum(double val1, double val2)
Parameters
Type Name Description
System.Double val1

The first of two values to compare.

System.Double val2

The second of two values to compare.

Returns
Type Description
System.Double

Parameter val1 or val2, whichever is larger.

Maximum(Int32, Int32)

Returns the larger of two 32-bit signed integers.

Declaration
public static int Maximum(int val1, int val2)
Parameters
Type Name Description
System.Int32 val1

The first of two values to compare.

System.Int32 val2

The second of two values to compare.

Returns
Type Description
System.Int32

Parameter val1 or val2, whichever is larger.

Maximum(Int64, Int64)

Returns the larger of two 64-bit signed integers.

Declaration
public static long Maximum(long val1, long val2)
Parameters
Type Name Description
System.Int64 val1

The first of two values to compare.

System.Int64 val2

The second of two values to compare.

Returns
Type Description
System.Int64

Parameter val1 or val2, whichever is larger.

Maximum(Single, Single)

Returns the larger of two single-precision floating-point numbers.

Declaration
public static float Maximum(float val1, float val2)
Parameters
Type Name Description
System.Single val1

The first of two values to compare.

System.Single val2

The second of two values to compare.

Returns
Type Description
System.Single

Parameter val1 or val2, whichever is larger.

Minimum(Decimal, Decimal)

Returns the smaller of two decimal numbers.

Declaration
public static decimal Minimum(decimal val1, decimal val2)
Parameters
Type Name Description
System.Decimal val1

The first of two values to compare.

System.Decimal val2

The second of two values to compare.

Returns
Type Description
System.Decimal

Parameter val1 or val2, whichever is smaller.

Minimum(Double, Double)

Returns the smaller of two double-precision floating-point numbers.

Declaration
public static double Minimum(double val1, double val2)
Parameters
Type Name Description
System.Double val1

The first of two values to compare.

System.Double val2

The second of two values to compare.

Returns
Type Description
System.Double

Parameter val1 or val2, whichever is smaller.

Minimum(Int32, Int32)

Returns the smaller of two 32-bit signed integers.

Declaration
public static int Minimum(int val1, int val2)
Parameters
Type Name Description
System.Int32 val1

The first of two values to compare.

System.Int32 val2

The second of two values to compare.

Returns
Type Description
System.Int32

Parameter val1 or val2, whichever is smaller.

Minimum(Int64, Int64)

Returns the smaller of two 64-bit signed integers.

Declaration
public static long Minimum(long val1, long val2)
Parameters
Type Name Description
System.Int64 val1

The first of two values to compare.

System.Int64 val2

The second of two values to compare.

Returns
Type Description
System.Int64

Parameter val1 or val2, whichever is smaller.

Minimum(Single, Single)

Returns the smaller of two single-precision floating-point numbers.

Declaration
public static float Minimum(float val1, float val2)
Parameters
Type Name Description
System.Single val1

The first of two values to compare.

System.Single val2

The second of two values to compare.

Returns
Type Description
System.Single

Parameter val1 or val2, whichever is smaller.

Minute(DateTime)

Gets the minute component of the date.

Declaration
public static int Minute(DateTime date)
Parameters
Type Name Description
System.DateTime date

The date.

Returns
Type Description
System.Int32

The minute component.

Month(DateTime)

Gets the month component of the date.

Declaration
public static int Month(DateTime date)
Parameters
Type Name Description
System.DateTime date

The date.

Returns
Type Description
System.Int32

The month component.

MonthName(Int32)

Gets the localized month name.

Declaration
public static string MonthName(int month)
Parameters
Type Name Description
System.Int32 month

The month number.

Returns
Type Description
System.String

The month name.

PadLeft(String, Int32)

Right-aligns the characters in a string, padding with spaces on the left for a specified total length.

Declaration
public static string PadLeft(string s, int totalWidth)
Parameters
Type Name Description
System.String s

The original string.

System.Int32 totalWidth

The number of characters in the resulting string.

Returns
Type Description
System.String

Right-aligned string, padded on the left with spaces.

PadLeft(String, Int32, Char)

Right-aligns the characters in a string, padding on the left with a specified character for a specified total length.

Declaration
public static string PadLeft(string s, int totalWidth, char paddingChar)
Parameters
Type Name Description
System.String s

The original string.

System.Int32 totalWidth

The number of characters in the resulting string.

System.Char paddingChar

A padding character.

Returns
Type Description
System.String

Right-aligned string, padded on the left with padding characters.

PadRight(String, Int32)

Left-aligns the characters in a string, padding with spaces on the right, for a specified total length.

Declaration
public static string PadRight(string s, int totalWidth)
Parameters
Type Name Description
System.String s

The original string.

System.Int32 totalWidth

The number of characters in the resulting string.

Returns
Type Description
System.String

Left-aligned string, padded on the right with spaces.

PadRight(String, Int32, Char)

Left-aligns the characters in a string, padding on the right with a specified character, for a specified total length.

Declaration
public static string PadRight(string s, int totalWidth, char paddingChar)
Parameters
Type Name Description
System.String s

The original string.

System.Int32 totalWidth

The number of characters in the resulting string.

System.Char paddingChar

A padding character.

Returns
Type Description
System.String

Left-aligned string, padded on the right with padding characters.

Remove(String, Int32)

Deletes all the characters from a string beginning at a specified position.

Declaration
public static string Remove(string s, int startIndex)
Parameters
Type Name Description
System.String s

The original string.

System.Int32 startIndex

The position to begin deleting characters.

Returns
Type Description
System.String

A new string.

Remove(String, Int32, Int32)

Deletes a specified number of characters from a string beginning at a specified position.

Declaration
public static string Remove(string s, int startIndex, int count)
Parameters
Type Name Description
System.String s

The original string.

System.Int32 startIndex

The position to begin deleting characters.

System.Int32 count

The number of characters to delete.

Returns
Type Description
System.String

A new string.

Replace(String, String, String)

Replaces all occurrences of a specified string in the original string, with another specified string.

Declaration
public static string Replace(string s, string oldValue, string newValue)
Parameters
Type Name Description
System.String s

The original string.

System.String oldValue

A string to be replaced.

System.String newValue

A string to replace all occurrences of oldValue.

Returns
Type Description
System.String

A new string.

Second(DateTime)

Gets the seconds component of the date.

Declaration
public static int Second(DateTime date)
Parameters
Type Name Description
System.DateTime date

The date.

Returns
Type Description
System.Int32

The seconds component.

Substring(String, Int32)

Retrieves a substring from the original string, starting at a specified character position.

Declaration
public static string Substring(string s, int startIndex)
Parameters
Type Name Description
System.String s

The original string.

System.Int32 startIndex

The starting character position of a substring.

Returns
Type Description
System.String

A new string.

Substring(String, Int32, Int32)

Retrieves a substring from the original string, starting at a specified character position, with a specified length.

Declaration
public static string Substring(string s, int startIndex, int length)
Parameters
Type Name Description
System.String s

The original string.

System.Int32 startIndex

The starting character position of a substring.

System.Int32 length

The number of characters in the substring.

Returns
Type Description
System.String

A new string.

Switch(Object[])

Evaluates a list of expressions and returns a value corresponding to the first expression in the list that is True.

Declaration
public static object Switch(params object[] expressions)
Parameters
Type Name Description
System.Object[] expressions

Parameter array consists of paired expressions and values.

Returns
Type Description
System.Object

The value corresponding to an expression which returns true.

TitleCase(String)

Converts the specified string to titlecase.

Declaration
public static string TitleCase(string s)
Parameters
Type Name Description
System.String s

The string to convert.

Returns
Type Description
System.String

A new string.

ToRoman(Object)

Converts a numeric value to Roman string representation.

Declaration
public static string ToRoman(object value)
Parameters
Type Name Description
System.Object value

Integer value in range 0-3998.

Returns
Type Description
System.String

The string in Roman form.

ToWords(Object)

Converts a currency value to an english (US) string representation of that value.

Declaration
public static string ToWords(object value)
Parameters
Type Name Description
System.Object value

The currency value to convert.

Returns
Type Description
System.String

The string representation of the specified value.

ToWords(Object, String)

Converts a currency value to an english (US) string representation of that value, using the specified currency.

Declaration
public static string ToWords(object value, string currencyName)
Parameters
Type Name Description
System.Object value

The currency value to convert.

System.String currencyName

The 3-digit ISO name of the currency, for example "EUR".

Returns
Type Description
System.String

The string representation of the specified value.

ToWords(Object, String, String)

Converts a numeric value to an english (US) string representation of that value.

Declaration
public static string ToWords(object value, string one, string many)
Parameters
Type Name Description
System.Object value

The numeric value to convert.

System.String one

The name in singular form, for example "page".

System.String many

The name in plural form, for example "pages".

Returns
Type Description
System.String

The string representation of the specified value.

ToWordsEnGb(Object)

Converts a currency value to an english (GB) string representation of that value.

Declaration
public static string ToWordsEnGb(object value)
Parameters
Type Name Description
System.Object value

The currency value to convert.

Returns
Type Description
System.String

The string representation of the specified value.

ToWordsEnGb(Object, String)

Converts a currency value to an english (GB) string representation of that value, using the specified currency.

Declaration
public static string ToWordsEnGb(object value, string currencyName)
Parameters
Type Name Description
System.Object value

The currency value to convert.

System.String currencyName

The 3-digit ISO name of the currency, for example "EUR".

Returns
Type Description
System.String

The string representation of the specified value.

ToWordsEnGb(Object, String, String)

Converts a numeric value to an english (GB) string representation of that value.

Declaration
public static string ToWordsEnGb(object value, string one, string many)
Parameters
Type Name Description
System.Object value

The numeric value to convert.

System.String one

The name in singular form, for example "page".

System.String many

The name in plural form, for example "pages".

Returns
Type Description
System.String

The string representation of the specified value.

ToWordsEs(Object)

Converts a currency value to a spanish string representation of that value.

Declaration
public static string ToWordsEs(object value)
Parameters
Type Name Description
System.Object value

The currency value to convert.

Returns
Type Description
System.String

The string representation of the specified value.

ToWordsEs(Object, String)

Converts a currency value to a spanish string representation of that value, using the specified currency.

Declaration
public static string ToWordsEs(object value, string currencyName)
Parameters
Type Name Description
System.Object value

The currency value to convert.

System.String currencyName

The 3-digit ISO name of the currency, for example "EUR".

Returns
Type Description
System.String

The string representation of the specified value.

ToWordsEs(Object, String, String)

Converts a numeric value to a spanish string representation of that value.

Declaration
public static string ToWordsEs(object value, string one, string many)
Parameters
Type Name Description
System.Object value

The numeric value to convert.

System.String one

The name in singular form, for example "page".

System.String many

The name in plural form, for example "pages".

Returns
Type Description
System.String

The string representation of the specified value.

ToWordsRu(Object)

Converts a currency value to a russian string representation of that value.

Declaration
public static string ToWordsRu(object value)
Parameters
Type Name Description
System.Object value

The currency value to convert.

Returns
Type Description
System.String

The string representation of the specified value.

ToWordsRu(Object, Boolean, String, String, String)

Converts a numeric value to a russian string representation of that value.

Declaration
public static string ToWordsRu(object value, bool male, string one, string two, string many)
Parameters
Type Name Description
System.Object value

The numeric value to convert.

System.Boolean male

True if the name is of male gender.

System.String one

The name in singular form, for example "страница".

System.String two

The name in plural form, for example "страницы".

System.String many

The name in plural form, for example "страниц".

Returns
Type Description
System.String

The string representation of the specified value.

ToWordsRu(Object, String)

Converts a currency value to a russian string representation of that value, using the specified currency.

Declaration
public static string ToWordsRu(object value, string currencyName)
Parameters
Type Name Description
System.Object value

The currency value to convert.

System.String currencyName

The 3-digit ISO name of the currency, for example "EUR".

Returns
Type Description
System.String

The string representation of the specified value.

Trim(String)

Removes all occurrences of white space characters from the beginning and end of the original string.

Declaration
public static string Trim(string s)
Parameters
Type Name Description
System.String s

The original string.

Returns
Type Description
System.String

A new string.

UpperCase(String)

Converts a specified string to uppercase.

Declaration
public static string UpperCase(string s)
Parameters
Type Name Description
System.String s

The string to convert.

Returns
Type Description
System.String

A string in uppercase.

WeekOfYear(DateTime)

Gets the week of the year.

Declaration
public static int WeekOfYear(DateTime date)
Parameters
Type Name Description
System.DateTime date

The date value.

Returns
Type Description
System.Int32

The week of the year.

Year(DateTime)

Gets the year component of the date.

Declaration
public static int Year(DateTime date)
Parameters
Type Name Description
System.DateTime date

The date.

Returns
Type Description
System.Int32

The year component.

Back to top Generated by DocFX