FunctionArguments Class
Represents the arguments passed to a formula function, organized by parameter name.
Inheritance
Object
Documents.Spreadsheet.FunctionArguments
Namespace: Radzen.Documents.Spreadsheet
Assembly: Radzen.Blazor.dll
Syntax
public class FunctionArgumentsConstructors
FunctionArgumentslink
Represents the arguments passed to a formula function, organized by parameter name.
Declaration
public FunctionArguments(Documents.Spreadsheet.Cell currentCell)Parameters
| Type | Name | Description |
|---|---|---|
| Documents.Spreadsheet.Cell | currentCell |
Properties
CurrentCelllink
The cell currently being evaluated (context for functions like ROW/COLUMN when reference is omitted).
Declaration
public Documents.Spreadsheet.Cell CurrentCell { get; }Property Value
| Type | Description |
|---|---|
| Documents.Spreadsheet.Cell | The cell currently being evaluated (context for functions like ROW/COLUMN when reference is omitted). |
Methods
GetGroupslink
Gets the argument groups for a Group parameter. Each inner list is one argument's cells with its range shape preserved (a single cell is a one-element list).
Declaration
public List<List<Documents.Spreadsheet.CellData>> GetGroups(string parameterName)Parameters
| Type | Name | Description |
|---|---|---|
| string | parameterName | The name of the parameter. |
Returns
| Type | Description |
|---|---|
| List<List<Documents.Spreadsheet.CellData>> | The list of argument groups, or null if not found. |
GetRangelink
Gets a range of CellData values for the specified parameter name.
Declaration
public List<Documents.Spreadsheet.CellData> GetRange(string parameterName)Parameters
| Type | Name | Description |
|---|---|---|
| string | parameterName | The name of the parameter. |
Returns
| Type | Description |
|---|---|
| List<Documents.Spreadsheet.CellData> | The list of CellData values, or null if not found. |
GetSequencelink
Gets a sequence of CellData values for the specified parameter name.
Declaration
public List<Documents.Spreadsheet.CellData> GetSequence(string parameterName)Parameters
| Type | Name | Description |
|---|---|---|
| string | parameterName | The name of the parameter. |
Returns
| Type | Description |
|---|---|
| List<Documents.Spreadsheet.CellData> | The list of CellData values, or null if not found. |
GetSinglelink
Gets a single CellData value for the specified parameter name.
Declaration
public Documents.Spreadsheet.CellData GetSingle(string parameterName)Parameters
| Type | Name | Description |
|---|---|---|
| string | parameterName | The name of the parameter. |
Returns
| Type | Description |
|---|---|
| Documents.Spreadsheet.CellData | The CellData value, or null if not found. |
Setlink
Sets an argument value for the specified parameter name.
Declaration
public void Set(string parameterName, object value)Parameters
| Type | Name | Description |
|---|---|---|
| string | parameterName | The name of the parameter. |
| object | value | The argument value. |