GeoBlazor Pro
dymaptic.GeoBlazor.Pro
dymaptic.GeoBlazor.Pro.Components
FeatureFormViewModel Class
Provides the logic for the FeatureForm widget.
ArcGIS Maps SDK for JavaScript
public class FeatureFormViewModel : dymaptic.GeoBlazor.Core.Components.MapComponent,
dymaptic.GeoBlazor.Core.Interfaces.IViewModel
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 dymaptic.GeoBlazor.Core.Components.MapComponent 🡒 FeatureFormViewModel
Implements dymaptic.GeoBlazor.Core.Interfaces.IViewModel
Constructors
FeatureFormViewModel() Constructor
Parameterless constructor for use as a Razor Component.
public FeatureFormViewModel();
FeatureFormViewModel(Association, Graphic, FormTemplate, Layer, 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 FeatureFormViewModel(dymaptic.GeoBlazor.Pro.Model.Association? activeAssociation=null, dymaptic.GeoBlazor.Core.Components.Graphic? feature=null, dymaptic.GeoBlazor.Pro.Components.FormTemplate? formTemplate=null, dymaptic.GeoBlazor.Core.Components.Layers.Layer? layer=null, System.Nullable<bool> submittable=null, string? timeZone=null);
Parameters
activeAssociation Association
The Association that the selected feature is involved in.
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
layer dymaptic.GeoBlazor.Core.Components.Layers.Layer
Layer containing the editable feature attributes.
ArcGIS Maps SDK for JavaScript
submittable System.Nullable<System.Boolean>
Indicates if the field’s value can be submitted without introducing data validation issues.
ArcGIS Maps SDK for JavaScript
timeZone System.String
The timezone displayed within the form.
ArcGIS Maps SDK for JavaScript
Properties
FeatureFormViewModel.ActiveAssociation Property
The Association that the selected feature is involved in.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Pro.Model.Association? ActiveAssociation { get; set; }
Property Value
FeatureFormViewModel.ActiveAssociationInput Property
The UtilityNetworkAssociationInput providing
association data for the active workflow and selected association type in the Editor widget.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Pro.Model.UtilityNetworkAssociationInput? ActiveAssociationInput { get; set; }
Property Value
UtilityNetworkAssociationInput
FeatureFormViewModel.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
FeatureFormViewModel.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
FeatureFormViewModel.HasSubmitListener Property
Used in JavaScript layer to determine if the event listener is registered.
public bool HasSubmitListener { get; }
Property Value
FeatureFormViewModel.HasValueChangeListener Property
Used in JavaScript layer to determine if the event listener is registered.
public bool HasValueChangeListener { get; }
Property Value
FeatureFormViewModel.Inputs Property
The field, group, or relationship inputs that make up the form
FeatureForm widget.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Interfaces.IFeatureFormViewModelInputs>? Inputs { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Interfaces.IFeatureFormViewModelInputs>
FeatureFormViewModel.MapId Property
A reference to the associated dymaptic.GeoBlazor.Core.Components.Map
public System.Guid MapId { get; set; }
Property Value
Remarks
This property is required if working with Arcade expressions in the FeatureForm that make use of the $map global variable.
FeatureFormViewModel.OnSubmit Property
Fires when the submit() method is called.
Call FeatureLayer.applyEdits() method
to update a feature’s attributes.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Pro.Events.FeatureFormViewModelSubmitEvent> OnSubmit { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<FeatureFormViewModelSubmitEvent>
FeatureFormViewModel.OnValueChange Property
Fires when a field value is updated.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Pro.Events.FeatureFormViewModelValueChangeEvent> OnValueChange { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<FeatureFormViewModelValueChangeEvent>
FeatureFormViewModel.State Property
The widget’s state.
default “disabled”
ArcGIS Maps SDK for JavaScript
public System.Nullable<dymaptic.GeoBlazor.Pro.Enums.FeatureFormViewModelState> State { get; set; }
Property Value
System.Nullable<FeatureFormViewModelState>
FeatureFormViewModel.Submittable Property
Indicates if the field’s value can be submitted without introducing data validation issues.
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> Submittable { get; set; }
Property Value
System.Nullable<System.Boolean>
FeatureFormViewModel.TimeZone Property
The timezone displayed within the form.
ArcGIS Maps SDK for JavaScript
public string? TimeZone { get; set; }
Property Value
FeatureFormViewModel.Updating Property
Indicates whether the form is currently updating.
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> Updating { get; set; }
Property Value
System.Nullable<System.Boolean>
FeatureFormViewModel.Valid Property
Indicates whether all of the input fields are valid.
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> Valid { get; set; }
Property Value
System.Nullable<System.Boolean>
Methods
FeatureFormViewModel.FindField(string) Method
Convenience method to find field inputs.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Model.FieldInput?> FindField(string fieldName);
Parameters
fieldName System.String
The input field to find.
Returns
System.Threading.Tasks.Task<FieldInput>
FeatureFormViewModel.GetActiveAssociation() Method
Asynchronously retrieve the current value of the ActiveAssociation property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Model.Association?> GetActiveAssociation();
Returns
System.Threading.Tasks.Task<Association>
FeatureFormViewModel.GetActiveAssociationInput() Method
Asynchronously retrieve the current value of the ActiveAssociationInput property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Model.UtilityNetworkAssociationInput?> GetActiveAssociationInput();
Returns
System.Threading.Tasks.Task<UtilityNetworkAssociationInput>
FeatureFormViewModel.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>
FeatureFormViewModel.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>
FeatureFormViewModel.GetInputs() Method
Asynchronously retrieve the current value of the Inputs property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Interfaces.IFeatureFormViewModelInputs>?> GetInputs();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Interfaces.IFeatureFormViewModelInputs>>
FeatureFormViewModel.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>
FeatureFormViewModel.GetState() Method
Asynchronously retrieve the current value of the State property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Pro.Enums.FeatureFormViewModelState>> GetState();
Returns
System.Threading.Tasks.Task<System.Nullable<FeatureFormViewModelState>>
FeatureFormViewModel.GetSubmittable() Method
Asynchronously retrieve the current value of the Submittable property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetSubmittable();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
FeatureFormViewModel.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>
FeatureFormViewModel.GetUpdating() Method
Asynchronously retrieve the current value of the Updating property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetUpdating();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
FeatureFormViewModel.GetValid() Method
Asynchronously retrieve the current value of the Valid property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetValid();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
FeatureFormViewModel.GetValues() Method
Returns all of the field values, regardless of whether or not they were updated.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<string?> GetValues();
Returns
System.Threading.Tasks.Task<System.String>
FeatureFormViewModel.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
FeatureFormViewModel.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
FeatureFormViewModel.SetActiveAssociation(Association) Method
Asynchronously set the value of the ActiveAssociation property after render.
public System.Threading.Tasks.Task SetActiveAssociation(dymaptic.GeoBlazor.Pro.Model.Association? value);
Parameters
value Association
The value to set.
Returns
FeatureFormViewModel.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
FeatureFormViewModel.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
FeatureFormViewModel.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
FeatureFormViewModel.SetSubmittable(Nullable) Method
Asynchronously set the value of the Submittable property after render.
public System.Threading.Tasks.Task SetSubmittable(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
FeatureFormViewModel.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
FeatureFormViewModel.SetValue(string, string) Method
The method used to set the updated field value.
param value The value to set on the target field.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task SetValue(string fieldName, string value);
Parameters
fieldName System.String
The target field to update.
value System.String
The value to set on the target field.
Returns
FeatureFormViewModel.Submit() Method
Fires the submit event.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task Submit();
Returns
FeatureFormViewModel.ValidateContingencyConstraints(Dictionary<string,string>, FeatureFormViewModelValidateContingencyConstraintsOptions) Method
Validates whether a feature’s attribute values conform to the defined contingent values.
param options An object specifying additional options on what should be considered an error.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<string[]?> ValidateContingencyConstraints(System.Collections.Generic.Dictionary<string,string?> values, dymaptic.GeoBlazor.Core.Options.FeatureFormViewModelValidateContingencyConstraintsOptions options);
Parameters
values System.Collections.Generic.Dictionary<System.String,System.String>
A hash map of the form fields and their values.
options dymaptic.GeoBlazor.Core.Options.FeatureFormViewModelValidateContingencyConstraintsOptions
- options.includeIncompleteViolations: If
true, return contingency violations for field groups that are invalid because values have not yet been specified for all their fields. Iffalse, any of these violations are ignored.
Returns
System.Threading.Tasks.Task<System.String[]>
FeatureFormViewModel.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()