[]
DEMOS DOCS API PRICING
FREE TRIAL
(Showing Draft Content)

Parameter

Class Parameter

java.lang.Object
com.grapecity.documents.excel.Parameter
public class Parameter extends Object
Represents the parameter of a function.

  • Constructor Details

    • Parameter

      public Parameter(FunctionValueType valueType)
      Initializes an instance of a parameter.
      Parameters:
      valueType - The value type of the parameter.

    • Parameter

      public Parameter(FunctionValueType valueType, boolean acceptReference)
      Initializes an instance of a parameter.
      Parameters:
      valueType - The value type of the parameter.
      acceptReference - If this parameter can accept reference.

    • Parameter

      public Parameter(FunctionValueType valueType, Object defaultValue)
      Initializes an instance of a parameter.
      Parameters:
      valueType - The value type of the parameter.
      defaultValue - The default value of the parameter.

    • Parameter

      public Parameter(FunctionValueType valueType, Object defaultValue, boolean acceptReference)
      Initializes an instance of a parameter.
      Parameters:
      valueType - The value type of the parameter.
      defaultValue - The default value of the parameter.
      acceptReference - If this parameter can accept reference.

    • Parameter

      public Parameter(String name, String description, FunctionValueType valueType, Object defaultValue)
      Initializes an instance of a parameter.
      Parameters:
      name - The name of the parameter.
      description - The description of the parameter.
      valueType - The value type of the parameter.
      defaultValue - The default value of the parameter.

    • Parameter

      public Parameter(String name, String description, FunctionValueType valueType, Object defaultValue, boolean acceptReference)
      Initializes an instance of a parameter.
      Parameters:
      name - The name of the parameter.
      description - The description of the parameter.
      valueType - The value type of the parameter.
      defaultValue - The default value of the parameter.
      acceptReference - If this parameter can accept reference.

    • Parameter

      public Parameter(FunctionValueType valueType, boolean acceptReference, boolean acceptCustomObjects)
      Initializes an instance of a parameter.
      Parameters:
      valueType - The value type of the parameter.
      acceptReference - If this parameter can accept reference.
      acceptCustomObjects - Accepts custom objects if value type is FunctionValueType.Object.

    • Parameter

      public Parameter(String name, String description, FunctionValueType valueType, Object defaultValue, boolean acceptReference, boolean acceptCustomObjects)
      Initializes an instance of a parameter.
      Parameters:
      name - The name of the function.
      description - The description of the parameter.
      valueType - The value type of the parameter.
      defaultValue - The default value of the parameter.
      acceptReference - If this parameter can accept reference.
      acceptCustomObjects - Accepts custom objects if value type is FunctionValueType.Object.

  • Method Details

    • getName

      public final String getName()
      Gets the name of the parameter.

    • getDescription

      public final String getDescription()
      Gets the description of the parameter.

    • getValueType

      public final FunctionValueType getValueType()
      Gets the value type of the parameter.

    • getDefaultValue

      public final Object getDefaultValue()
      Gets the default value of the parameter.

    • getAcceptReference

      public final boolean getAcceptReference()
      Gets the parameter can or can't accept reference.