ComponentBase.SetParametersAsync(ParameterView) Method

Definition

Sets parameters supplied by the component's parent in the render tree.

public:
 virtual System::Threading::Tasks::Task ^ SetParametersAsync(Microsoft::AspNetCore::Components::ParameterView parameters);
public virtual System.Threading.Tasks.Task SetParametersAsync (Microsoft.AspNetCore.Components.ParameterView parameters);
abstract member SetParametersAsync : Microsoft.AspNetCore.Components.ParameterView -> System.Threading.Tasks.Task
override this.SetParametersAsync : Microsoft.AspNetCore.Components.ParameterView -> System.Threading.Tasks.Task
Public Overridable Function SetParametersAsync (parameters As ParameterView) As Task

Parameters

parameters
ParameterView

The parameters.

Returns

Task

A Task that completes when the component has finished updating and rendering itself.

Implements

Remarks

The SetParametersAsync(ParameterView) method should be passed the entire set of parameter values each time SetParametersAsync(ParameterView) is called. It not required that the caller supply a parameter value for all parameters that are logically understood by the component.

The default implementation of SetParametersAsync(ParameterView) will set the value of each property decorated with ParameterAttribute or CascadingParameterAttribute that has a corresponding value in the ParameterView. Parameters that do not have a corresponding value will be unchanged.

Applies to