Package com.grapecity.documents.excel
Class Parameter
java.lang.Object
com.grapecity.documents.excel.Parameter
Represents the parameter of a function.
-
Constructor Summary
ConstructorsConstructorDescriptionParameter(FunctionValueType valueType) Initializes an instance of a parameter.Parameter(FunctionValueType valueType, boolean acceptReference) Initializes an instance of a parameter.Parameter(FunctionValueType valueType, boolean acceptReference, boolean acceptCustomObjects) Initializes an instance of a parameter.Parameter(FunctionValueType valueType, Object defaultValue) Initializes an instance of a parameter.Parameter(FunctionValueType valueType, Object defaultValue, boolean acceptReference) Initializes an instance of a parameter.Parameter(String name, String description, FunctionValueType valueType, Object defaultValue) Initializes an instance of a parameter.Parameter(String name, String description, FunctionValueType valueType, Object defaultValue, boolean acceptReference) Initializes an instance of a parameter.Parameter(String name, String description, FunctionValueType valueType, Object defaultValue, boolean acceptReference, boolean acceptCustomObjects) Initializes an instance of a parameter. -
Method Summary
Modifier and TypeMethodDescriptionfinal booleanGets the parameter can or can't accept reference.final ObjectGets the default value of the parameter;final StringGets the description of the parameter;final StringgetName()Gets the name of the parameter;final FunctionValueTypeGets the value type of the parameter;
-
Constructor Details
-
Parameter
Initializes an instance of a parameter.- Parameters:
valueType- The value type of the parameter.
-
Parameter
Initializes an instance of a parameter.- Parameters:
valueType- The value type of the parameter.acceptReference- If this parameter can accept reference.
-
Parameter
Initializes an instance of a parameter.- Parameters:
valueType- The value type of the parameter.defaultValue- The default value of the parameter.
-
Parameter
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
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-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
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 isFunctionValueType.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 isFunctionValueType.Object.
-
-
Method Details
-
getName
Gets the name of the parameter; -
getDescription
Gets the description of the parameter; -
getValueType
Gets the value type of the parameter; -
getDefaultValue
Gets the default value of the parameter; -
getAcceptReference
public final boolean getAcceptReference()Gets the parameter can or can't accept reference.
-