Class FunctionInfo
Provides properties for describing a FunctionBase.
Inheritance
Inherited Members
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 instance of the FunctionInfo class.
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 instance of the FunctionInfo class.
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 instance of the FunctionInfo class.
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 instance of the FunctionInfo class.
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 instance of the FunctionInfo class.
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 instance of the FunctionInfo class.
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 category.
Declaration
public FunctionCategory Category { get; }
Property Value
FunctionCategory
The category. |
Description
Gets the description.
Declaration
public string Description { get; }
Property Value
System.String
The description. |
DescriptionLocalizationKey
Gets the description localization key.
Declaration
public string DescriptionLocalizationKey { get; }
Property Value
System.String
The description localization key. |
Format
Gets the format.
Declaration
public CellValueFormat Format { get; }
Property Value
CellValueFormat
The format. |
IsDefaultValueFunction
Gets a value indicating whether the function is default value function.
Declaration
public bool IsDefaultValueFunction { get; }
Property Value
System.Boolean
Boolean indicating whether the function is default value function. |
OptionalArgumentsCount
Gets the optional arguments count.
Declaration
public int OptionalArgumentsCount { get; }
Property Value
System.Int32
The optional arguments count. |
OptionalArgumentsRepetitionCount
Gets the optional arguments repetition count.
Declaration
public int OptionalArgumentsRepetitionCount { get; }
Property Value
System.Int32
The optional arguments repetition count. |
RequiredArgumentsCount
Gets the required arguments count.
Declaration
public int RequiredArgumentsCount { get; }
Property Value
System.Int32
The required arguments count. |