GeoBlazor Pro
dymaptic.GeoBlazor.Pro
dymaptic.GeoBlazor.Pro.Components
GroupElement Class
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Pro.Components.GroupElement.html”>GeoBlazor Docs</a> A `GroupElement` form element defines a container that holds a set of <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html#elements”>form elements</a> that can be expanded, collapsed, or displayed together. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-GroupElement.html”>ArcGIS Maps SDK for JavaScript</a>
public class GroupElement : 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 🡒 GroupElement
Implements dymaptic.GeoBlazor.Core.Interfaces.IElement, dymaptic.GeoBlazor.Core.Interfaces.IElementsElement, dymaptic.GeoBlazor.Core.Interfaces.IMapComponent
Constructors
GroupElement() Constructor
Parameterless constructor for use as a Razor Component.
public GroupElement();
GroupElement(string, IReadOnlyList<FormElement>, Nullable<InitialState>, string, string) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public GroupElement(string? description=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Components.FormElement>? elements=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.InitialState> initialState=null, string? label=null, string? visibilityExpression=null);
Parameters
description System.String
The element’s description providing the purpose behind it. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-Element.html#description”>ArcGIS Maps SDK for JavaScript</a>
elements System.Collections.Generic.IReadOnlyList<FormElement>
An array of <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html”>field</a>, <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-RelationshipElement.html”>relationship</a>, and <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-TextElement.html”>text</a> elements to display as grouped. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-GroupElement.html#elements”>ArcGIS Maps SDK for JavaScript</a>
initialState System.Nullable<dymaptic.GeoBlazor.Core.Enums.InitialState>
Defines if the group should be expanded or collapsed when the form is initially displayed. default “expanded” <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-GroupElement.html#initialState”>ArcGIS Maps SDK for JavaScript</a>
label System.String
A string value containing the field alias. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-Element.html#label”>ArcGIS Maps SDK for JavaScript</a>
visibilityExpression System.String
A reference to the <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-form-ExpressionInfo.html#name”>name</a> of an <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/arcade/”>Arcade</a> expression defined in the <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html#expressionInfos”>expressionInfos</a> of the <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-form-FormTemplate.html”>FormTemplate</a>. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-Element.html#visibilityExpression”>ArcGIS Maps SDK for JavaScript</a>
Properties
GroupElement.Elements Property
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Pro.Components.GroupElement.html#groupelementelements-property”>GeoBlazor Docs</a> An array of <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-FieldElement.html”>field</a>, <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-RelationshipElement.html”>relationship</a>, and <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-TextElement.html”>text</a> elements to display as grouped. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-GroupElement.html#elements”>ArcGIS Maps SDK for JavaScript</a>
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Pro.Components.FormElement>? Elements { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<FormElement>
GroupElement.InitialState Property
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Pro.Components.GroupElement.html#groupelementinitialstate-property”>GeoBlazor Docs</a> Defines if the group should be expanded or collapsed when the form is initially displayed. default “expanded” <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-form-elements-GroupElement.html#initialState”>ArcGIS Maps SDK for JavaScript</a>
public System.Nullable<dymaptic.GeoBlazor.Core.Enums.InitialState> InitialState { get; set; }
Property Value
System.Nullable<dymaptic.GeoBlazor.Core.Enums.InitialState>
GroupElement.Type Property
Indicates the type of form element.
public override string Type { get; }
Property Value
Methods
GroupElement.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
GroupElement.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>>
GroupElement.GetInitialState() Method
Asynchronously retrieve the current value of the InitialState property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.InitialState>> GetInitialState();
Returns
System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.InitialState>>
GroupElement.RegisterChildComponent(MapComponent) Method
Called from dymaptic.GeoBlazor.Core.Components.MapComponent.OnInitializedAsync to “Register” the current component with its parent.
public override System.Threading.Tasks.Task RegisterChildComponent(dymaptic.GeoBlazor.Core.Components.MapComponent child);
Parameters
child dymaptic.GeoBlazor.Core.Components.MapComponent
The calling, child component to register
Returns
Exceptions
dymaptic.GeoBlazor.Core.Exceptions.InvalidChildElementException
Throws if the current child is not a valid sub-component to the parent.
Remarks
This method is an implementation detail and should not be called directly by consumers. In future versions, this may be changed to an internal method. If you see no other way to register a child component, please open an issue on GitHub.
GroupElement.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
GroupElement.SetElements(IReadOnlyList<FormElement>) 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
GroupElement.SetInitialState(Nullable<InitialState>) Method
Asynchronously set the value of the InitialState property after render.
public System.Threading.Tasks.Task SetInitialState(System.Nullable<dymaptic.GeoBlazor.Core.Enums.InitialState> value);
Parameters
value System.Nullable<dymaptic.GeoBlazor.Core.Enums.InitialState>
The value to set.
Returns
GroupElement.UnregisterChildComponent(MapComponent) Method
Undoes the “Registration” of a child with its parent.
public override System.Threading.Tasks.Task UnregisterChildComponent(dymaptic.GeoBlazor.Core.Components.MapComponent child);
Parameters
child dymaptic.GeoBlazor.Core.Components.MapComponent
The child to unregister
Returns
Remarks
This method is an implementation detail and should not be called directly by consumers. In future versions, this may be changed to an internal method.
GroupElement.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()