LuciadCPillar C# 2024.1.05
Luciad.Edit.Features.FeatureEditConfigurationBuilder Class Reference

This builder can be used to configure editing for a layer. More...

Inheritance diagram for Luciad.Edit.Features.FeatureEditConfigurationBuilder:

Public Member Functions

void Dispose ()
 
Luciad.Edit.Features.FeatureEditConfigurationBuilder HandlesProvider (Luciad.Edit.Features.IFeatureHandlesProvider handlesProvider)
 Configures the handles provider that is used to provide the edit handles for a feature. More...
 
void NotEditable ()
 Disable editing for the current feature. More...
 
void Submit ()
 Submits the information to this builder, and confirm that the current feature can be edited. More...
 
Luciad.Edit.Features.FeatureEditConfigurationBuilder UpdateMode (Luciad.Edit.ModelUpdateMode updateMode)
 This setting gives more control over when and how often the model is updated during interactive editing. More...
 

Detailed Description

This builder can be used to configure editing for a layer.

See FeatureLayer.Builder.EditConfiguration.

See the related guide for more configuration options.

Since
2020.1

Member Function Documentation

◆ Dispose()

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

◆ HandlesProvider()

Luciad.Edit.Features.FeatureEditConfigurationBuilder Luciad.Edit.Features.FeatureEditConfigurationBuilder.HandlesProvider ( Luciad.Edit.Features.IFeatureHandlesProvider  handlesProvider)
inline

Configures the handles provider that is used to provide the edit handles for a feature.

Calling this method is optional. If this method is not called, a default implementation will be configured. See CompositeFeatureHandlesProvider.createDefault().

Parameters
handlesProvidera handles provider for Features, cannot be null
Returns
this
Exceptions
System.ArgumentNullExceptionwhen null is passed.

◆ NotEditable()

void Luciad.Edit.Features.FeatureEditConfigurationBuilder.NotEditable ( )
inline

Disable editing for the current feature.

Either this method, or the submit() method must be called.

Note: you can disable editing for all features of a layer by not configuring an IFeatureEditConfiguration.

◆ Submit()

void Luciad.Edit.Features.FeatureEditConfigurationBuilder.Submit ( )
inline

Submits the information to this builder, and confirm that the current feature can be edited.

Either this method, or the NotEditable method must be called.

Exceptions
System.InvalidOperationExceptionon an illegal state, e.g. when already submitted.

◆ UpdateMode()

Luciad.Edit.Features.FeatureEditConfigurationBuilder Luciad.Edit.Features.FeatureEditConfigurationBuilder.UpdateMode ( Luciad.Edit.ModelUpdateMode  updateMode)
inline

This setting gives more control over when and how often the model is updated during interactive editing.

It is useful to make sure that the model is updated less often when model updates are expensive, for example for models with a database backend, or other models that don't keep Feature state in memory.

The default is ModelUpdateMode.OnAnyChange.

Parameters
updateModethe update mode
Returns
this