ArgumentInfo
Metadata describing a function argument including its name, expected type, description, and whether it is required or optional. Use this for function documentation and validation.
Definition
Namespace:Telerik.Windows.Documents.Spreadsheet.Expressions.Functions
Assembly:Telerik.Windows.Documents.Spreadsheet.dll
Syntax:
public class ArgumentInfoInheritance: objectArgumentInfo
Constructors
Initializes a new instance of the ArgumentInfo class with metadata for a function argument, optionally supporting localization.
public ArgumentInfo(string name, string description, ArgumentType type, bool isRequired = true, string nameLocalizationKey = null, string descriptionLocalizationKey = null)The name of the argument.
descriptionstringThe description of the argument.
typeArgumentTypeThe type type of the argument.
isRequiredboolBoolean indicating whether the argument is required or optional. If it is required, it should be set to true.
nameLocalizationKeystringThe localization key of the name of the argument.
descriptionLocalizationKeystringThe localization key of the description of the argument.
Properties
The human-readable description explaining what the argument does.
public string Description { get; }The description.
The localization resource key for the argument description.
public string DescriptionLocalizationKey { get; }The description localization key.
The localization resource key for the argument name.
public string NameLocalizationKey { get; }The name localization key.
The expected data type for this argument.
public ArgumentType Type { get; }The type.