Class FunctionInfo

Metadata describing a spreadsheet function's signature, including name, category, argument definitions, and result format.

Inheritance

System.Object

FunctionInfo

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: Telerik.Windows.Documents.Spreadsheet.Expressions.Functions

Assembly: Telerik.Windows.Documents.Spreadsheet.dll

Syntax

public class FunctionInfo

Constructors

FunctionInfo(String, FunctionCategory, String, IEnumerable<ArgumentInfo>, Boolean, String)

Initializes a new FunctionInfo for a function with required arguments, general format, and optional default value support.

Declaration

public FunctionInfo(string name, FunctionCategory category, string description, IEnumerable<ArgumentInfo> requiredArgumentsInfos, bool isDefaultValueFunction = false, string descriptionLocalizationKey = null)

Parameters

System.String name The name of the function.

FunctionCategory category The category of the function.

System.String description The description of the function.

System.Collections.Generic.IEnumerable<ArgumentInfo> requiredArgumentsInfos The required arguments infos for the function.

System.Boolean isDefaultValueFunction Boolean indicating whether the function is default value function.

System.String descriptionLocalizationKey The localization key of the function description.

FunctionInfo(String, FunctionCategory, String, IEnumerable<ArgumentInfo>, IEnumerable<ArgumentInfo>, Int32, Boolean, String)

Initializes a new FunctionInfo for a function with required and optional arguments, general format, and variable-length argument support.

Declaration

public FunctionInfo(string name, FunctionCategory category, string description, IEnumerable<ArgumentInfo> requiredArgumentsInfos, IEnumerable<ArgumentInfo> optionalArgumentsInfos, int optionalArgumentsRepeatCount = 1, bool isDefaultValueFunction = false, string descriptionLocalizationKey = null)

Parameters

System.String name The name of the function.

FunctionCategory category The category of the function.

System.String description The description of the function.

System.Collections.Generic.IEnumerable<ArgumentInfo> requiredArgumentsInfos The required arguments infos for the function.

System.Collections.Generic.IEnumerable<ArgumentInfo> optionalArgumentsInfos The optional arguments infos for the function.

System.Int32 optionalArgumentsRepeatCount The count of the optional arguments for the function.

System.Boolean isDefaultValueFunction Boolean indicating whether the function is default value function.

System.String descriptionLocalizationKey The localization key of the function description.

FunctionInfo(String, FunctionCategory, String, IEnumerable<ArgumentInfo>, IEnumerable<ArgumentInfo>, CellValueFormat, Int32, Boolean, String)

Initializes a new FunctionInfo with complete metadata for a function with required and optional arguments, specific result format, and variable-length argument support.

Declaration

public FunctionInfo(string name, FunctionCategory category, string description, IEnumerable<ArgumentInfo> requiredArgumentsInfos, IEnumerable<ArgumentInfo> optionalArgumentsInfos, CellValueFormat format, int optionalArgumentsRepeatCount = 1, bool isDefaultValueFunction = false, string descriptionLocalizationKey = null)

Parameters

System.String name The name of the function.

FunctionCategory category The category of the function.

System.String description The description of the function.

System.Collections.Generic.IEnumerable<ArgumentInfo> requiredArgumentsInfos The required arguments infos for the function.

System.Collections.Generic.IEnumerable<ArgumentInfo> optionalArgumentsInfos The optional arguments infos for the function.

CellValueFormat format The format of the function.

System.Int32 optionalArgumentsRepeatCount The count of the optional arguments for the function.

System.Boolean isDefaultValueFunction Boolean indicating whether the function is default value function.

System.String descriptionLocalizationKey The localization key of the function description.

FunctionInfo(String, FunctionCategory, String, IEnumerable<ArgumentInfo>, CellValueFormat, Boolean, String)

Initializes a new FunctionInfo for a function with required arguments, specific result format, and optional default value support.

Declaration

public FunctionInfo(string name, FunctionCategory category, string description, IEnumerable<ArgumentInfo> requiredArgumentsInfos, CellValueFormat format, bool isDefaultValueFunction = false, string descriptionLocalizationKey = null)

Parameters

System.String name The name of the function.

FunctionCategory category The category of the function.

System.String description The description of the function.

System.Collections.Generic.IEnumerable<ArgumentInfo> requiredArgumentsInfos The required arguments infos for the function.

CellValueFormat format The format of the function.

System.Boolean isDefaultValueFunction Boolean indicating whether the function is default value function.

System.String descriptionLocalizationKey The localization key of the function description.

FunctionInfo(String, FunctionCategory, String, String)

Initializes a new FunctionInfo with basic metadata for a function with no arguments and general format.

Declaration

public FunctionInfo(string name, FunctionCategory category, string description, string descriptionLocalizationKey = null)

Parameters

System.String name The name of the function.

FunctionCategory category The category of the function.

System.String description The description of the function.

System.String descriptionLocalizationKey The localization key of the function description.

FunctionInfo(String, FunctionCategory, String, CellValueFormat, String)

Initializes a new FunctionInfo with basic metadata for a function with no arguments and a specific result format.

Declaration

public FunctionInfo(string name, FunctionCategory category, string description, CellValueFormat format, string descriptionLocalizationKey = null)

Parameters

System.String name The name of the function.

FunctionCategory category The category of the function.

System.String description The description of the function.

CellValueFormat format The format of the function.

System.String descriptionLocalizationKey The localization key of the function description.

Properties

Category

Gets the function's domain category for organizational and filtering purposes.

Declaration

public FunctionCategory Category { get; }

Property Value

FunctionCategory The category.

Description

Gets the human-readable description explaining what the function does and how to use it.

Declaration

public string Description { get; }

Property Value

System.String The description.

DescriptionLocalizationKey

Gets the localization key used to retrieve the function description in the current UI culture.

Declaration

public string DescriptionLocalizationKey { get; }

Property Value

System.String The description localization key.

Format

Gets the default cell value format applied to the function's result (e.g., percentage, date, currency).

Declaration

public CellValueFormat Format { get; }

Property Value

CellValueFormat The format.

IsDefaultValueFunction

Gets whether the function uses default values for omitted arguments, allowing calls with fewer than the total argument count.

Declaration

public bool IsDefaultValueFunction { get; }

Property Value

System.Boolean Boolean indicating whether the function is default value function.

OptionalArgumentsCount

Gets the number of optional arguments per repetition group that may be provided when calling this function.

Declaration

public int OptionalArgumentsCount { get; }

Property Value

System.Int32 The optional arguments count.

OptionalArgumentsRepetitionCount

Gets the maximum number of times the optional argument group can be repeated for functions accepting variable-length argument lists.

Declaration

public int OptionalArgumentsRepetitionCount { get; }

Property Value

System.Int32 The optional arguments repetition count.

RequiredArgumentsCount

Gets the number of required arguments that must be provided when calling this function.

Declaration

public int RequiredArgumentsCount { get; }

Property Value

System.Int32 The required arguments count.