GeoBlazor Pro

dymaptic.GeoBlazor.Pro

dymaptic.GeoBlazor.Pro.Components

FieldElement Class

A FieldElement form element defines how a feature layer’s field
participates in the FeatureForm.
ArcGIS Maps SDK for JavaScript

public class FieldElement : dymaptic.GeoBlazor.Pro.Components.FormElement,
dymaptic.GeoBlazor.Core.Interfaces.IElement,
dymaptic.GeoBlazor.Core.Interfaces.IElementsElement,
dymaptic.GeoBlazor.Core.Interfaces.IMapComponent

Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 dymaptic.GeoBlazor.Core.Components.MapComponent 🡒 FormElement 🡒 FieldElement

Implements dymaptic.GeoBlazor.Core.Interfaces.IElement, dymaptic.GeoBlazor.Core.Interfaces.IElementsElement, dymaptic.GeoBlazor.Core.Interfaces.IMapComponent

Constructors

FieldElement() Constructor

Parameterless constructor for use as a Razor Component.

public FieldElement();

FieldElement(string, string, string, string, string, string, string, Domain, FormElement, string) Constructor

Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.

public FieldElement(string? fieldName=null, string? label=null, string? description=null, string? hint=null, string? editableExpression=null, string? requiredExpression=null, string? valueExpression=null, dymaptic.GeoBlazor.Core.Components.Domain? domain=null, dymaptic.GeoBlazor.Pro.Components.FormElement? input=null, string? visibilityExpression=null);

Parameters

fieldName System.String

The field name as defined by the feature layer.
ArcGIS Maps SDK for JavaScript

label System.String

A string value containing the field alias.
ArcGIS Maps SDK for JavaScript

description System.String

The element’s description providing the purpose behind it.
ArcGIS Maps SDK for JavaScript

hint System.String

Contains a hint used to help editors while editing fields.
ArcGIS Maps SDK for JavaScript

editableExpression System.String

A reference to the name of an
Arcade expression defined in the
expressionInfos of the FormTemplate.
ArcGIS Maps SDK for JavaScript

requiredExpression System.String

A reference to the name of an
Arcade expression defined in the
expressionInfos of the FormTemplate.
ArcGIS Maps SDK for JavaScript

valueExpression System.String

A reference to the name of an
Arcade expression defined in the
expressionInfos of the FormTemplate.
ArcGIS Maps SDK for JavaScript

domain dymaptic.GeoBlazor.Core.Components.Domain

The coded value domain or
range domain of the field.
ArcGIS Maps SDK for JavaScript

input FormElement

The input to use for the element.
ArcGIS Maps SDK for JavaScript

visibilityExpression System.String

A reference to the name of an
Arcade expression defined in the
expressionInfos of the FormTemplate.
ArcGIS Maps SDK for JavaScript

Properties

FieldElement.Domain Property

The coded value domain or
range domain of the field.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Components.Domain? Domain { get; set; }

Property Value

dymaptic.GeoBlazor.Core.Components.Domain

FieldElement.EditableExpression Property

A reference to the name of an Arcade expression defined in the expressionInfos of the FormTemplate. The expression must follow the specification defined in the Form Constraint Profile. Expressions may reference field values using the $feature global input and must return either true or false.

public string? EditableExpression { get; set; }

Property Value

System.String

Remarks

A reference to the name of an Arcade expression defined in the expressionInfos of the FormTemplate. The expression must follow the specification defined in the Form Constraint Profile. Expressions may reference field values using the $feature global input and must return either true or false.
The referenced expression must be defined in the form template’s expressionInfos. It cannot be set inline within the element object.

FieldElement.FieldName Property

The field name as defined by the feature layer. Set this property to indicate which field to edit.

public string? FieldName { get; set; }

Property Value

System.String

FieldElement.Hint Property

Contains a hint used to help editors while editing fields. Set this as a temporary placeholder for text/number inputs in either TextAreaInput or TextBoxInput.

public string? Hint { get; set; }

Property Value

System.String

FieldElement.Input Property

The input to use for the element.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Pro.Components.FormElement? Input { get; set; }

Property Value

FormElement

FieldElement.RequiredExpression Property

A reference to the name of an Arcade expression defined in the expressionInfos of the FormTemplate. The expression must follow the specification defined in the Form Constraint Profile. Expressions may reference field values using the $feature global input and must return either true or false.
When this expression evaluates to true and the field value is required, the element must have a valid value in order for the feature to be created or edited. When the expression evaluates to false, the element is not required. If no expression is provided, the required behavior is defined via the required property.
If the referenced field is non-nullable, the requiredExpression is ignored and the element is always required.

public string? RequiredExpression { get; set; }

Property Value

System.String

Remarks

The referenced expression must be defined in the form template’s expressionInfos. It cannot be set inline within the element object.

FieldElement.Type Property

Indicates the type of form element.

public override string Type { get; }

Property Value

System.String

FieldElement.ValueExpression Property

A reference to the name of an
Arcade expression defined in the
expressionInfos of the FormTemplate.
ArcGIS Maps SDK for JavaScript

public string? ValueExpression { get; set; }

Property Value

System.String

Methods

FieldElement.GetDomain() Method

Asynchronously retrieve the current value of the Domain property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Domain?> GetDomain();

Returns

System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Domain>

FieldElement.GetEditableExpression() Method

Asynchronously retrieve the current value of the EditableExpression property.

public System.Threading.Tasks.Task<string?> GetEditableExpression();

Returns

System.Threading.Tasks.Task<System.String>

FieldElement.GetFieldName() Method

Asynchronously retrieve the current value of the FieldName property.

public System.Threading.Tasks.Task<string?> GetFieldName();

Returns

System.Threading.Tasks.Task<System.String>

FieldElement.GetHint() Method

Asynchronously retrieve the current value of the Hint property.

public System.Threading.Tasks.Task<string?> GetHint();

Returns

System.Threading.Tasks.Task<System.String>

FieldElement.GetInput() Method

Asynchronously retrieve the current value of the Input property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Components.FormElement?> GetInput();

Returns

System.Threading.Tasks.Task<FormElement>

FieldElement.GetRequiredExpression() Method

Asynchronously retrieve the current value of the RequiredExpression property.

public System.Threading.Tasks.Task<string?> GetRequiredExpression();

Returns

System.Threading.Tasks.Task<System.String>

FieldElement.GetValueExpression() Method

Asynchronously retrieve the current value of the ValueExpression property.

public System.Threading.Tasks.Task<string?> GetValueExpression();

Returns

System.Threading.Tasks.Task<System.String>

FieldElement.SetDomain(Domain) Method

Asynchronously set the value of the Domain property after render.

public System.Threading.Tasks.Task SetDomain(dymaptic.GeoBlazor.Core.Components.Domain? value);

Parameters

value dymaptic.GeoBlazor.Core.Components.Domain

The value to set.

Returns

System.Threading.Tasks.Task

FieldElement.SetEditableExpression(string) Method

Asynchronously set the value of the EditableExpression property after render.

public System.Threading.Tasks.Task SetEditableExpression(string? value);

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

FieldElement.SetFieldName(string) Method

Asynchronously set the value of the FieldName property after render.

public System.Threading.Tasks.Task SetFieldName(string? value);

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

FieldElement.SetHint(string) Method

Asynchronously set the value of the Hint property after render.

public System.Threading.Tasks.Task SetHint(string? value);

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

FieldElement.SetInput(FormElement) Method

Asynchronously set the value of the Input property after render.

public System.Threading.Tasks.Task SetInput(dymaptic.GeoBlazor.Pro.Components.FormElement? value);

Parameters

value FormElement

The value to set.

Returns

System.Threading.Tasks.Task

FieldElement.SetRequiredExpression(string) Method

Asynchronously set the value of the RequiredExpression property after render.

public System.Threading.Tasks.Task SetRequiredExpression(string? value);

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

FieldElement.SetValueExpression(string) Method

Asynchronously set the value of the ValueExpression property after render.

public System.Threading.Tasks.Task SetValueExpression(string? value);

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

FieldElement.ValidateRequiredGeneratedChildren() Method

Validates source-generated child components.

public override void ValidateRequiredGeneratedChildren();

Implements ValidateRequiredGeneratedChildren()