GH_Component.GH_OutputParamManager.AddParameter Method (IGH_Param, String, String, String, GH_ParamAccess)

GH_ComponentGH_OutputParamManagerAddParameter Method (IGH_Param, String, String, String, GH_ParamAccess)

Generic parameter addition. If you cannot use one of the utility methods provided by this class, you can register a customized parameter using this method.

Namespace:  Grasshopper.Kernel
Assembly:  Grasshopper (in Grasshopper.dll)
Syntax
Copy
public int AddParameter(
	IGH_Param param,
	string name,
	string nickname,
	string description,
	GH_ParamAccess access
)
Public Function AddParameter ( 
	param As IGH_Param,
	name As String,
	nickname As String,
	description As String,
	access As GH_ParamAccess
) As Integer

Parameters

param
Type: Grasshopper.KernelIGH_Param
The parameter to add.
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 SetData(), SetDataList() or SetDataTree() respectively.

Return Value

Type: Int32
Index of the newly added parameter.
See Also

M:Grasshopper.Kernel.GH_Component.GH_OutputParamManager.AddParameter(Grasshopper.Kernel.IGH_Param,System.String,System.String,System.String,Grasshopper.Kernel.GH_ParamAccess)