Shapefile editing

Functions
int	Shapefile.EditAddShape (Shape Shape)
	Adds a new shape to the shapefile.
bool	Shapefile.EditClear ()
	Deletes all the shapes from the shapefile.
bool	Shapefile.EditDeleteShape (int ShapeIndex)
	Deletes a shape from the shapefile.
bool	Shapefile.EditInsertShape (Shape Shape, ref int ShapeIndex)
	Inserts a new shape in the shapefile.
bool	Shapefile.StartEditingShapes (bool StartEditTable, ICallback cBack)
	Starts editing mode for the shapefile.
bool	Shapefile.StopEditingShapes (bool ApplyChanges, bool StopEditTable, ICallback cBack)
	Stops editing modes for the shapefile and optionally saves the changes.
Properties
bool	Shapefile.EditingShapes [get]
	Gets the value indicating whether editing operations are allowed for shapefile.

---

Detailed Description

Here is a list of properties and methods which control the editing of shapefile. This module is a part of the documentation of Shapefile class.

Graph description

---

Function Documentation

int Shapefile.EditAddShape

(

Shape

Shape

)

Adds a new shape to the shapefile.

Parameters:

Shape

The shape to be added.

Returns:

The index of the new shape or -1 on failure.

Examples:

IntersectionLength.cs, and Segmentation.cs.

bool Shapefile.EditClear

(

)

Deletes all the shapes from the shapefile.

Both shapefile and attribute table must be in editing mode for the successful operation. The records of atribute table will be removed as well to ensure shapefile integrity.

Returns:

Returns true on success and false otherwise.

bool Shapefile.EditDeleteShape

(

int

ShapeIndex

)

Deletes a shape from the shapefile.

Both shapefile and attribute table must be in editing mode for the successful operation. Corresponding record will be removed from atribute table to ensure shapefile integrity.

Parameters:

ShapeIndex

The index of shape to delete.

Returns:

Returns true on success and false otherwise.

See also:

Shapefile.EditingShapes, Shapefile.EditingTable

Examples:

RemoveShape.cs.

bool Shapefile.EditInsertShape	(	Shape	Shape,
		ref int	ShapeIndex
	)

Inserts a new shape in the shapefile.

Both shapefile and attribute table must be in editing mode for the successful operation. A record will be automatically added to the atribute table to ensure shapefile integrity.

Parameters:

Shape	The shape object to insert.
ShapeIndex	The index to insert the new shape at. An ivalid index will be automatically substituted with closest allowable value without reporting the error.

Returns:

True on success and false otherwise.

Examples:

CreateBuffer.cs, CreatePointShapefile.cs, CreatePolygonShapefile.cs, LinePattern.cs, MarkPoints.cs, PolygonsWithHoles.cs, and SplitByAttribute.cs.

bool Shapefile.StartEditingShapes	(	bool	StartEditTable,
		ICallback	cBack
	)

Starts editing mode for the shapefile.

In case editing mode has already been opened the new call will return true inspite of it which is different from the bevavior of the earlier versions (before 4.8).

Parameters:

StartEditTable	A value which indicate whether or not the editing mode will be opened for attribute table associated with the shapefile.
cBack	A callback object to report errors and progress information.

Returns:

Returns true on successful opening of the editing mode and false on failure.

Examples:

IntersectionLength.cs, MinimalDistance.cs, RemoveShape.cs, SelectBox.cs, SelectByDistance.cs, and ToolTip.cs.

bool Shapefile.StopEditingShapes	(	bool	ApplyChanges,
		bool	StopEditTable,
		ICallback	cBack
	)

Stops editing modes for the shapefile and optionally saves the changes.

Parameters:

ApplyChanges	The value which indicates whether changes made to the shapefile shoud be saved.
StopEditTable	The value which indicates whether editing mode for associated attribute table should be closed as well.
cBack	A callback object to report errors and progress information.

Returns:

True on success and false otherwise.

Examples:

MinimalDistance.cs.

---

Properties

bool Shapefile.EditingShapes [get]

Gets the value indicating whether editing operations are allowed for shapefile.

Shapefile.EditInsertShape, Shapefile.EditDeleteShape, Shapefile.EditClear are affected by this property.
Use Shapefile.StartEditingShapes and Shapefile.StopEditingShapes to control the editing mode.