ClassFunctionInfo
Metadata describing a spreadsheet function's signature, including name, category, argument definitions, and result format.
Definition
Namespace:Telerik.Windows.Documents.Spreadsheet.Expressions.Functions
Assembly:Telerik.Windows.Documents.Spreadsheet.dll
Syntax:
public class FunctionInfoInheritance: objectFunctionInfo
Constructors
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
name
The name of the function.
category
The category of the function.
description
The description of the function.
format
The format of the function.
descriptionLocalizationKey
The localization key of the function description.
FunctionInfo(string, FunctionCategory, string, IEnumerable<ArgumentInfo>, CellValueFormat, bool, 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
name
The name of the function.
category
The category of the function.
description
The description of the function.
requiredArgumentsInfos
The required arguments infos for the function.
format
The format of the function.
isDefaultValueFunction
Boolean indicating whether the function is default value function.
descriptionLocalizationKey
The localization key of the function description.
FunctionInfo(string, FunctionCategory, string, IEnumerable<ArgumentInfo>, IEnumerable<ArgumentInfo>, CellValueFormat, int, bool, 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
name
The name of the function.
category
The category of the function.
description
The description of the function.
requiredArgumentsInfos
The required arguments infos for the function.
optionalArgumentsInfos
The optional arguments infos for the function.
format
The format of the function.
optionalArgumentsRepeatCount
The count of the optional arguments for the function.
isDefaultValueFunction
Boolean indicating whether the function is default value function.
descriptionLocalizationKey
The localization key of the function description.
FunctionInfo(string, FunctionCategory, string, IEnumerable<ArgumentInfo>, IEnumerable<ArgumentInfo>, int, bool, 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
name
The name of the function.
category
The category of the function.
description
The description of the function.
requiredArgumentsInfos
The required arguments infos for the function.
optionalArgumentsInfos
The optional arguments infos for the function.
optionalArgumentsRepeatCount
The count of the optional arguments for the function.
isDefaultValueFunction
Boolean indicating whether the function is default value function.
descriptionLocalizationKey
The localization key of the function description.
FunctionInfo(string, FunctionCategory, string, IEnumerable<ArgumentInfo>, bool, 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
name
The name of the function.
category
The category of the function.
description
The description of the function.
requiredArgumentsInfos
The required arguments infos for the function.
isDefaultValueFunction
Boolean indicating whether the function is default value function.
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
name
The name of the function.
category
The category of the function.
description
The description of the function.
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
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
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
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
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
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
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
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
The required arguments count.