如何在 Blazor 中编写自定义值更改事件处理程序?
How to write a custom value change event handler in Blazor?
我想为 Blazor 编写自定义下拉列表组件,部分原因是现有的 InputSelect 组件不绑定到字符串和枚举类型以外的任何类型。这对我来说还不够好,因为我的模型有 int 和 nullable int 类型的属性,我想将它们绑定到下拉列表。到目前为止我有这个:
@using System.Globalization
@typeparam TValue
@typeparam TData
@inherits InputBase<TValue>
<select id="@Id" @bind="CurrentValueAsString" class="f-select js-form-field">
@if (!string.IsNullOrWhiteSpace(OptionLabel) || Value == null)
{
<option value="">@(OptionLabel ?? "-- SELECT --")</option>
}
@foreach (var item in Data)
{
<option value="@GetPropertyValue(item, ValueFieldName)">@GetPropertyValue(item, TextFieldName)</option>
}
</select>
<span>Component Value is: @Value</span>
@code {
[Parameter]
public string Id { get; set; }
[Parameter]
public IEnumerable<TData> Data { get; set; } = new List<TData>();
[Parameter]
public string ValueFieldName { get; set; }
[Parameter]
public string TextFieldName { get; set; }
[Parameter]
public string OptionLabel { get; set; }
private Type ValueType => IsValueTypeNullable() ? Nullable.GetUnderlyingType(typeof(TValue)) : typeof(TValue);
protected override void OnInitialized()
{
base.OnInitialized();
ValidateInitialization();
}
private void ValidateInitialization()
{
if (string.IsNullOrWhiteSpace(ValueFieldName))
{
throw new ArgumentNullException(nameof(ValueFieldName), $"Parameter {nameof(ValueFieldName)} is required.");
}
if (string.IsNullOrWhiteSpace(TextFieldName))
{
throw new ArgumentNullException(nameof(TextFieldName), $"Parameter {nameof(TextFieldName)} is required.");
}
if (!HasProperty(ValueFieldName))
{
throw new Exception($"Data type {typeof(TData)} does not have a property called {ValueFieldName}.");
}
if (!HasProperty(TextFieldName))
{
throw new Exception($"Data type {typeof(TData)} does not have a property called {TextFieldName}.");
}
}
protected override bool TryParseValueFromString(string value, out TValue result, out string validationErrorMessage)
{
validationErrorMessage = null;
if (ValueType == typeof(string))
{
result = (TValue)(object)value;
return true;
}
if (ValueType == typeof(int))
{
if (string.IsNullOrWhiteSpace(value))
{
result = default;
}
else
{
if (int.TryParse(value, NumberStyles.Integer, CultureInfo.InvariantCulture, out var parsedValue))
{
result = (TValue)(object)parsedValue;
}
else
{
result = default;
validationErrorMessage = $"Specified value cannot be converted to type {typeof(TValue)}";
return false;
}
}
return true;
}
if (ValueType == typeof(Guid))
{
validationErrorMessage = null;
if (string.IsNullOrWhiteSpace(value))
{
result = default;
}
else
{
if (Guid.TryParse(value, out var parsedValue))
{
result = (TValue)(object)parsedValue;
}
else
{
result = default;
validationErrorMessage = $"Specified value cannot be converted to type {typeof(TValue)}";
return false;
}
}
return true;
}
throw new InvalidOperationException($"{GetType()} does not support the type '{typeof(TValue)}'. Supported types are string, int and Guid.");
}
private string GetPropertyValue(TData source, string propertyName)
{
return source.GetType().GetProperty(propertyName)?.GetValue(source, null).ToString();
}
private bool HasProperty(string propertyName)
{
return typeof(TData).GetProperty(propertyName) != null;
}
private bool IsValueTypeNullable()
{
return Nullable.GetUnderlyingType(typeof(TValue)) != null;
}
}
在 parent 组件中我可以这样使用它:
<DropDownList Id="@nameof(Model.SelectedYear)"
@bind-Value="Model.SelectedYear"
Data="Model.Years"
ValueFieldName="@nameof(Year.Id)"
TextFieldName="@nameof(Year.YearName)">
</DropDownList>
这非常有效,模型绑定到下拉列表,当下拉列表值更改时,parent 模型上的值也会更改。但是,我现在想在 parent 上捕获此值更改事件并执行一些自定义逻辑,主要是根据所选年份加载一些其他数据。我的猜测是我需要自定义 EventCallback,但我尝试的所有操作都会导致某种构建或运行时错误。看来如果我的组件继承自 InputBase 那么我能做的就非常有限了。
谁能告诉我如何从 parent 组件中捕获 child 组件的值变化?
My guess is that I need a custom EventCallback
您确实需要 EventCallback
,但问题是,您已经有了,只是没看到。
为了能够使用 @bind-Value
,您需要两个参数,T Value
和 EventCallback<T> ValueChanged
。
当您传递 @bind-Foo
时,blazor 会设置这两个参数,Foo
和 FooChanged
,在 FooChanged
中,它只会将新值设置为 Foo
.
因此,当您执行 @bind-Foo="Bar"
时,blazor 在后台所做的就是传递这两个参数
Foo="@Bar"
FooChanged="@(newValue => Bar = newValue)"
所以在你的情况下,你需要做的是传递你自己的 ValueChanged
函数,它在 Value
中设置新值,但也做一些你想要的额外事情。
<DropDownList Id="@nameof(Model.SelectedYear)"
Value="Model.SelectedYear"
ValueChanged="@((TYPE_OF_VALUE newValue) => HandleValueChanged(newValue))"
Data="Model.Years"
ValueFieldName="@nameof(Year.Id)"
TextFieldName="@nameof(Year.YearName)">
</DropDownList>
@code
{
void HandleValueChanged(TYPE_OF_VALUE newValue)
{
// do what you want to do
// set the newValue if you want
Model.SelectedYear = newValue;
}
}
在TYPE_OF_VALUE
中,你只需将其替换为Model.SelectedYear
的类型即可。
你可以看看docs中的这个解释。
编辑
因为你想使用可为 null 的类型,你还需要传递 FooExpression
,在你的情况下将是 Expression<Func<T>> ValueExpression
。
<DropDownList Id="@nameof(Model.SelectedYear)"
Value="Model.SelectedYear"
ValueChanged="@((TYPE_OF_VALUE newValue) => HandleValueChanged(newValue))"
ValueExpression="@(() => Model.SelectedYear)"
Data="Model.Years"
ValueFieldName="@nameof(Year.Id)"
TextFieldName="@nameof(Year.YearName)">
</DropDownList>
我想为 Blazor 编写自定义下拉列表组件,部分原因是现有的 InputSelect 组件不绑定到字符串和枚举类型以外的任何类型。这对我来说还不够好,因为我的模型有 int 和 nullable int 类型的属性,我想将它们绑定到下拉列表。到目前为止我有这个:
@using System.Globalization
@typeparam TValue
@typeparam TData
@inherits InputBase<TValue>
<select id="@Id" @bind="CurrentValueAsString" class="f-select js-form-field">
@if (!string.IsNullOrWhiteSpace(OptionLabel) || Value == null)
{
<option value="">@(OptionLabel ?? "-- SELECT --")</option>
}
@foreach (var item in Data)
{
<option value="@GetPropertyValue(item, ValueFieldName)">@GetPropertyValue(item, TextFieldName)</option>
}
</select>
<span>Component Value is: @Value</span>
@code {
[Parameter]
public string Id { get; set; }
[Parameter]
public IEnumerable<TData> Data { get; set; } = new List<TData>();
[Parameter]
public string ValueFieldName { get; set; }
[Parameter]
public string TextFieldName { get; set; }
[Parameter]
public string OptionLabel { get; set; }
private Type ValueType => IsValueTypeNullable() ? Nullable.GetUnderlyingType(typeof(TValue)) : typeof(TValue);
protected override void OnInitialized()
{
base.OnInitialized();
ValidateInitialization();
}
private void ValidateInitialization()
{
if (string.IsNullOrWhiteSpace(ValueFieldName))
{
throw new ArgumentNullException(nameof(ValueFieldName), $"Parameter {nameof(ValueFieldName)} is required.");
}
if (string.IsNullOrWhiteSpace(TextFieldName))
{
throw new ArgumentNullException(nameof(TextFieldName), $"Parameter {nameof(TextFieldName)} is required.");
}
if (!HasProperty(ValueFieldName))
{
throw new Exception($"Data type {typeof(TData)} does not have a property called {ValueFieldName}.");
}
if (!HasProperty(TextFieldName))
{
throw new Exception($"Data type {typeof(TData)} does not have a property called {TextFieldName}.");
}
}
protected override bool TryParseValueFromString(string value, out TValue result, out string validationErrorMessage)
{
validationErrorMessage = null;
if (ValueType == typeof(string))
{
result = (TValue)(object)value;
return true;
}
if (ValueType == typeof(int))
{
if (string.IsNullOrWhiteSpace(value))
{
result = default;
}
else
{
if (int.TryParse(value, NumberStyles.Integer, CultureInfo.InvariantCulture, out var parsedValue))
{
result = (TValue)(object)parsedValue;
}
else
{
result = default;
validationErrorMessage = $"Specified value cannot be converted to type {typeof(TValue)}";
return false;
}
}
return true;
}
if (ValueType == typeof(Guid))
{
validationErrorMessage = null;
if (string.IsNullOrWhiteSpace(value))
{
result = default;
}
else
{
if (Guid.TryParse(value, out var parsedValue))
{
result = (TValue)(object)parsedValue;
}
else
{
result = default;
validationErrorMessage = $"Specified value cannot be converted to type {typeof(TValue)}";
return false;
}
}
return true;
}
throw new InvalidOperationException($"{GetType()} does not support the type '{typeof(TValue)}'. Supported types are string, int and Guid.");
}
private string GetPropertyValue(TData source, string propertyName)
{
return source.GetType().GetProperty(propertyName)?.GetValue(source, null).ToString();
}
private bool HasProperty(string propertyName)
{
return typeof(TData).GetProperty(propertyName) != null;
}
private bool IsValueTypeNullable()
{
return Nullable.GetUnderlyingType(typeof(TValue)) != null;
}
}
在 parent 组件中我可以这样使用它:
<DropDownList Id="@nameof(Model.SelectedYear)"
@bind-Value="Model.SelectedYear"
Data="Model.Years"
ValueFieldName="@nameof(Year.Id)"
TextFieldName="@nameof(Year.YearName)">
</DropDownList>
这非常有效,模型绑定到下拉列表,当下拉列表值更改时,parent 模型上的值也会更改。但是,我现在想在 parent 上捕获此值更改事件并执行一些自定义逻辑,主要是根据所选年份加载一些其他数据。我的猜测是我需要自定义 EventCallback,但我尝试的所有操作都会导致某种构建或运行时错误。看来如果我的组件继承自 InputBase 那么我能做的就非常有限了。
谁能告诉我如何从 parent 组件中捕获 child 组件的值变化?
My guess is that I need a custom EventCallback
您确实需要 EventCallback
,但问题是,您已经有了,只是没看到。
为了能够使用 @bind-Value
,您需要两个参数,T Value
和 EventCallback<T> ValueChanged
。
当您传递 @bind-Foo
时,blazor 会设置这两个参数,Foo
和 FooChanged
,在 FooChanged
中,它只会将新值设置为 Foo
.
因此,当您执行 @bind-Foo="Bar"
时,blazor 在后台所做的就是传递这两个参数
Foo="@Bar"
FooChanged="@(newValue => Bar = newValue)"
所以在你的情况下,你需要做的是传递你自己的 ValueChanged
函数,它在 Value
中设置新值,但也做一些你想要的额外事情。
<DropDownList Id="@nameof(Model.SelectedYear)"
Value="Model.SelectedYear"
ValueChanged="@((TYPE_OF_VALUE newValue) => HandleValueChanged(newValue))"
Data="Model.Years"
ValueFieldName="@nameof(Year.Id)"
TextFieldName="@nameof(Year.YearName)">
</DropDownList>
@code
{
void HandleValueChanged(TYPE_OF_VALUE newValue)
{
// do what you want to do
// set the newValue if you want
Model.SelectedYear = newValue;
}
}
在TYPE_OF_VALUE
中,你只需将其替换为Model.SelectedYear
的类型即可。
你可以看看docs中的这个解释。
编辑
因为你想使用可为 null 的类型,你还需要传递 FooExpression
,在你的情况下将是 Expression<Func<T>> ValueExpression
。
<DropDownList Id="@nameof(Model.SelectedYear)"
Value="Model.SelectedYear"
ValueChanged="@((TYPE_OF_VALUE newValue) => HandleValueChanged(newValue))"
ValueExpression="@(() => Model.SelectedYear)"
Data="Model.Years"
ValueFieldName="@nameof(Year.Id)"
TextFieldName="@nameof(Year.YearName)">
</DropDownList>