IGH_ContextualParameter

References
public interface IGH_ContextualParameter
Base interface for contextual parameters. This makes accessing non-strongly-typed functionality easier.

Properties

AtLeast

#
int AtLeast { get; }
Minimum number of inputs to request

AtMost

#
int AtMost { get; }
Maximum number of inputs to request.

ContextualData

#
IEnumerable<object> ContextualData { get; }
Iterate over all specified contextual values.

Immediate

#
bool Immediate { get; }
Gets whether this parameter triggers immediate updates from inside its getter. Immediacy is important for a smooth experience, but it maybe disabled if the expected recalculation time becomes excessive.

Prompt

#
string Prompt { get; }
Gets the prompt to be displayed while asking the user to enter data. The prompt string may contain '{0}' fields which will be populated with the amount of values picked so far.

Methods

AssignContextualData

#
void AssignContextualData(IEnumerable data)
Assign a collection of values as contextual data.
Parameters:
data (IEnumerable)Data to assign. Should be of expected type.

AutoAssignContextualData

#
bool AutoAssignContextualData(GH_ParameterContext context)
Use the in-build getter UI to assign data to the parameter.
Parameters:
context (GH_ParameterContext)