GeoBlazor Pro
dymaptic.GeoBlazor.Pro
dymaptic.GeoBlazor.Pro.Components.Widgets
SupportingWidgetAttachments Class
Indicates whether to allow updating an existing attachment. Default value is true.
public class SupportingWidgetAttachments : dymaptic.GeoBlazor.Core.Components.MapComponent
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 dymaptic.GeoBlazor.Core.Components.MapComponent 🡒 SupportingWidgetAttachments
Constructors
SupportingWidgetAttachments() Constructor
Parameterless constructor for use as a razor component
public SupportingWidgetAttachments();
SupportingWidgetAttachments(string, AttachmentsCapabilities) Constructor
Indicates whether to allow updating an existing attachment. Default value is true.
public SupportingWidgetAttachments(string displayType, dymaptic.GeoBlazor.Pro.Components.AttachmentsCapabilities? capabilities=null);
Parameters
displayType System.String
String indicating how to display the attachments.
capabilities AttachmentsCapabilities
The capabilities needed for the attachments widget.
Properties
SupportingWidgetAttachments.Capabilities Property
The capabilities needed for the attachments widget.
public dymaptic.GeoBlazor.Pro.Components.AttachmentsCapabilities? Capabilities { get; set; }
Property Value
SupportingWidgetAttachments.DisplayType Property
String indicating how to display the attachments.
public string? DisplayType { get; set; }
Property Value
Methods
SupportingWidgetAttachments.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.
SupportingWidgetAttachments.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.
SupportingWidgetAttachments.ValidateRequiredChildren() Method
When a dymaptic.GeoBlazor.Core.Components.Views.MapView is prepared to render, this will check to make sure that all properties with the dymaptic.GeoBlazor.Core.Attributes.RequiredPropertyAttribute are provided.
public override void ValidateRequiredChildren();
Implements ValidateRequiredChildren()
Exceptions
dymaptic.GeoBlazor.Core.Exceptions.MissingRequiredChildElementException
The consumer needs to provide the missing child component
dymaptic.GeoBlazor.Core.Exceptions.MissingRequiredOptionsChildElementException
The consumer needs to provide ONE of the options of child components