GeoBlazor Pro
dymaptic.GeoBlazor.Pro
dymaptic.GeoBlazor.Pro.Components
FormTemplate Class
A FormTemplate formats and defines the content of a FeatureForm for
a specific Featurelayer or SubtypeSubLayer.
ArcGIS Maps SDK for JavaScript
public class FormTemplate : dymaptic.GeoBlazor.Core.Components.MapComponent,
dymaptic.GeoBlazor.Core.Interfaces.IFormTemplate,
dymaptic.GeoBlazor.Core.Interfaces.IMapComponent
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 dymaptic.GeoBlazor.Core.Components.MapComponent 🡒 FormTemplate
Implements dymaptic.GeoBlazor.Core.Interfaces.IFormTemplate, dymaptic.GeoBlazor.Core.Interfaces.IMapComponent
Constructors
FormTemplate() Constructor
Parameterless constructor for use as a Razor Component.
public FormTemplate();
FormTemplate(string, string, Nullable, IReadOnlyList, IReadOnlyList) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public FormTemplate(string? title=null, string? description=null, System.Nullable<bool> preserveFieldValuesWhenHidden=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Components.FormElement>? elements=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Components.FormTemplateExpressionInfo>? expressionInfos=null);
Parameters
title System.String
The string defining how to format the title displayed at the top of a form.
ArcGIS Maps SDK for JavaScript
description System.String
The description of the form.
ArcGIS Maps SDK for JavaScript
preserveFieldValuesWhenHidden System.Nullable<System.Boolean>
Indicates whether to retain or clear a form’sfield element values.
default false
ArcGIS Maps SDK for JavaScript
elements System.Collections.Generic.IReadOnlyList<FormElement>
An array of form element
objects that represent an ordered list of form elements.
ArcGIS Maps SDK for JavaScript
expressionInfos System.Collections.Generic.IReadOnlyList<FormTemplateExpressionInfo>
An array of ExpressionInfo objects
that reference Arcade expressions following the specification
defined by the Form Constraint Profile or the
Form Calculation Profile.
ArcGIS Maps SDK for JavaScript
Properties
FormTemplate.Description Property
The description of the form.
public string? Description { get; set; }
Property Value
FormTemplate.Elements Property
An array of form element
objects that represent an ordered list of form elements.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Components.FormElement>? Elements { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<FormElement>
FormTemplate.ExpressionInfos Property
An array of ExpressionInfo objects
that reference Arcade expressions following the specification
defined by the Form Constraint Profile or the
Form Calculation Profile.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Components.FormTemplateExpressionInfo>? ExpressionInfos { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<FormTemplateExpressionInfo>
FormTemplate.PreserveFieldValuesWhenHidden Property
Indicates whether to retain or clear a form’s field element values. Use this property when a field element initially displays as visible but then updates to not display as a result of an applied visibilityExpression.
public System.Nullable<bool> PreserveFieldValuesWhenHidden { get; set; }
Property Value
System.Nullable<System.Boolean>
FormTemplate.Title Property
The string template for defining how to format the title displayed at the top of a form.
public string? Title { get; set; }
Property Value
Methods
FormTemplate.AddToElements(FormElement[]) Method
Asynchronously adds elements to the Elements property.
public System.Threading.Tasks.Task AddToElements(params dymaptic.GeoBlazor.Pro.Components.FormElement[] values);
Parameters
values FormElement[]
The elements to add.
Returns
FormTemplate.AddToExpressionInfos(FormTemplateExpressionInfo[]) Method
Asynchronously adds elements to the ExpressionInfos property.
public System.Threading.Tasks.Task AddToExpressionInfos(params dymaptic.GeoBlazor.Pro.Components.FormTemplateExpressionInfo[] values);
Parameters
values FormTemplateExpressionInfo[]
The elements to add.
Returns
FormTemplate.GetDescription() Method
Asynchronously retrieve the current value of the Description property.
public System.Threading.Tasks.Task<string?> GetDescription();
Returns
System.Threading.Tasks.Task<System.String>
FormTemplate.GetElements() Method
Asynchronously retrieve the current value of the Elements property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Components.FormElement>?> GetElements();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<FormElement>>
FormTemplate.GetExpressionInfos() Method
Asynchronously retrieve the current value of the ExpressionInfos property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Components.FormTemplateExpressionInfo>?> GetExpressionInfos();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<FormTemplateExpressionInfo>>
FormTemplate.GetPreserveFieldValuesWhenHidden() Method
Asynchronously retrieve the current value of the PreserveFieldValuesWhenHidden property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetPreserveFieldValuesWhenHidden();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
FormTemplate.GetTitle() Method
Asynchronously retrieve the current value of the Title property.
public System.Threading.Tasks.Task<string?> GetTitle();
Returns
System.Threading.Tasks.Task<System.String>
FormTemplate.RemoveFromElements(FormElement[]) Method
Asynchronously remove an element from the Elements property.
public System.Threading.Tasks.Task RemoveFromElements(params dymaptic.GeoBlazor.Pro.Components.FormElement[] values);
Parameters
values FormElement[]
The elements to remove.
Returns
FormTemplate.RemoveFromExpressionInfos(FormTemplateExpressionInfo[]) Method
Asynchronously remove an element from the ExpressionInfos property.
public System.Threading.Tasks.Task RemoveFromExpressionInfos(params dymaptic.GeoBlazor.Pro.Components.FormTemplateExpressionInfo[] values);
Parameters
values FormTemplateExpressionInfo[]
The elements to remove.
Returns
FormTemplate.SetDescription(string) Method
Asynchronously set the value of the Description property after render.
public System.Threading.Tasks.Task SetDescription(string? value);
Parameters
value System.String
The value to set.
Returns
FormTemplate.SetElements(IReadOnlyList) Method
Asynchronously set the value of the Elements property after render.
public System.Threading.Tasks.Task SetElements(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Components.FormElement>? value);
Parameters
value System.Collections.Generic.IReadOnlyList<FormElement>
The value to set.
Returns
FormTemplate.SetExpressionInfos(IReadOnlyList) Method
Asynchronously set the value of the ExpressionInfos property after render.
public System.Threading.Tasks.Task SetExpressionInfos(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Components.FormTemplateExpressionInfo>? value);
Parameters
value System.Collections.Generic.IReadOnlyList<FormTemplateExpressionInfo>
The value to set.
Returns
FormTemplate.SetPreserveFieldValuesWhenHidden(Nullable) Method
Asynchronously set the value of the PreserveFieldValuesWhenHidden property after render.
public System.Threading.Tasks.Task SetPreserveFieldValuesWhenHidden(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
FormTemplate.SetTitle(string) Method
Asynchronously set the value of the Title property after render.
public System.Threading.Tasks.Task SetTitle(string? value);
Parameters
value System.String
The value to set.
Returns
FormTemplate.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()