SetState<TNode> Method (NodeExtension)

Sets the arbitrary object associated with the node.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
<NotNullAttribute()>
Public Shared Function SetState(Of TNode As Node)( _
   ByVal node As TNode, _
   ByVal state As Object _
) As TNode

'Usage
 
Dim node As TNode
Dim state As Object
Dim value As TNode
 
value = NodeExtension.SetState(Of TNode)(node, state)

[Extension()]
[NotNull()]
public static TNode SetState<TNode>( 
   TNode node,
   object state
)
where TNode: Node

[Extension()]
[NotNull()]
public:
static TNode^ SetStategeneric<typename TNode>
( 
   TNode^ node,
   Object^ state
) 
where TNode: Node

Parameters

node: The node that will be modified and returned.
The value of this parameter cannot be null (Nothing in Visual Basic).
state: The state object.
The value of this parameter can be null (Nothing in Visual Basic).

Type Parameters

TNode

Return Value

Returns the , internally modified as defined by the method.

This method never returns null (Nothing in Visual Basic).

Exceptions

Exception Description

Exception	Description
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

System.ArgumentNullException

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

Remarks

This is an extension method (info: C#, VB.NET). In languages that have support for extensions methods (such as C# and VB.NET), you can use the extension method as if it were a regular method on the object that is its first parameter. In other languages (such as with Python.NET), you will call the extension as a static method, and pass it the object on which it acts as its first parameter.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

NodeExtension Class
NodeExtension Members

Documentation Home, Send Documentation Feedback. Technical Support