GH_Component.GH_InputParamManager.AddBooleanParameter Method (String, String, String, GH_ParamAccess, IEnumerable(Boolean))

GH_ComponentGH_InputParamManagerAddBooleanParameter Method (String, String, String, GH_ParamAccess, IEnumerableBoolean)

Add a Boolean parameter to the input list of this component.

Namespace:  Grasshopper.Kernel
Assembly:  Grasshopper (in Grasshopper.dll)
Syntax
Copy
public int AddBooleanParameter(
	string name,
	string nickname,
	string description,
	GH_ParamAccess access,
	IEnumerable<bool> default
)
Public Function AddBooleanParameter ( 
	name As String,
	nickname As String,
	description As String,
	access As GH_ParamAccess,
	default As IEnumerable(Of Boolean)
) 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: System.Collections.GenericIEnumerableBoolean
A collection of default values to store in the parameter Persistent Data.

Return Value

Type: Int32
See Also

M:Grasshopper.Kernel.GH_Component.GH_InputParamManager.AddBooleanParameter(System.String,System.String,System.String,Grasshopper.Kernel.GH_ParamAccess,System.Collections.Generic.IEnumerable{System.Boolean})