GrapeCity.Documents.Excel.Parameter.Description

Description Property

Description

Gets the description of the parameter.

This description provides user-facing information about the purpose of the parameter when defining a CustomFunction or AsyncCustomFunction. Returns the description that was specified when the Parameter instance was created.

Declaration

public string Description { get; }

Public ReadOnly Property Description As String

Examples

Parameter priceParameter = new Parameter("price", "Original price.", FunctionValueType.Number, 0d);
Parameter discountParameter = new Parameter("discount", "Discount rate.", FunctionValueType.Number, 0d);
Workbook.AddCustomFunction(new DiscountPriceFunction(new[] { priceParameter, discountParameter }), true);
string description = discountParameter.Description;