FunctionInfo
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
Initializes a new FunctionInfo with basic metadata for a function with no arguments and a specific result format.
public FunctionInfo(string name, FunctionCategory category, string description, CellValueFormat format, string descriptionLocalizationKey = null)The name of the function.
categoryFunctionCategoryThe category of the function.
descriptionstringThe description of the function.
formatCellValueFormatThe format of the function.
descriptionLocalizationKeystringThe localization key of the function description.
Initializes a new FunctionInfo for a function with required arguments, general format, and optional default value support.
public FunctionInfo(string name, FunctionCategory category, string description, IEnumerable<ArgumentInfo> requiredArgumentsInfos, bool isDefaultValueFunction = false, string descriptionLocalizationKey = null)The name of the function.
categoryFunctionCategoryThe category of the function.
descriptionstringThe description of the function.
requiredArgumentsInfosIEnumerable<ArgumentInfo>The required arguments infos for the function.
isDefaultValueFunctionboolBoolean indicating whether the function is default value function.
descriptionLocalizationKeystringThe localization key of the function description.
Initializes a new FunctionInfo for a function with required arguments, specific result format, and optional default value support.
public FunctionInfo(string name, FunctionCategory category, string description, IEnumerable<ArgumentInfo> requiredArgumentsInfos, CellValueFormat format, bool isDefaultValueFunction = false, string descriptionLocalizationKey = null)The name of the function.
categoryFunctionCategoryThe category of the function.
descriptionstringThe description of the function.
requiredArgumentsInfosIEnumerable<ArgumentInfo>The required arguments infos for the function.
formatCellValueFormatThe format of the function.
isDefaultValueFunctionboolBoolean indicating whether the function is default value function.
descriptionLocalizationKeystringThe localization key of the function description.
Initializes a new FunctionInfo with complete metadata for a function with required and optional arguments, specific result format, and variable-length argument support.
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)The name of the function.
categoryFunctionCategoryThe category of the function.
descriptionstringThe description of the function.
requiredArgumentsInfosIEnumerable<ArgumentInfo>The required arguments infos for the function.
optionalArgumentsInfosIEnumerable<ArgumentInfo>The optional arguments infos for the function.
formatCellValueFormatThe format of the function.
optionalArgumentsRepeatCountintThe count of the optional arguments for the function.
isDefaultValueFunctionboolBoolean indicating whether the function is default value function.
descriptionLocalizationKeystringThe localization key of the function description.
Initializes a new FunctionInfo for a function with required and optional arguments, general format, and variable-length argument support.
public FunctionInfo(string name, FunctionCategory category, string description, IEnumerable<ArgumentInfo> requiredArgumentsInfos, IEnumerable<ArgumentInfo> optionalArgumentsInfos, int optionalArgumentsRepeatCount = 1, bool isDefaultValueFunction = false, string descriptionLocalizationKey = null)The name of the function.
categoryFunctionCategoryThe category of the function.
descriptionstringThe description of the function.
requiredArgumentsInfosIEnumerable<ArgumentInfo>The required arguments infos for the function.
optionalArgumentsInfosIEnumerable<ArgumentInfo>The optional arguments infos for the function.
optionalArgumentsRepeatCountintThe count of the optional arguments for the function.
isDefaultValueFunctionboolBoolean indicating whether the function is default value function.
descriptionLocalizationKeystringThe localization key of the function description.
Initializes a new FunctionInfo with basic metadata for a function with no arguments and general format.
public FunctionInfo(string name, FunctionCategory category, string description, string descriptionLocalizationKey = null)The name of the function.
categoryFunctionCategoryThe category of the function.
descriptionstringThe description of the function.
descriptionLocalizationKeystringThe localization key of the function description.
Properties
Gets the function's domain category for organizational and filtering purposes.
public FunctionCategory Category { get; }The category.
Gets the human-readable description explaining what the function does and how to use it.
public string Description { get; }The description.
Gets the localization key used to retrieve the function description in the current UI culture.
public string DescriptionLocalizationKey { get; }The description localization key.
Gets the default cell value format applied to the function's result (e.g., percentage, date, currency).
public CellValueFormat Format { get; }The format.
Gets whether the function uses default values for omitted arguments, allowing calls with fewer than the total argument count.
public bool IsDefaultValueFunction { get; }Boolean indicating whether the function is default value function.
Gets the number of optional arguments per repetition group that may be provided when calling this function.
public int OptionalArgumentsCount { get; }The optional arguments count.
Gets the maximum number of times the optional argument group can be repeated for functions accepting variable-length argument lists.
public int OptionalArgumentsRepetitionCount { get; }The optional arguments repetition count.
Gets the number of required arguments that must be provided when calling this function.
public int RequiredArgumentsCount { get; }The required arguments count.