IGH_ContextualParameter2

public interface IGH_ContextualParameter2 : IGH_ContextualParameter
Version 2 of Base interface for contextual parameters. This makes accessing non-strongly-typed functionality easier.

Properties

AtLeast

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

AtMost

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

ContextualData

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

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.
inherited fromIGH_ContextualParameter

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.
inherited fromIGH_ContextualParameter

Methods

AssignContextualData

void AssignContextualData(IEnumerable data)
Assign a collection of values as contextual data.
inherited fromIGH_ContextualParameter
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.
inherited fromIGH_ContextualParameter
Parameters:
context (GH_ParameterContext)

ClearContextualData

#
void ClearContextualData()
Clear previously assigned collection of values as contextual data