GrapeCity.Documents.Excel.Parameter

Class Parameter

Namespace

GrapeCity.Documents.Excel

Assembly

GcDocs.Excel.dll

Represents the parameter of a function.

public class Parameter

Inheritance

object

Parameter

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

Parameter(FunctionValueType, bool, bool)

Initializes an instance of a parameter.

public Parameter(FunctionValueType valueType, bool acceptReference, bool acceptCustomObjects)

Parameters

valueType FunctionValueType

The value type of the parameter.

acceptReference bool

If this parameter can accept reference.

acceptCustomObjects bool

Accepts custom objects if value type is Object.

Parameter(FunctionValueType, bool)

Initializes an instance of a parameter.

public Parameter(FunctionValueType valueType, bool acceptReference)

Parameters

valueType FunctionValueType

The value type of the parameter.

acceptReference bool

If this parameter can accept reference.

Parameter(FunctionValueType, object, bool)

Initializes an instance of a parameter.

public Parameter(FunctionValueType valueType, object defaultValue, bool acceptReference)

Parameters

valueType FunctionValueType

The value type of the parameter.

defaultValue object

The default value of the parameter.

acceptReference bool

If this parameter can accept reference.

Parameter(FunctionValueType, object)

Initializes an instance of a parameter.

public Parameter(FunctionValueType valueType, object defaultValue)

Parameters

valueType FunctionValueType

The value type of the parameter.

defaultValue object

The default value of the parameter.

Parameter(FunctionValueType)

Initializes an instance of a parameter.

public Parameter(FunctionValueType valueType)

Parameters

valueType FunctionValueType

The value type of the parameter.

Parameter(string, string, FunctionValueType, object, bool, bool)

Initializes an instance of a parameter.

public Parameter(string name, string description, FunctionValueType valueType, object defaultValue, bool acceptReference, bool acceptCustomObjects)

Parameters

name string

The name of the function.

description string

The description of the parameter.

valueType FunctionValueType

The value type of the parameter.

defaultValue object

The default value of the parameter.

acceptReference bool

If this parameter can accept reference.

acceptCustomObjects bool

Accepts custom objects if value type is Object.

Parameter(string, string, FunctionValueType, object, bool)

Initializes an instance of a parameter.

public Parameter(string name, string description, FunctionValueType valueType, object defaultValue, bool acceptReference)

Parameters

name string

The name of the function.

description string

The description of the parameter.

valueType FunctionValueType

The value type of the parameter.

defaultValue object

The default value of the parameter.

acceptReference bool

If this parameter can accept reference.

Parameter(string, string, FunctionValueType, object)

Initializes an instance of a parameter.

public Parameter(string name, string description, FunctionValueType valueType, object defaultValue)

Parameters

name string

The name of the parameter.

description string

The description of the parameter.

valueType FunctionValueType

The value type of the parameter.

defaultValue object

The default value of the parameter.

Properties

AcceptCustomObjects

Accepts custom objects if value type is Object.

public bool AcceptCustomObjects { get; }

Property Value

bool

AcceptReference

if the parameter can accept reference.

public bool AcceptReference { get; }

Property Value

bool

DefaultValue

Gets the default value of the parameter.

public object DefaultValue { get; }

Property Value

object

Description

Gets the description of the parameter.

public string Description { get; }

Property Value

string

Name

Gets the name of the parameter.

public string Name { get; }

Property Value

string

ValueType

Gets the value type of the parameter.

public FunctionValueType ValueType { get; }

Property Value

FunctionValueType