LuciadCPillar C# 2024.0
Luciad.Edit.Features.FeatureEditContext Class Reference

FeatureEditContext provides context information for the feature that is being edited. More...

Inheritance diagram for Luciad.Edit.Features.FeatureEditContext:

Public Member Functions

void Dispose ()
 

Properties

Luciad.Edit.EditSettings DefaultSettings [get]
 The default edit settings. More...
 
Luciad.Utils.Observable< Luciad.Models.Features.FeatureFeature [get]
 The Feature that is being edited. More...
 
Luciad.Layers.Features.LayerFeatureId HandleFeatureId [get]
 The feature ID for the handle to which this context is passed. More...
 
ulong HandleLayerId [get]
 The layer ID of the handle of the Feature that is being edited. More...
 
Luciad.Layers.Features.FeatureLayer Layer [get]
 The FeatureLayer on which the feature is edited. More...
 
Luciad.Maps.Map Map [get]
 The map on which the feature is being edited. More...
 
Luciad.Models.Features.IFeatureModel Model [get]
 The IFeatureModel of the Feature that is being edited. More...
 
Luciad.Layers.Features.LayerFeatureId PreviewFeatureId [get]
 The ID for the Feature that is used to visualize the editing result. More...
 

Detailed Description

FeatureEditContext provides context information for the feature that is being edited.

Since
2020.1

Member Function Documentation

◆ Dispose()

void Luciad.Edit.Features.FeatureEditContext.Dispose ( )
inline

Property Documentation

◆ DefaultSettings

Luciad.Edit.EditSettings Luciad.Edit.Features.FeatureEditContext.DefaultSettings
get

The default edit settings.

[get]

Returns the default edit settings.

◆ Feature

Luciad.Utils.Observable<Luciad.Models.Features.Feature> Luciad.Edit.Features.FeatureEditContext.Feature
get

The Feature that is being edited.

[get]

Returns the Feature that is being edited.

◆ HandleFeatureId

Luciad.Layers.Features.LayerFeatureId Luciad.Edit.Features.FeatureEditContext.HandleFeatureId
get

The feature ID for the handle to which this context is passed.

[get]

Returns the feature ID for the handle to which this context is passed. It can be used to query the map for specific edit handles, for example. This method will throw an exception if it is called outside an IEditHandle call.

◆ HandleLayerId

ulong Luciad.Edit.Features.FeatureEditContext.HandleLayerId
get

The layer ID of the handle of the Feature that is being edited.

[get]

Returns the layer ID of the handle of the Feature that is being edited.

◆ Layer

Luciad.Layers.Features.FeatureLayer Luciad.Edit.Features.FeatureEditContext.Layer
get

The FeatureLayer on which the feature is edited.

[get]

Returns the FeatureLayer on which the feature is edited. The layer can for example be used to retrieve the IFeatureGeometryProvider.

See also
FeatureLayer.EditCreateGeometryProvider

◆ Map

Luciad.Maps.Map Luciad.Edit.Features.FeatureEditContext.Map
get

The map on which the feature is being edited.

[get]

Returns the map on which the feature is being edited.

◆ Model

Luciad.Models.Features.IFeatureModel Luciad.Edit.Features.FeatureEditContext.Model
get

The IFeatureModel of the Feature that is being edited.

[get]

Returns the IFeatureModel of the Feature that is being edited.

◆ PreviewFeatureId

Luciad.Layers.Features.LayerFeatureId Luciad.Edit.Features.FeatureEditContext.PreviewFeatureId
get

The ID for the Feature that is used to visualize the editing result.

[get]

Returns the ID for the Feature that is used to visualize the editing result. Depending on the configured ModelUpdateMode, this can be a different ID.

For ModelUpdateMode.OnAnyChange, the original layer is used and the id of getFeature().

For ModelUpdateMode.OnMajorChanges and ModelUpdateMode.OnEditFinished, this is the ID of the a copy of the Feature, visualized by the handle layer.

This ID can be used for the Map.QueryFeatures method to detect if the currently edited Feature is touched, for example.