ClassArgumentInfo
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
ArgumentInfo(string, string, ArgumentType, bool, string, string)
Initializes a new instance of the ArgumentInfo class with metadata for a function argument, optionally supporting localization.
Declaration
public ArgumentInfo(string name, string description, ArgumentType type, bool isRequired = true, string nameLocalizationKey = null, string descriptionLocalizationKey = null)Parameters
name
The name of the argument.
description
The description of the argument.
type
The type type of the argument.
isRequired
Boolean indicating whether the argument is required or optional. If it is required, it should be set to true.
nameLocalizationKey
The localization key of the name of the argument.
descriptionLocalizationKey
The localization key of the description of the argument.
Properties
Description
The human-readable description explaining what the argument does.
Declaration
public string Description { get; }Property Value
The description.
DescriptionLocalizationKey
The localization resource key for the argument description.
Declaration
public string DescriptionLocalizationKey { get; }Property Value
The description localization key.
Name
The argument's display name.
NameLocalizationKey
The localization resource key for the argument name.
Declaration
public string NameLocalizationKey { get; }Property Value
The name localization key.
Type
The expected data type for this argument.
Declaration
public ArgumentType Type { get; }Property Value
The type.