Class 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.

Inheritance
System.Object
ArgumentInfo
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Windows.Documents.Spreadsheet.Expressions.Functions
Assembly: Telerik.Windows.Documents.Spreadsheet.dll

Syntax

public class ArgumentInfo

Constructors

ArgumentInfo(String, String, ArgumentType, Boolean, 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
System.String name

The name of the argument.
System.String description

The description of the argument.
ArgumentType type

The type type of the argument.
System.Boolean isRequired

Boolean indicating whether the argument is required or optional. If it is required, it should be set to true.
System.String nameLocalizationKey

The localization key of the name of the argument.
System.String 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
System.String

The description.

DescriptionLocalizationKey

The localization resource key for the argument description.

Declaration
public string DescriptionLocalizationKey { get; }
Property Value
System.String

The description localization key.

Name

The argument's display name.

Declaration
public string Name { get; }
Property Value
System.String

The name.

NameLocalizationKey

The localization resource key for the argument name.

Declaration
public string NameLocalizationKey { get; }
Property Value
System.String

The name localization key.

Type

The expected data type for this argument.

Declaration
public ArgumentType Type { get; }
Property Value
ArgumentType

The type.