Class ReportFunction

Namespace: DocWright.Reporting.Expressions

Assembly: DocWright.Reporting.dll

One function of the report expression language.

public sealed class ReportFunction

Inheritance: object

ReportFunction

Inherited Members: object.GetType()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

Aliases: Gets the other names in the interpreter's table that reach the same function — Abs for Math.Abs, because System.Math is imported. Qualified spellings (Strings.Len) are accepted too and are not listed.

Category: Gets the category an editor groups the function under.

Description: Gets one sentence saying what the function returns or does.

Example: Gets an expression that calls the function, or null where one needs groups or data an example cannot assume (Previous, InScope, Level, Aggregate). For an implemented function it evaluates, in DocWright and in Microsoft's engine alike, against constants and the first row of a dataset; for a refused one it shows the call that is refused.

IsRefused: Gets a value indicating whether DocWright refuses to evaluate the function.

MaximumArguments: Gets the most arguments the function accepts, or null when it takes any number.

MinimumArguments: Gets the fewest arguments the function accepts.

Name: Gets the name, as the interpreter knows it: Len, Math.Abs, Convert.ToInt32.

RefusalCode: Gets the code a call to a refused function is reported with — DXP9102 — or null.

RefusalReason: Gets why DocWright refuses the function, in the interpreter's own words, or null.

ReturnType: Gets the Visual Basic name of the type the function returns — Integer, String, Date — or Object where it depends on the arguments (Math.Abs, IIf, the aggregates).

Signature: Gets the signature to show, such as Mid(text, start, [length]): a parameter in brackets is optional, and one ending in an ellipsis takes any number of arguments.

Methods

ToString()