dymaptic.GeoBlazor.Pro
dymaptic.GeoBlazor.Pro.Components
RelationshipElement Class
GeoBlazor Docs A `RelationshipElement` form element defines how a relationship between FeatureLayer or MapImageLayer and tables participates in the FeatureForm. ArcGIS Maps SDK for JavaScript
public class RelationshipElement : dymaptic.GeoBlazor.Pro.Components.FormElement, dymaptic.GeoBlazor.Core.Interfaces.IElementsElement, dymaptic.GeoBlazor.Core.Interfaces.IMapComponent
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 FormElement 🡒 RelationshipElement
Implements IElementsElement, IMapComponent
Constructors
RelationshipElement() Constructor
Parameterless constructor for use as a Razor Component.
public RelationshipElement();
RelationshipElement(Nullable, string, string, IReadOnlyList, Nullable, Nullable) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public RelationshipElement(System.Nullable<int> displayCount=null, string? displayType=null, string? editableExpression=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.RelatedRecordsInfoFieldOrder>? orderByFields=null, System.Nullable<long> relationshipId=null, System.Nullable<System.Guid> layerId=null);
Parameters
displayCount System.Nullable<System.Int32>
A numeric value indicating the maximum number of related features to display in the list of related records. default 3 ArcGIS Maps SDK for JavaScript
displayType System.String
A string value indicating how to display related records within the relationship content. default "list" 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
orderByFields System.Collections.Generic.IReadOnlyList<RelatedRecordsInfoFieldOrder>
An array of RelatedRecordsInfoFieldOrder objects indicating the field display order for the related records and whether they should be sorted in ascending `asc` or descending `desc` order. ArcGIS Maps SDK for JavaScript
relationshipId System.Nullable<System.Int64>
The numeric id value for the defined relationship. ArcGIS Maps SDK for JavaScript
layerId System.Nullable<System.Guid>
The GeoBlazor Id of the relevant Layer for the MapComponent. Not always applicable to every component type.
Properties
RelationshipElement.DisplayCount Property
GeoBlazor Docs A numeric value indicating the maximum number of related features to display in the list of related records. default 3 ArcGIS Maps SDK for JavaScript
public System.Nullable<int> DisplayCount { get; set; }
Property Value
RelationshipElement.DisplayType Property
GeoBlazor Docs A string value indicating how to display related records within the relationship content. default "list" ArcGIS Maps SDK for JavaScript
public string? DisplayType { get; set; }
Property Value
RelationshipElement.EditableExpression Property
GeoBlazor Docs A reference to the name of an Arcade expression defined in the expressionInfos of the FormTemplate. ArcGIS Maps SDK for JavaScript
public string? EditableExpression { get; set; }
Property Value
RelationshipElement.OrderByFields Property
GeoBlazor Docs An array of RelatedRecordsInfoFieldOrder objects indicating the field display order for the related records and whether they should be sorted in ascending `asc` or descending `desc` order. ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.RelatedRecordsInfoFieldOrder>? OrderByFields { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<RelatedRecordsInfoFieldOrder>
RelationshipElement.RelationshipId Property
GeoBlazor Docs The numeric id value for the defined relationship. ArcGIS Maps SDK for JavaScript
public System.Nullable<long> RelationshipId { get; set; }
Property Value
RelationshipElement.Type Property
Indicates the type of form element.
public override string Type { get; }
Property Value
Methods
RelationshipElement.AddToOrderByFields(RelatedRecordsInfoFieldOrder[]) Method
Asynchronously adds elements to the OrderByFields property.
public System.Threading.Tasks.Task AddToOrderByFields(params dymaptic.GeoBlazor.Core.Components.RelatedRecordsInfoFieldOrder[] values);
Parameters
values RelatedRecordsInfoFieldOrder[]
The elements to add.
Returns
RelationshipElement.GetDisplayCount() Method
Asynchronously retrieve the current value of the DisplayCount property.
public System.Threading.Tasks.Task<System.Nullable<int>> GetDisplayCount();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Int32>>
RelationshipElement.GetDisplayType() Method
Asynchronously retrieve the current value of the DisplayType property.
public System.Threading.Tasks.Task<string?> GetDisplayType();
Returns
System.Threading.Tasks.Task<System.String>
RelationshipElement.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>
RelationshipElement.GetOrderByFields() Method
Asynchronously retrieve the current value of the OrderByFields property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.RelatedRecordsInfoFieldOrder>?> GetOrderByFields();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<RelatedRecordsInfoFieldOrder>>
RelationshipElement.GetRelationshipId() Method
Asynchronously retrieve the current value of the RelationshipId property.
public System.Threading.Tasks.Task<System.Nullable<long>> GetRelationshipId();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Int64>>
RelationshipElement.RemoveFromOrderByFields(RelatedRecordsInfoFieldOrder[]) Method
Asynchronously remove an element from the OrderByFields property.
public System.Threading.Tasks.Task RemoveFromOrderByFields(params dymaptic.GeoBlazor.Core.Components.RelatedRecordsInfoFieldOrder[] values);
Parameters
values RelatedRecordsInfoFieldOrder[]
The elements to remove.
Returns
RelationshipElement.SetDisplayCount(Nullable) Method
Asynchronously set the value of the DisplayCount property after render.
public System.Threading.Tasks.Task SetDisplayCount(System.Nullable<int> value);
Parameters
value System.Nullable<System.Int32>
The value to set.
Returns
RelationshipElement.SetDisplayType(string) Method
Asynchronously set the value of the DisplayType property after render.
public System.Threading.Tasks.Task SetDisplayType(string? value);
Parameters
value System.String
The value to set.
Returns
RelationshipElement.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
RelationshipElement.SetOrderByFields(IReadOnlyList) Method
Asynchronously set the value of the OrderByFields property after render.
public System.Threading.Tasks.Task SetOrderByFields(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.RelatedRecordsInfoFieldOrder>? value);
Parameters
value System.Collections.Generic.IReadOnlyList<RelatedRecordsInfoFieldOrder>
The value to set.
Returns
RelationshipElement.SetRelationshipId(Nullable) Method
Asynchronously set the value of the RelationshipId property after render.
public System.Threading.Tasks.Task SetRelationshipId(System.Nullable<long> value);
Parameters
value System.Nullable<System.Int64>
The value to set.
Returns
RelationshipElement.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()