Skip to content

ShapeFileFeatureLayer

Inheritance Hierarchy

Members Summary

Public Constructors Summary

Name
ShapeFileFeatureLayer()
ShapeFileFeatureLayer(String)
ShapeFileFeatureLayer(String,FileAccess)
ShapeFileFeatureLayer(String,String)
ShapeFileFeatureLayer(String,String,FileAccess)
ShapeFileFeatureLayer(String,String,FileAccess,Encoding)

Protected Constructors Summary

Name
N/A

Public Properties Summary

Name Return Type Description
Attribution String N/A
Background GeoColor N/A
BlueTranslation Single N/A
ColorMappings Dictionary<GeoColor,GeoColor> N/A
DrawingExceptionMode DrawingExceptionMode N/A
DrawingMarginInPixel Single N/A
DrawingQuality DrawingQuality N/A
DrawingTime TimeSpan N/A
EditTools EditTools N/A
Encoding Encoding This property gets and sets the encoding information for the DBF.
FeatureIdsToExclude Collection<String> N/A
FeatureSource FeatureSource N/A
GreenTranslation Single N/A
HasBoundingBox Boolean This property checks to see if a Layer has a BoundingBox or not. If it has no BoundingBox, it will throw an exception when you call the GetBoundingBox() and GetFullExtent() APIs. In ShapeFileFeatureLayer, we override this API and mark it as true.
IndexPathFilename String This property returns the path and filename of the index file you want to represent.
IsGrayscale Boolean N/A
IsNegative Boolean N/A
IsOpen Boolean N/A
IsVisible Boolean N/A
KeyColors Collection<GeoColor> N/A
MaxRecordsToDraw Int32 N/A
Name String N/A
ProgressiveDrawingRecordsCount Int32 N/A
Projection Projection N/A
QueryTools QueryTools N/A
ReadWriteMode FileAccess N/A
RedTranslation Single N/A
RequestDrawingInterval TimeSpan N/A
RequireIndex Boolean This property gets and sets whether an index is required when reading data. The default value is true.
ShapePathFilename String This property returns the path and filename of the Shape File you want to represent.
SimplificationAreaInPixel Int32 N/A
ThreadSafe ThreadSafetyLevel N/A
Transparency Single N/A
UsingSpatialIndex Boolean This property gets whether the Shape File FeatureSource has an index or not.
WrappingExtent RectangleShape N/A
WrappingMode WrappingMode N/A
ZoomLevelSet ZoomLevelSet N/A

Protected Properties Summary

Name Return Type Description
FetchedCount Int64 N/A
FetchTime TimeSpan N/A
IsOpenCore Boolean N/A
StyleTime TimeSpan N/A

Public Methods Summary

Name
BuildIndexFile(String)
BuildIndexFile(String,String,BuildIndexMode)
BuildIndexFile(String,BuildIndexMode)
BuildIndexFile(IEnumerable<Feature>,String)
BuildIndexFile(IEnumerable<Feature>,String,ProjectionConverter)
BuildIndexFile(IEnumerable<Feature>,String,BuildIndexMode)
BuildIndexFile(IEnumerable<Feature>,String,ProjectionConverter,BuildIndexMode)
BuildIndexFile(String,String,String,String,BuildIndexMode)
BuildIndexFile(String,String,ProjectionConverter,String,String,BuildIndexMode)
BuildIndexFile(String,String,ProjectionConverter,String,String,BuildIndexMode,Encoding)
BuildRecordIdColumn(String,String,BuildRecordIdMode)
BuildRecordIdColumn(String,String,BuildRecordIdMode,Int32)
BuildRecordIdColumn(String,String,BuildRecordIdMode,Int32,Encoding)
CloneDeep()
CloneShapeFileStructure(String,String)
CloneShapeFileStructure(String,String,OverwriteMode)
CloneShapeFileStructure(String,String,OverwriteMode,Encoding)
Close()
CreateShapeFile(ShapeFileType,String,IEnumerable<DbfColumn>)
CreateShapeFile(ShapeFileType,String,IEnumerable<DbfColumn>,Encoding)
CreateShapeFile(ShapeFileType,String,IEnumerable<DbfColumn>,Encoding,OverwriteMode)
Draw(GeoCanvas,Collection<SimpleCandidate>)
Equals(Object)
GetBoundingBox()
GetHashCode()
GetShapeFileType()
GetType()
GetValidColumnNames(IEnumerable<String>)
GetValidColumnNames(IEnumerable<String>,Encoding)
GetValidColumns(IEnumerable<DbfColumn>)
GetValidColumns(IEnumerable<DbfColumn>,Encoding)
Open()
Rebuild(String)
Rebuild(String,ShapeFileSortingMode,Int32)
Reproject(String,String,ProjectionConverter,OverwriteMode)
RequestDrawing()
RequestDrawing(RectangleShape)
RequestDrawing(IEnumerable<RectangleShape>)
RequestDrawing(TimeSpan)
RequestDrawing(TimeSpan,RequestDrawingBufferTimeType)
RequestDrawing(RectangleShape,TimeSpan)
RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType)
RequestDrawing(IEnumerable<RectangleShape>,TimeSpan)
RequestDrawing(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType)
ToString()
Validate()

Protected Methods Summary

Name
CloneDeepCore()
CloseCore()
DrawAttributionCore(GeoCanvas,String)
DrawCore(GeoCanvas,Collection<SimpleCandidate>)
DrawException(GeoCanvas,Exception)
DrawExceptionCore(GeoCanvas,Exception)
Finalize()
GetBoundingBoxCore()
GetWrappingFeaturesForDrawing(WrappingWorldDirection,RectangleShape,Double,Double,IEnumerable<String>,RectangleShape)
MemberwiseClone()
OnDrawingAttribution(DrawingAttributionLayerEventArgs)
OnDrawingException(DrawingExceptionLayerEventArgs)
OnDrawingFeatures(DrawingFeaturesEventArgs)
OnDrawingProgressChanged(DrawingProgressChangedEventArgs)
OnDrawingWrappingFeatures(DrawingWrappingFeaturesFeatureLayerEventArgs)
OnDrawnAttribution(DrawnAttributionLayerEventArgs)
OnDrawnException(DrawnExceptionLayerEventArgs)
OnRequestedDrawing(RequestedDrawingLayerEventArgs)
OnRequestingDrawing(RequestingDrawingLayerEventArgs)
OpenCore()
SetupTools()
SetupToolsCore()

Public Events Summary

Name Event Arguments Description
StreamLoading StreamLoadingEventArgs N/A
DrawingFeatures DrawingFeaturesEventArgs N/A
DrawingWrappingFeatures DrawingWrappingFeaturesFeatureLayerEventArgs N/A
DrawingProgressChanged DrawingProgressChangedEventArgs N/A
DrawingException DrawingExceptionLayerEventArgs N/A
DrawnException DrawnExceptionLayerEventArgs N/A
DrawingAttribution DrawingAttributionLayerEventArgs N/A
DrawnAttribution DrawnAttributionLayerEventArgs N/A
RequestedDrawing RequestedDrawingLayerEventArgs N/A
RequestingDrawing RequestingDrawingLayerEventArgs N/A

Members Detail

Public Constructors

Name
ShapeFileFeatureLayer()
ShapeFileFeatureLayer(String)
ShapeFileFeatureLayer(String,FileAccess)
ShapeFileFeatureLayer(String,String)
ShapeFileFeatureLayer(String,String,FileAccess)
ShapeFileFeatureLayer(String,String,FileAccess,Encoding)

Protected Constructors

Public Properties

Attribution

Summary

N/A

Remarks

N/A

Return Value

String


Background

Summary

N/A

Remarks

N/A

Return Value

GeoColor


BlueTranslation

Summary

N/A

Remarks

N/A

Return Value

Single


ColorMappings

Summary

N/A

Remarks

N/A

Return Value

Dictionary<GeoColor,GeoColor>


DrawingExceptionMode

Summary

N/A

Remarks

N/A

Return Value

DrawingExceptionMode


DrawingMarginInPixel

Summary

N/A

Remarks

N/A

Return Value

Single


DrawingQuality

Summary

N/A

Remarks

N/A

Return Value

DrawingQuality


DrawingTime

Summary

N/A

Remarks

N/A

Return Value

TimeSpan


EditTools

Summary

N/A

Remarks

N/A

Return Value

EditTools


Encoding

Summary

This property gets and sets the encoding information for the DBF.

Remarks

N/A

Return Value

Encoding


FeatureIdsToExclude

Summary

N/A

Remarks

N/A

Return Value

Collection<String>


FeatureSource

Summary

N/A

Remarks

N/A

Return Value

FeatureSource


GreenTranslation

Summary

N/A

Remarks

N/A

Return Value

Single


HasBoundingBox

Summary

This property checks to see if a Layer has a BoundingBox or not. If it has no BoundingBox, it will throw an exception when you call the GetBoundingBox() and GetFullExtent() APIs. In ShapeFileFeatureLayer, we override this API and mark it as true.

Remarks

The default implementation in the base class returns false.

Return Value

Boolean


IndexPathFilename

Summary

This property returns the path and filename of the index file you want to represent.

Remarks

None

Return Value

String


IsGrayscale

Summary

N/A

Remarks

N/A

Return Value

Boolean


IsNegative

Summary

N/A

Remarks

N/A

Return Value

Boolean


IsOpen

Summary

N/A

Remarks

N/A

Return Value

Boolean


IsVisible

Summary

N/A

Remarks

N/A

Return Value

Boolean


KeyColors

Summary

N/A

Remarks

N/A

Return Value

Collection<GeoColor>


MaxRecordsToDraw

Summary

N/A

Remarks

N/A

Return Value

Int32


Name

Summary

N/A

Remarks

N/A

Return Value

String


ProgressiveDrawingRecordsCount

Summary

N/A

Remarks

N/A

Return Value

Int32


Projection

Summary

N/A

Remarks

N/A

Return Value

Projection


QueryTools

Summary

N/A

Remarks

N/A

Return Value

QueryTools


ReadWriteMode

Summary

N/A

Remarks

N/A

Return Value

FileAccess


RedTranslation

Summary

N/A

Remarks

N/A

Return Value

Single


RequestDrawingInterval

Summary

N/A

Remarks

N/A

Return Value

TimeSpan


RequireIndex

Summary

This property gets and sets whether an index is required when reading data. The default value is true.

Remarks

N/A

Return Value

Boolean


ShapePathFilename

Summary

This property returns the path and filename of the Shape File you want to represent.

Remarks

None

Return Value

String


SimplificationAreaInPixel

Summary

N/A

Remarks

N/A

Return Value

Int32


ThreadSafe

Summary

N/A

Remarks

N/A

Return Value

ThreadSafetyLevel


Transparency

Summary

N/A

Remarks

N/A

Return Value

Single


UsingSpatialIndex

Summary

This property gets whether the Shape File FeatureSource has an index or not.

Remarks

N/A

Return Value

Boolean


WrappingExtent

Summary

N/A

Remarks

N/A

Return Value

RectangleShape


WrappingMode

Summary

N/A

Remarks

N/A

Return Value

WrappingMode


ZoomLevelSet

Summary

N/A

Remarks

N/A

Return Value

ZoomLevelSet


Protected Properties

FetchedCount

Summary

N/A

Remarks

N/A

Return Value

Int64


FetchTime

Summary

N/A

Remarks

N/A

Return Value

TimeSpan


IsOpenCore

Summary

N/A

Remarks

N/A

Return Value

Boolean


StyleTime

Summary

N/A

Remarks

N/A

Return Value

TimeSpan


Public Methods

BuildIndexFile(String)

Summary

This method builds a spatial index for the layer.

Remarks

This overload allows you to pass in the Shape File.

Return Value

Type Description
Void None

Parameters

Name Type Description
pathFilename String The path and filename to the Shape File.

BuildIndexFile(String,String,BuildIndexMode)

Summary

This method build a spatial index for the shape file which increases accessspeed.

Remarks

This overload builds an index file with the same name as the shape file with only the extension being different. You can also specify if you want to rebuild an existing index file.

Return Value

Type Description
Void None

Parameters

Name Type Description
shapePathFilename String This parameter is the shape file name and path that you want to build an index for.
indexPathFilename String This parameter specifies the index file name.
buildIndexMode BuildIndexMode This parameter determines what will happen if there is an existing index file.

BuildIndexFile(String,BuildIndexMode)

Summary

This method builds a spatial index for the layer.

Remarks

This overload allows you to pass in the Shape File and determines if we rebuild an index file that already exists.

Return Value

Type Description
Void None

Parameters

Name Type Description
pathFilename String This parameter is the matching pattern that defines which Shape Files to include.
rebuildExistingIndexMode BuildIndexMode This parameter determines whether an index file will be rebuilt if it already exists.

BuildIndexFile(IEnumerable<Feature>,String)

Summary

This method builds a spatial index for the specified group of features.

Remarks

This overload allows you to pass in a group of features and specify the index filename to use.

Return Value

Type Description
Void None

Parameters

Name Type Description
features IEnumerable<Feature> This parameter specifies the features for which to build the index.
indexPathFilename String This parameter specifies the target index path and filename.

BuildIndexFile(IEnumerable<Feature>,String,ProjectionConverter)

Summary

This method builds a spatial index for the specified group of features and target projection.

Remarks

This overload allows you to pass in a group of features and specify a target projection and the index filename to use.

Return Value

Type Description
Void None

Parameters

Name Type Description
features IEnumerable<Feature> This parameter specifies the features for which to build the index.
indexPathFilename String This parameter specifies the target index path and filename.
projectionConverter ProjectionConverter This parameter specifies the projection to build index against those features.

BuildIndexFile(IEnumerable<Feature>,String,BuildIndexMode)

Summary

This method builds a spatial index for the specified group of features.

Remarks

This overload allows you to pass in a group of features and specify the index filename to use.

Return Value

Type Description
Void None

Parameters

Name Type Description
features IEnumerable<Feature> This parameter specifies the features for which to build the index.
indexPathFilename String This parameter determines the target index path filename.
buildIndexMode BuildIndexMode This parameter determines whether an index file will be rebuilt if it already exists.

BuildIndexFile(IEnumerable<Feature>,String,ProjectionConverter,BuildIndexMode)

Summary

This method builds a spatial index for the specified group of features.

Remarks

This overload allows you to pass in a group of features and specify a target projection and the index filename to use.

Return Value

Type Description
Void None

Parameters

Name Type Description
features IEnumerable<Feature> This parameter specifies the features for which to build the index.
indexPathFilename String This parameter determines the target index path filename.
projectionConverter ProjectionConverter This parameter determines the Projection to build index against those features.
buildIndexMode BuildIndexMode This parameter determines whether an index file will be rebuilt if it already exists.

BuildIndexFile(String,String,String,String,BuildIndexMode)

Summary

This method builds a spatial index only for those features that satisfy a regular expression.

Remarks

This overload allows you to pass in a Shape File and specify the index filename to use.

Return Value

Type Description
Void None

Parameters

Name Type Description
shapePathFilename String This parameter specifies the Shape File for which to build the index.
indexPathFilename String This parameter determines the target index path filename.
columnName String This parameter determines the column name whose values will be tested against the regular expression.
regularExpression String This parameter represents the regular expression to test against each feature for inclusion in the index.
buildIndexMode BuildIndexMode This parameter determines whether an index file will be rebuilt if it already exists.

BuildIndexFile(String,String,ProjectionConverter,String,String,BuildIndexMode)

Summary

This method builds a spatial index only for those features that satisfy a regular expression, based on a passed-in projection.

Remarks

This overload allows you to pass in a Shape File and specify the index filename to use.

Return Value

Type Description
Void None

Parameters

Name Type Description
shapePathFilename String This parameter specifies the Shape File for which to build the index.
indexPathFilename String This parameter determines the target index path filename.
projectionConverter ProjectionConverter This parameter determines the projection that will be used to build the index against those features that satisfy the regular expression.
columnName String This parameter determines the column name whose values will be tested against the regular expression.
regularExpression String This parameter represents the regular expression to test against each feature for inclusion in the index.
buildIndexMode BuildIndexMode This parameter determines whether an index file will be rebuilt if it already exists.

BuildIndexFile(String,String,ProjectionConverter,String,String,BuildIndexMode,Encoding)

Summary

This method builds a spatial index only for those features that satisfy a regular expression, based on a passed-in projection.

Remarks

This overload allows you to pass in a Shape File and specify the index filename to use.

Return Value

Type Description
Void None

Parameters

Name Type Description
shapePathFilename String This parameter specifies the Shape File for which to build the index.
indexPathFilename String This parameter determines the target index path filename.
projectionConverter ProjectionConverter This parameter determines the projection that will be used to build the index against those features that satisfy the regular expression.
columnName String This parameter determines the column name whose values will be tested against the regular expression.
regularExpression String This parameter represents the regular expression to test against each feature for inclusion in the index.
buildIndexMode BuildIndexMode This parameter determines whether an index file will be rebuilt if it already exists.
encoding Encoding This parameter specifies the encoding information used in the source DBF file.

BuildRecordIdColumn(String,String,BuildRecordIdMode)

Summary

Static API used to build RecordId. The Id will start from 0.

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
shapeFilename String The name of the target ShapeFile on which to base the newly built RecordId.
fieldname String The field name for the RecordId.
rebuildNeeded BuildRecordIdMode The RecordId build mode.

BuildRecordIdColumn(String,String,BuildRecordIdMode,Int32)

Summary

Static API used to build RecordId from the specified starting Id number.

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
shapeFilename String The name of the target ShapeFile on which to base the newly built RecordId.
fieldname String The field name for the RecordId.
rebuildNeeded BuildRecordIdMode The RecordId build mode.
startNumber Int32 The starting Id number of the RecordId.

BuildRecordIdColumn(String,String,BuildRecordIdMode,Int32,Encoding)

Summary

Static API used to build RecordId from the specified starting Id number.

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
shapeFilename String The name of the target ShapeFile on which to base the newly built RecordId.
fieldname String The field name for the RecordId.
rebuildNeeded BuildRecordIdMode The RecordId build mode.
startNumber Int32 The starting Id number of the RecordId.
encoding Encoding This parameter specifies the encoding information in the DBF.

CloneDeep()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Layer N/A

Parameters

Name Type Description
N/A N/A N/A

CloneShapeFileStructure(String,String)

Summary

Clone the structure from the source ShapeFile to the target ShapeFile. After cloning the structure, the target ShapeFile will have the same type and the same DBF columns as the source ShapeFile, but without any records in it.

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
sourceShapePathFilename String The source Shape File to be cloned.
targetShapePathFilename String The target Shape File, which will have the same structure as the source Shape File after cloning operation is complete.

CloneShapeFileStructure(String,String,OverwriteMode)

Summary

Clone the structure from the source ShapeFile to the target ShapeFile. After cloning the structure, the target ShapeFile will have the same type and the same DBF columns as the source ShapeFile, but without any records in it.

Remarks

An exception will be thown when the target ShapeFile does not exist and the overwrite mode is set to DoNotOverwrite.

Return Value

Type Description
Void N/A

Parameters

Name Type Description
sourceShapePathFilename String The source Shape File to be cloned.
targetShapePathFilename String The target Shape File, which will have the same structure as the source Shape File after cloning operation is complete.
overwriteMode OverwriteMode This parameter specifies the overwrite mode when the target ShapeFile already exists.

CloneShapeFileStructure(String,String,OverwriteMode,Encoding)

Summary

Clone the structure from the source ShapeFile to the target ShapeFile. After cloning the structure, the target ShapeFile will have the same type and the same DBF columns as the source ShapeFile, but without any records in it.

Remarks

An exception will be thown when the target ShapeFile does not exist and the overwrite mode is set to DoNotOverwrite.

Return Value

Type Description
Void N/A

Parameters

Name Type Description
sourceShapePathFilename String The source Shape File to be cloned.
targetShapePathFilename String The target Shape File, which will have the same structure as the source Shape File after cloning operation is complete.
overwriteMode OverwriteMode This parameter specifies the overwrite mode when the target ShapeFile already exists.
encoding Encoding This parameter specifies the encoding information in the source Shape File.

Close()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

CreateShapeFile(ShapeFileType,String,IEnumerable<DbfColumn>)

Summary

Static API to create a new Shape File.

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
shapeType ShapeFileType This parameter specifies the the Shape File type for the target Shape File.
pathFilename String This parameter specifies the Shape filename for the target Shape File.
databaseColumns IEnumerable<DbfColumn> This parameter specifies the DBF column information for the target Shape File.

CreateShapeFile(ShapeFileType,String,IEnumerable<DbfColumn>,Encoding)

Summary

Static API to create a new Shape File.

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
shapeType ShapeFileType This parameter specifies the the Shape File type for the target Shape File.
pathFilename String This parameter specifies the Shape filename for the target Shape File.
databaseColumns IEnumerable<DbfColumn> This parameter specifies the DBF column information for the target Shape File.
encoding Encoding This parameter specifies the DBF encoding infromation for the target Shape File.

CreateShapeFile(ShapeFileType,String,IEnumerable<DbfColumn>,Encoding,OverwriteMode)

Summary

Static API to create a new Shape File.

Remarks

An exception will be thown when the target Shape File does not exist while the overwrite mode is set to DoNotOverwrite.

Return Value

Type Description
Void N/A

Parameters

Name Type Description
shapeType ShapeFileType This parameter specifies the the Shape File type for the target Shape File.
pathFilename String This parameter specifies the Shape filename for the target Shape File.
databaseColumns IEnumerable<DbfColumn> This parameter specifies the DBF column information for the target Shape File.
encoding Encoding This parameter specifies the DBF encoding infromation for the target Shape File.
overwriteMode OverwriteMode This parameter specifies the override mode when the target Shape File exists.

Draw(GeoCanvas,Collection<SimpleCandidate>)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
canvas GeoCanvas N/A
labelsInAllLayers Collection<SimpleCandidate> N/A

Equals(Object)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Boolean N/A

Parameters

Name Type Description
obj Object N/A

GetBoundingBox()

Summary

N/A

Remarks

N/A

Return Value

Type Description
RectangleShape N/A

Parameters

Name Type Description
N/A N/A N/A

GetHashCode()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Int32 N/A

Parameters

Name Type Description
N/A N/A N/A

GetShapeFileType()

Summary

Get the Shape File type for the Shape File FeatureSource.

Remarks

N/A

Return Value

Type Description
ShapeFileType The ShapeFileType for the ShapeFile FeatureSource.

Parameters

Name Type Description
N/A N/A N/A

GetType()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Type N/A

Parameters

Name Type Description
N/A N/A N/A

GetValidColumnNames(IEnumerable<String>)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<String> N/A

Parameters

Name Type Description
columnNames IEnumerable<String> N/A

GetValidColumnNames(IEnumerable<String>,Encoding)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<String> N/A

Parameters

Name Type Description
columnNames IEnumerable<String> N/A
encoding Encoding N/A

GetValidColumns(IEnumerable<DbfColumn>)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<DbfColumn> N/A

Parameters

Name Type Description
columns IEnumerable<DbfColumn> N/A

GetValidColumns(IEnumerable<DbfColumn>,Encoding)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<DbfColumn> N/A

Parameters

Name Type Description
columns IEnumerable<DbfColumn> N/A
encoding Encoding N/A

Open()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

Rebuild(String)

Summary

This method rebuilds the SHP, SHX, DBF, IDX and IDS files for the given shape file.

Remarks

This method rebuilds the SHP, SHX, DBF, IDX and IDS files for the given shape file. When we do editing we have optimized the updates so that we do not need to rebuild the entire shape file. This leads to the shape file being out of order which may cause it not to open in other tools. One optimization is if you update a record instead of rebuilding a new shape file we mark the old record as null and add the edited record at the end of the shape file. This greatly increases the speed of committing shape file changes but will over time unorder the shape file. In addition we do a delete the DBF file will simply mark the record deleted and not compact the space. Rebuilding the shape file will correctly order the SPX and SHX along with compacting the DBF file and rebuild any index with the same any of the shape file if it exists. Note that if you have build custom index files where the name of the index differs from that of the shape file you will need to rebuild those manually using the BuildIndex methods.

Return Value

Type Description
Void None

Parameters

Name Type Description
shapePathFilename String This parameter is the shape file you want to rebuild.

Rebuild(String,ShapeFileSortingMode,Int32)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
shapePathFilename String N/A
sortingMode ShapeFileSortingMode N/A
sridForSorting Int32 N/A

Reproject(String,String,ProjectionConverter,OverwriteMode)

Summary

This API provide a easy way to project features in a shape file into another projection and save it to shape file.

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
sourceShapeFile String This parameter specifies the source shape file to be projected.
targetShapeFile String This parameter specifies the target shape file to be saved for the projected features.
projectionConverter ProjectionConverter This parameter is the projection to project the source shape file to target shape file. The source Shape file should be in the FromProjection of the Projection prameter, and the targetShapeFile will be in the ToProjection of the Projection.
overwriteMode OverwriteMode This parameter specifies the override mode when the target shape file exists.

RequestDrawing()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

RequestDrawing(RectangleShape)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
extentToRefresh RectangleShape N/A

RequestDrawing(IEnumerable<RectangleShape>)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
extentsToRefresh IEnumerable<RectangleShape> N/A

RequestDrawing(TimeSpan)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
bufferTime TimeSpan N/A

RequestDrawing(TimeSpan,RequestDrawingBufferTimeType)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
bufferTime TimeSpan N/A
bufferTimeType RequestDrawingBufferTimeType N/A

RequestDrawing(RectangleShape,TimeSpan)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
extentToRefresh RectangleShape N/A
bufferTime TimeSpan N/A

RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
extentToRefresh RectangleShape N/A
bufferTime TimeSpan N/A
bufferTimeType RequestDrawingBufferTimeType N/A

RequestDrawing(IEnumerable<RectangleShape>,TimeSpan)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
extentsToRefresh IEnumerable<RectangleShape> N/A
bufferTime TimeSpan N/A

RequestDrawing(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
extentsToRefresh IEnumerable<RectangleShape> N/A
bufferTime TimeSpan N/A
bufferTimeType RequestDrawingBufferTimeType N/A

ToString()

Summary

N/A

Remarks

N/A

Return Value

Type Description
String N/A

Parameters

Name Type Description
N/A N/A N/A

Validate()

Summary

This method checks all features in a shapefile is supported by Mapsuite or not.

Remarks

N/A

Return Value

Type Description
Dictionary<String,String> A dictionary which contains all the unsupported features. The key is the Indexs which failed to pass the check, the value contains the reason for its failure.

Parameters

Name Type Description
N/A N/A N/A

Protected Methods

CloneDeepCore()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Layer N/A

Parameters

Name Type Description
N/A N/A N/A

CloseCore()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

DrawAttributionCore(GeoCanvas,String)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
canvas GeoCanvas N/A
attribution String N/A

DrawCore(GeoCanvas,Collection<SimpleCandidate>)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
canvas GeoCanvas N/A
labelsInAllLayers Collection<SimpleCandidate> N/A

DrawException(GeoCanvas,Exception)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
canvas GeoCanvas N/A
e Exception N/A

DrawExceptionCore(GeoCanvas,Exception)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
canvas GeoCanvas N/A
e Exception N/A

Finalize()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

GetBoundingBoxCore()

Summary

N/A

Remarks

N/A

Return Value

Type Description
RectangleShape N/A

Parameters

Name Type Description
N/A N/A N/A

GetWrappingFeaturesForDrawing(WrappingWorldDirection,RectangleShape,Double,Double,IEnumerable<String>,RectangleShape)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
wrappingFeatureDirection WrappingWorldDirection N/A
drawingWorldExtent RectangleShape N/A
canvasWidth Double N/A
canvasHeight Double N/A
returningColumnNames IEnumerable<String> N/A
wrappingWorldExtent RectangleShape N/A

MemberwiseClone()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Object N/A

Parameters

Name Type Description
N/A N/A N/A

OnDrawingAttribution(DrawingAttributionLayerEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
args DrawingAttributionLayerEventArgs N/A

OnDrawingException(DrawingExceptionLayerEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
e DrawingExceptionLayerEventArgs N/A

OnDrawingFeatures(DrawingFeaturesEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
e DrawingFeaturesEventArgs N/A

OnDrawingProgressChanged(DrawingProgressChangedEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
e DrawingProgressChangedEventArgs N/A

OnDrawingWrappingFeatures(DrawingWrappingFeaturesFeatureLayerEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
e DrawingWrappingFeaturesFeatureLayerEventArgs N/A

OnDrawnAttribution(DrawnAttributionLayerEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
args DrawnAttributionLayerEventArgs N/A

OnDrawnException(DrawnExceptionLayerEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
e DrawnExceptionLayerEventArgs N/A

OnRequestedDrawing(RequestedDrawingLayerEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
eventArgs RequestedDrawingLayerEventArgs N/A

OnRequestingDrawing(RequestingDrawingLayerEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
eventArgs RequestingDrawingLayerEventArgs N/A

OpenCore()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

SetupTools()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

SetupToolsCore()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

Public Events

StreamLoading

N/A

Remarks

If you choose you can pass in your own stream to represent the file. The stream can come from a variety of places such as isolated storage, a compressed file, and encrypted stream. When the Image is finished with the stream it will dispose of it so be sure to keep this in mind when passing the stream in. If you do not pass in a alternate stream the class will attempt to load the file from the file system using the PathFilename property.

Event Arguments

StreamLoadingEventArgs

DrawingFeatures

N/A

Remarks

N/A

Event Arguments

DrawingFeaturesEventArgs

DrawingWrappingFeatures

N/A

Remarks

N/A

Event Arguments

DrawingWrappingFeaturesFeatureLayerEventArgs

DrawingProgressChanged

N/A

Remarks

N/A

Event Arguments

DrawingProgressChangedEventArgs

DrawingException

N/A

Remarks

N/A

Event Arguments

DrawingExceptionLayerEventArgs

DrawnException

N/A

Remarks

N/A

Event Arguments

DrawnExceptionLayerEventArgs

DrawingAttribution

N/A

Remarks

N/A

Event Arguments

DrawingAttributionLayerEventArgs

DrawnAttribution

N/A

Remarks

N/A

Event Arguments

DrawnAttributionLayerEventArgs

RequestedDrawing

N/A

Remarks

N/A

Event Arguments

RequestedDrawingLayerEventArgs

RequestingDrawing

N/A

Remarks

N/A

Event Arguments

RequestingDrawingLayerEventArgs