GH_ComponentGH_InputParamManagerAddBoxParameter Method (String, String, String, GH_ParamAccess, Box)

public int AddBoxParameter(
	string name,
	string nickname,
	string description,
	GH_ParamAccess access,
	Box default
)

Public Function AddBoxParameter ( 
	name As String,
	nickname As String,
	description As String,
	access As GH_ParamAccess,
	default As Box
) As Integer

Parameters

name

Type: SystemString
The name of the parameter. Keep it short, single words are best.

nickname

Type: SystemString
The nickname of the parameter. Keep it short, single characters are best.

description

Type: SystemString
The description of the parameter. Be succinct but clear, single sentences are best.

access

Type: Grasshopper.KernelGH_ParamAccess
Parameter access type. You must provide a correct access code in order to use GetData(), GetDataList() or GetDataTree() respectively.

default

Type: Box
A default value to store in the parameter Persistent Data.

Return Value

Reference