Class ExpressionBuilderArgument
Represents a workflow argument assignment. This class determines the index of a workflow connection and is used to specify the order of input connections to any given node.
Inherited Members
Namespace: Bonsai.Expressions
Assembly: Bonsai.Core.dll
Syntax
[TypeConverter("Bonsai.Design.ExpressionBuilderArgumentTypeConverter, Bonsai.Design")]
public class ExpressionBuilderArgument : IEquatable<ExpressionBuilderArgument>, IComparable<ExpressionBuilderArgument>, IComparable
Constructors
| Improve this Doc View SourceExpressionBuilderArgument()
Initializes a new instance of the ExpressionBuilderArgument class.
Declaration
public ExpressionBuilderArgument()
ExpressionBuilderArgument(Int32)
Initializes a new instance of the ExpressionBuilderArgument class with the specified argument index.
Declaration
public ExpressionBuilderArgument(int index)
Parameters
Type | Name | Description |
---|---|---|
Int32 | index | The zero-based index of the input argument. |
ExpressionBuilderArgument(String)
Initializes a new instance of the ExpressionBuilderArgument class with the specified argument name.
Declaration
public ExpressionBuilderArgument(string name)
Parameters
Type | Name | Description |
---|---|---|
String | name | The name of the input argument. Arbitrary named arguments are not supported, so all names must start with the ArgumentNamePrefix followed by the one-based argument index. |
Fields
| Improve this Doc View SourceArgumentNamePrefix
The prefix that starts every input argument name.
Declaration
public const string ArgumentNamePrefix = "Source"
Field Value
Type | Description |
---|---|
String |
Properties
| Improve this Doc View SourceIndex
Gets or sets the zero-based index of the input argument.
Declaration
public int Index { get; set; }
Property Value
Type | Description |
---|---|
Int32 |
Name
Gets or sets the name of the input argument. Arbitrary named arguments are not supported, so all names must start with the ArgumentNamePrefix followed by the one-based argument index.
Declaration
public string Name { get; set; }
Property Value
Type | Description |
---|---|
String |
Methods
| Improve this Doc View SourceCompareTo(ExpressionBuilderArgument)
Compares the current object with another object of the same type.
Declaration
public int CompareTo(ExpressionBuilderArgument other)
Parameters
Type | Name | Description |
---|---|---|
ExpressionBuilderArgument | other | An object to compare with this object. |
Returns
Type | Description |
---|---|
Int32 | A value that indicates the relative order of the objects being compared.
Less than zero means this object is less than the |
Equals(ExpressionBuilderArgument)
Indicates whether the specified argument is equal to the current argument.
Declaration
public bool Equals(ExpressionBuilderArgument other)
Parameters
Type | Name | Description |
---|---|---|
ExpressionBuilderArgument | other | The argument object to compare with the current argument. |
Returns
Type | Description |
---|---|
Boolean | true if the specified argument object is equal to the current argument; otherwise, false. |
Equals(Object)
Returns a value indicating whether this instance is equal to a specified object.
Declaration
public override bool Equals(object obj)
Parameters
Type | Name | Description |
---|---|---|
Object | obj | An object to compare with this instance. |
Returns
Type | Description |
---|---|
Boolean | true if |
Overrides
| Improve this Doc View SourceGetHashCode()
Returns the hash code for this instance.
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
Int32 | A 32-bit signed integer hash code. |
Overrides
| Improve this Doc View SourceToString()
Returns a string that represents the current object.
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
String | A string that represents the current object. |
Overrides
Operators
| Improve this Doc View SourceEquality(ExpressionBuilderArgument, ExpressionBuilderArgument)
Tests whether two ExpressionBuilderArgument instances are equal.
Declaration
public static bool operator ==(ExpressionBuilderArgument left, ExpressionBuilderArgument right)
Parameters
Type | Name | Description |
---|---|---|
ExpressionBuilderArgument | left | The ExpressionBuilderArgument instance on the left of the equality operator. |
ExpressionBuilderArgument | right | The ExpressionBuilderArgument instance on the right of the equality operator. |
Returns
Type | Description |
---|---|
Boolean | true if |
GreaterThan(ExpressionBuilderArgument, ExpressionBuilderArgument)
Tests whether an ExpressionBuilderArgument object is greater than another object of the same type.
Declaration
public static bool operator>(ExpressionBuilderArgument left, ExpressionBuilderArgument right)
Parameters
Type | Name | Description |
---|---|---|
ExpressionBuilderArgument | left | The ExpressionBuilderArgument object on the left of the greater than operator. |
ExpressionBuilderArgument | right | The ExpressionBuilderArgument object on the right of the greater than operator. |
Returns
Type | Description |
---|---|
Boolean | true if |
Inequality(ExpressionBuilderArgument, ExpressionBuilderArgument)
Tests whether two ExpressionBuilderArgument instances are different.
Declaration
public static bool operator !=(ExpressionBuilderArgument left, ExpressionBuilderArgument right)
Parameters
Type | Name | Description |
---|---|---|
ExpressionBuilderArgument | left | The ExpressionBuilderArgument instance on the left of the inequality operator. |
ExpressionBuilderArgument | right | The ExpressionBuilderArgument instance on the right of the inequality operator. |
Returns
Type | Description |
---|---|
Boolean | true if |
LessThan(ExpressionBuilderArgument, ExpressionBuilderArgument)
Tests whether an ExpressionBuilderArgument object is less than another object of the same type.
Declaration
public static bool operator <(ExpressionBuilderArgument left, ExpressionBuilderArgument right)
Parameters
Type | Name | Description |
---|---|---|
ExpressionBuilderArgument | left | The ExpressionBuilderArgument object on the left of the less than operator. |
ExpressionBuilderArgument | right | The ExpressionBuilderArgument object on the right of the less than operator. |
Returns
Type | Description |
---|---|
Boolean | true if |
Explicit Interface Implementations
| Improve this Doc View SourceIComparable.CompareTo(Object)
Declaration
int IComparable.CompareTo(object obj)
Parameters
Type | Name | Description |
---|---|---|
Object | obj |
Returns
Type | Description |
---|---|
Int32 |