GeoBlazor Pro
dymaptic.GeoBlazor.Pro
dymaptic.GeoBlazor.Pro.Events
SketchViewModelUpdateEvent Class
Event result type for the SketchViewModel.OnUpdate event.
public record SketchViewModelUpdateEvent : System.IEquatable<dymaptic.GeoBlazor.Pro.Events.SketchViewModelUpdateEvent>
Inheritance System.Object 🡒 SketchViewModelUpdateEvent
Implements System.IEquatable<SketchViewModelUpdateEvent>
Constructors
SketchViewModelUpdateEvent(Nullable, IReadOnlyCollection, Nullable, Nullable, IUpdateToolEventInfo) Constructor
Event result type for the SketchViewModel.OnUpdate event.
public SketchViewModelUpdateEvent(System.Nullable<bool> Aborted=null, System.Collections.Generic.IReadOnlyCollection<dymaptic.GeoBlazor.Core.Components.Graphic>? Graphics=null, System.Nullable<dymaptic.GeoBlazor.Pro.Enums.SketchEventState> State=null, System.Nullable<dymaptic.GeoBlazor.Pro.Enums.SketchTool> Tool=null, dymaptic.GeoBlazor.Core.Interfaces.IUpdateToolEventInfo? ToolEventInfo=null);
Parameters
Aborted System.Nullable<System.Boolean>
Indicates if the update operation was aborted. Set to
true
if the user pressed the escape key, or when the update(), create() or cancel() method is called before the
update
``` event's
```csharp
state
``` changes to
```csharp
complete
```.
<a name='dymaptic.GeoBlazor.Pro.Events.SketchViewModelUpdateEvent.SketchViewModelUpdateEvent(System.Nullable_bool_,System.Collections.Generic.IReadOnlyCollection_dymaptic.GeoBlazor.Core.Components.Graphic_,System.Nullable_dymaptic.GeoBlazor.Pro.Enums.SketchEventState_,System.Nullable_dymaptic.GeoBlazor.Pro.Enums.SketchTool_,dymaptic.GeoBlazor.Core.Interfaces.IUpdateToolEventInfo).Graphics'></a>
`Graphics` [System.Collections.Generic.IReadOnlyCollection<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyCollection-1 'System.Collections.Generic.IReadOnlyCollection\`1')[Graphic](dymaptic.GeoBlazor.Core.Components.Graphic.html 'dymaptic.GeoBlazor.Core.Components.Graphic')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IReadOnlyCollection-1 'System.Collections.Generic.IReadOnlyCollection\`1')
An array of graphics that are being updated.
<a name='dymaptic.GeoBlazor.Pro.Events.SketchViewModelUpdateEvent.SketchViewModelUpdateEvent(System.Nullable_bool_,System.Collections.Generic.IReadOnlyCollection_dymaptic.GeoBlazor.Core.Components.Graphic_,System.Nullable_dymaptic.GeoBlazor.Pro.Enums.SketchEventState_,System.Nullable_dymaptic.GeoBlazor.Pro.Enums.SketchTool_,dymaptic.GeoBlazor.Core.Interfaces.IUpdateToolEventInfo).State'></a>
`State` [System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable\`1')[SketchEventState](dymaptic.GeoBlazor.Pro.Enums.SketchEventState.html 'dymaptic.GeoBlazor.Pro.Enums.SketchEventState')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable\`1')
The state of the event.
<a name='dymaptic.GeoBlazor.Pro.Events.SketchViewModelUpdateEvent.SketchViewModelUpdateEvent(System.Nullable_bool_,System.Collections.Generic.IReadOnlyCollection_dymaptic.GeoBlazor.Core.Components.Graphic_,System.Nullable_dymaptic.GeoBlazor.Pro.Enums.SketchEventState_,System.Nullable_dymaptic.GeoBlazor.Pro.Enums.SketchTool_,dymaptic.GeoBlazor.Core.Interfaces.IUpdateToolEventInfo).Tool'></a>
`Tool` [System.Nullable<](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable\`1')[SketchTool](dymaptic.GeoBlazor.Pro.Enums.SketchTool.html 'dymaptic.GeoBlazor.Pro.Enums.SketchTool')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Nullable-1 'System.Nullable\`1')
Name of the update operation tool.
<a name='dymaptic.GeoBlazor.Pro.Events.SketchViewModelUpdateEvent.SketchViewModelUpdateEvent(System.Nullable_bool_,System.Collections.Generic.IReadOnlyCollection_dymaptic.GeoBlazor.Core.Components.Graphic_,System.Nullable_dymaptic.GeoBlazor.Pro.Enums.SketchEventState_,System.Nullable_dymaptic.GeoBlazor.Pro.Enums.SketchTool_,dymaptic.GeoBlazor.Core.Interfaces.IUpdateToolEventInfo).ToolEventInfo'></a>
`ToolEventInfo` [IUpdateToolEventInfo](dymaptic.GeoBlazor.Core.Interfaces.IUpdateToolEventInfo.html 'dymaptic.GeoBlazor.Core.Interfaces.IUpdateToolEventInfo')
Update operation tool info.
Returns additional information associated with the update operation that is taking place for selected graphics
and what stage it is at. Value of this parameter changes to
```csharp
null
``` when the
```csharp
update
``` event's
```csharp
state
``` changes to
```csharp
complete
```.
### Properties
<a name='dymaptic.GeoBlazor.Pro.Events.SketchViewModelUpdateEvent.Aborted'></a>
## SketchViewModelUpdateEvent.Aborted Property
Indicates if the update operation was aborted. Set to
```csharp
true
if the user pressed the escape key, or when the update(), create() or cancel() method is called before the
update
``` event's
```csharp
state
``` changes to
```csharp
complete
```.
```csharp
public System.Nullable<bool> Aborted { get; init; }
Property Value
System.Nullable<System.Boolean>
SketchViewModelUpdateEvent.Graphics Property
An array of graphics that are being updated.
public System.Collections.Generic.IReadOnlyCollection<dymaptic.GeoBlazor.Core.Components.Graphic>? Graphics { get; init; }
Property Value
System.Collections.Generic.IReadOnlyCollection<Graphic>
SketchViewModelUpdateEvent.State Property
The state of the event.
public System.Nullable<dymaptic.GeoBlazor.Pro.Enums.SketchEventState> State { get; init; }
Property Value
System.Nullable<SketchEventState>
SketchViewModelUpdateEvent.Tool Property
Name of the update operation tool.
public System.Nullable<dymaptic.GeoBlazor.Pro.Enums.SketchTool> Tool { get; init; }
Property Value
SketchViewModelUpdateEvent.ToolEventInfo Property
Update operation tool info. Returns additional information associated with the update operation that is taking place for selected graphics and what stage it is at. Value of this parameter changes to
null
``` when the
```csharp
update
``` event's
```csharp
state
``` changes to
```csharp
complete
```.
```csharp
public dymaptic.GeoBlazor.Core.Interfaces.IUpdateToolEventInfo? ToolEventInfo { get; init; }