GeoBlazor Pro
dymaptic.GeoBlazor.Pro
dymaptic.GeoBlazor.Pro.Components.Widgets
FeatureFormWidget Class
The FeatureForm widget displays attributes of a feature.
ArcGIS Maps SDK for JavaScript
public class FeatureFormWidget : dymaptic.GeoBlazor.Pro.Components.Widgets.ProWidget
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 dymaptic.GeoBlazor.Core.Components.MapComponent 🡒 dymaptic.GeoBlazor.Core.Components.Widgets.Widget 🡒 ProWidget 🡒 FeatureFormWidget
Constructors
FeatureFormWidget() Constructor
Parameterless constructor for use as a Razor Component.
public FeatureFormWidget();
FeatureFormWidget(string, Nullable, Graphic, FormTemplate, Nullable, Nullable, string, string, Layer, MapView, Nullable, string, FeatureFormViewModel, Nullable, string) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public FeatureFormWidget(string? containerId=null, System.Nullable<bool> disabled=null, dymaptic.GeoBlazor.Core.Components.Graphic? feature=null, dymaptic.GeoBlazor.Pro.Components.FormTemplate? formTemplate=null, System.Nullable<dymaptic.GeoBlazor.Pro.Enums.GroupDisplay> groupDisplay=null, System.Nullable<int> headingLevel=null, string? icon=null, string? label=null, dymaptic.GeoBlazor.Core.Components.Layers.Layer? layer=null, dymaptic.GeoBlazor.Core.Components.Views.MapView? mapView=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.OverlayPosition> position=null, string? timeZone=null, dymaptic.GeoBlazor.Pro.Components.FeatureFormViewModel? viewModel=null, System.Nullable<bool> visible=null, string? widgetId=null);
Parameters
containerId System.String
The id of an external HTML Element (div). If provided, the widget will be placed inside that element, instead of on the map.
disabled System.Nullable<System.Boolean>
When true, sets the widget to a disabled state so the user cannot interact with it.
default false
ArcGIS Maps SDK for JavaScript
feature dymaptic.GeoBlazor.Core.Components.Graphic
The associated feature containing the editable attributes.
ArcGIS Maps SDK for JavaScript
formTemplate FormTemplate
The associated template used for the form.
ArcGIS Maps SDK for JavaScript
groupDisplay System.Nullable<GroupDisplay>
Defines how groups will be displayed to the user.
default “all”
ArcGIS Maps SDK for JavaScript
headingLevel System.Nullable<System.Int32>
Indicates the heading level to use for the title of the form.
default 2
ArcGIS Maps SDK for JavaScript
icon System.String
Icon displayed in the widget’s button.
default “form-field”
ArcGIS Maps SDK for JavaScript
label System.String
The widget’s default label.
ArcGIS Maps SDK for JavaScript
layer dymaptic.GeoBlazor.Core.Components.Layers.Layer
Layer containing the editable feature attributes.
ArcGIS Maps SDK for JavaScript
mapView dymaptic.GeoBlazor.Core.Components.Views.MapView
If the Widget is defined outside of the MapView, this link is required to connect them together.
position System.Nullable<dymaptic.GeoBlazor.Core.Enums.OverlayPosition>
The position of the widget in relation to the map view.
timeZone System.String
The timezone displayed within the form.
ArcGIS Maps SDK for JavaScript
viewModel FeatureFormViewModel
The view model for this widget.
ArcGIS Maps SDK for JavaScript
visible System.Nullable<System.Boolean>
Indicates whether the widget is visible.
default true
ArcGIS Maps SDK for JavaScript
widgetId System.String
The unique ID assigned to the widget when the widget is created.
ArcGIS Maps SDK for JavaScript
Properties
FeatureFormWidget.Disabled Property
When true, sets the widget to a disabled state so the user cannot interact with it.
default false
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> Disabled { get; set; }
Property Value
System.Nullable<System.Boolean>
FeatureFormWidget.EventRateLimitInMilliseconds Property
Controls how often the events are fired.
public int EventRateLimitInMilliseconds { get; set; }
Property Value
FeatureFormWidget.Feature Property
The associated feature containing the editable attributes.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.Graphic? Feature { get; set; }
Property Value
dymaptic.GeoBlazor.Core.Components.Graphic
FeatureFormWidget.FormTemplate Property
The associated template used for the form.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Pro.Components.FormTemplate? FormTemplate { get; set; }
Property Value
FeatureFormWidget.GroupDisplay Property
Defines how groups will be displayed to the user.
default “all”
ArcGIS Maps SDK for JavaScript
public System.Nullable<dymaptic.GeoBlazor.Pro.Enums.GroupDisplay> GroupDisplay { get; set; }
Property Value
FeatureFormWidget.HasSubmitListener Property
Used in JavaScript layer to determine if the event listener is registered.
public bool HasSubmitListener { get; }
Property Value
FeatureFormWidget.HasValueChangeListener Property
Used in JavaScript layer to determine if the event listener is registered.
public bool HasValueChangeListener { get; }
Property Value
FeatureFormWidget.HeadingLevel Property
Indicates the heading level to use for the title of the form.
default 2
ArcGIS Maps SDK for JavaScript
public System.Nullable<int> HeadingLevel { get; set; }
Property Value
FeatureFormWidget.OnSubmit Property
Event Listener for Submit.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Pro.Events.FeatureFormSubmitEvent> OnSubmit { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<FeatureFormSubmitEvent>
FeatureFormWidget.OnValueChange Property
Event Listener for ValueChange.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Pro.Events.FeatureFormValueChangeEvent> OnValueChange { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<FeatureFormValueChangeEvent>
FeatureFormWidget.TimeZone Property
The timezone displayed within the form.
ArcGIS Maps SDK for JavaScript
public string? TimeZone { get; set; }
Property Value
FeatureFormWidget.Type Property
The type of widget
public override dymaptic.GeoBlazor.Core.Enums.WidgetType Type { get; }
Property Value
dymaptic.GeoBlazor.Core.Enums.WidgetType
FeatureFormWidget.ViewModel Property
The view model for this widget.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Pro.Components.FeatureFormViewModel? ViewModel { get; set; }
Property Value
Methods
FeatureFormWidget.GetDisabled() Method
Asynchronously retrieve the current value of the Disabled property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetDisabled();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
FeatureFormWidget.GetFeature() Method
Asynchronously retrieve the current value of the Feature property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Graphic?> GetFeature();
Returns
System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Graphic>
FeatureFormWidget.GetFormTemplate() Method
Asynchronously retrieve the current value of the FormTemplate property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Components.FormTemplate?> GetFormTemplate();
Returns
System.Threading.Tasks.Task<FormTemplate>
FeatureFormWidget.GetGroupDisplay() Method
Asynchronously retrieve the current value of the GroupDisplay property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Pro.Enums.GroupDisplay>> GetGroupDisplay();
Returns
System.Threading.Tasks.Task<System.Nullable<GroupDisplay>>
FeatureFormWidget.GetHeadingLevel() Method
Asynchronously retrieve the current value of the HeadingLevel property.
public System.Threading.Tasks.Task<System.Nullable<int>> GetHeadingLevel();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Int32>>
FeatureFormWidget.GetLayer() Method
Asynchronously retrieve the current value of the Layer property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Layers.Layer?> GetLayer();
Returns
System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Layers.Layer>
FeatureFormWidget.GetTimeZone() Method
Asynchronously retrieve the current value of the TimeZone property.
public System.Threading.Tasks.Task<string?> GetTimeZone();
Returns
System.Threading.Tasks.Task<System.String>
FeatureFormWidget.GetValues() Method
Returns all of the field values, regardless of update status.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.AttributesDictionary?> GetValues();
Returns
System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.AttributesDictionary>
FeatureFormWidget.GetViewModel() Method
Asynchronously retrieve the current value of the ViewModel property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Components.FeatureFormViewModel?> GetViewModel();
Returns
System.Threading.Tasks.Task<FeatureFormViewModel>
FeatureFormWidget.OnJsSubmit(IJSStreamReference) Method
JavaScript-Invokable Method for internal use only.
public System.Threading.Tasks.Task OnJsSubmit(Microsoft.JSInterop.IJSStreamReference jsStreamRef);
Parameters
jsStreamRef Microsoft.JSInterop.IJSStreamReference
Returns
FeatureFormWidget.OnJsValueChange(IJSStreamReference) Method
JavaScript-Invokable Method for internal use only.
public System.Threading.Tasks.Task OnJsValueChange(Microsoft.JSInterop.IJSStreamReference jsStreamRef);
Parameters
jsStreamRef Microsoft.JSInterop.IJSStreamReference
Returns
FeatureFormWidget.SetDisabled(Nullable) Method
Asynchronously set the value of the Disabled property after render.
public System.Threading.Tasks.Task SetDisabled(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
FeatureFormWidget.SetFeature(Graphic) Method
Asynchronously set the value of the Feature property after render.
public System.Threading.Tasks.Task SetFeature(dymaptic.GeoBlazor.Core.Components.Graphic? value);
Parameters
value dymaptic.GeoBlazor.Core.Components.Graphic
The value to set.
Returns
FeatureFormWidget.SetFormTemplate(FormTemplate) Method
Asynchronously set the value of the FormTemplate property after render.
public System.Threading.Tasks.Task SetFormTemplate(dymaptic.GeoBlazor.Pro.Components.FormTemplate? value);
Parameters
value FormTemplate
The value to set.
Returns
FeatureFormWidget.SetGroupDisplay(Nullable) Method
Asynchronously set the value of the GroupDisplay property after render.
public System.Threading.Tasks.Task SetGroupDisplay(System.Nullable<dymaptic.GeoBlazor.Pro.Enums.GroupDisplay> value);
Parameters
value System.Nullable<GroupDisplay>
The value to set.
Returns
FeatureFormWidget.SetHeadingLevel(Nullable) Method
Asynchronously set the value of the HeadingLevel property after render.
public System.Threading.Tasks.Task SetHeadingLevel(System.Nullable<int> value);
Parameters
value System.Nullable<System.Int32>
The value to set.
Returns
FeatureFormWidget.SetLayer(Layer) Method
Asynchronously set the value of the Layer property after render.
public System.Threading.Tasks.Task SetLayer(dymaptic.GeoBlazor.Core.Components.Layers.Layer? value);
Parameters
value dymaptic.GeoBlazor.Core.Components.Layers.Layer
The value to set.
Returns
FeatureFormWidget.SetTimeZone(string) Method
Asynchronously set the value of the TimeZone property after render.
public System.Threading.Tasks.Task SetTimeZone(string? value);
Parameters
value System.String
The value to set.
Returns
FeatureFormWidget.SetViewModel(FeatureFormViewModel) Method
Asynchronously set the value of the ViewModel property after render.
public System.Threading.Tasks.Task SetViewModel(dymaptic.GeoBlazor.Pro.Components.FeatureFormViewModel? value);
Parameters
value FeatureFormViewModel
The value to set.
Returns
FeatureFormWidget.Submit() Method
Fires the submit event.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task Submit();
Returns
FeatureFormWidget.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()