ThinkGeo.MapSuite.Core.ShapeFileFeatureLayer
Note: The page was created before Map Suite 10. Map Suite 10.0 organized many classes into new namespaces and assemblies as well as had a few minor breaks in compatibility. The majority of previously built code should work without modification assuming the new namespaces are added. For guidance on upgrading your existing code, please check out MapSuite 10 Upgrade Guide.
This class represents a Layer backed by a Shape File.
Inheritance Hierarchy
Members Summary
Public Constructors
ShapeFileFeatureLayer()
Parameters
ShapeFileFeatureLayer(String)
Parameters
ShapeFileFeatureLayer(String,ShapeFileReadWriteMode)
Parameters
ShapeFileFeatureLayer(String,String)
Parameters
ShapeFileFeatureLayer(String,String,ShapeFileReadWriteMode)
Parameters
ShapeFileFeatureLayer(String,String,ShapeFileReadWriteMode,Encoding)
Parameters
Protected Constructors
Public Methods
GetShapeFileType()
Return Value
Parameters
Validate()
Return Value
Type:Dictionary<String,String>
Description: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
RequestDrawing()
Return Value
Type:Void
Description:N/A
Parameters
RequestDrawing(RectangleShape)
Return Value
Type:Void
Description:N/A
Parameters
RequestDrawing(IEnumerable<RectangleShape>)
Return Value
Type:Void
Description:N/A
Parameters
RequestDrawing(TimeSpan)
Return Value
Type:Void
Description:N/A
Parameters
bufferTime
Type:TimeSpan
Description:N/A
RequestDrawing(TimeSpan,RequestDrawingBufferTimeType)
Return Value
Type:Void
Description:N/A
Parameters
bufferTime
Type:TimeSpan
Description:N/A
RequestDrawing(RectangleShape,TimeSpan)
Return Value
Type:Void
Description:N/A
Parameters
bufferTime
Type:TimeSpan
Description:N/A
RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType)
Return Value
Type:Void
Description:N/A
Parameters
bufferTime
Type:TimeSpan
Description:N/A
RequestDrawing(IEnumerable<RectangleShape>,TimeSpan)
Return Value
Type:Void
Description:N/A
Parameters
bufferTime
Type:TimeSpan
Description:N/A
RequestDrawing(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType)
Return Value
Type:Void
Description:N/A
Parameters
bufferTime
Type:TimeSpan
Description:N/A
GetThreadSafetyLevel()
Return Value
Parameters
CloneDeep()
Return Value
Parameters
Open()
Return Value
Type:Void
Description:N/A
Parameters
Close()
Return Value
Type:Void
Description:N/A
Parameters
GetBoundingBox()
Return Value
Parameters
Draw(GeoCanvas,Collection<SimpleCandidate>)
Return Value
Type:Void
Description:N/A
Parameters
ToString()
Return Value
Type:String
Description:N/A
Parameters
Equals(Object)
Return Value
Type:Boolean
Description:N/A
Parameters
obj
Type:Object
Description:N/A
GetHashCode()
Return Value
Type:Int32
Description:N/A
Parameters
GetType()
Return Value
Type:Type
Description:N/A
Parameters
Rebuild(String)
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:Void
Description:None
Parameters
Rebuild(String,ShapeFileSortingMode,Int32)
Return Value
Type:Void
Description:N/A
Parameters
shapePathFilename
Type:String
Description:N/A
sridForSorting
Type:Int32
Description:N/A
CreateShapeFile(ShapeFileType,String,IEnumerable<DbfColumn>)
Static API to create a new Shape File.
Return Value
Type:Void
Description:N/A
Parameters
CreateShapeFile(ShapeFileType,String,IEnumerable<DbfColumn>,Encoding)
Static API to create a new Shape File.
Return Value
Type:Void
Description:N/A
Parameters
CreateShapeFile(ShapeFileType,String,IEnumerable<DbfColumn>,Encoding,OverwriteMode)
Static API to create a new Shape File.
Return Value
Type:Void
Description:N/A
Parameters
BuildIndexFile(String)
Return Value
Type:Void
Description:None
Parameters
BuildIndexFile(String,String,BuildIndexMode)
Return Value
Type:Void
Description:None
Parameters
BuildIndexFile(String,BuildIndexMode)
Return Value
Type:Void
Description:None
Parameters
BuildIndexFile(IEnumerable<Feature>,String)
Return Value
Type:Void
Description:None
Parameters
BuildIndexFile(IEnumerable<Feature>,String,Projection)
Return Value
Type:Void
Description:None
Parameters
BuildIndexFile(IEnumerable<Feature>,String,BuildIndexMode)
Return Value
Type:Void
Description:None
Parameters
BuildIndexFile(IEnumerable<Feature>,String,Projection,BuildIndexMode)
Return Value
Type:Void
Description:None
Parameters
BuildIndexFile(String,String,String,String,BuildIndexMode)
Return Value
Type:Void
Description:None
Parameters
BuildIndexFile(String,String,Projection,String,String,BuildIndexMode)
Return Value
Type:Void
Description:None
Parameters
BuildIndexFile(String,String,Projection,String,String,BuildIndexMode,Encoding)
Return Value
Type:Void
Description:None
Parameters
CloneShapeFileStructure(String,String)
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.
Return Value
Type:Void
Description:N/A
Parameters
CloneShapeFileStructure(String,String,OverwriteMode)
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.
Return Value
Type:Void
Description:N/A
Parameters
CloneShapeFileStructure(String,String,OverwriteMode,Encoding)
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.
Return Value
Type:Void
Description:N/A
Parameters
BuildRecordIdColumn(String,String,BuildRecordIdMode)
Static API used to build RecordId. The Id will start from 0.
Return Value
Type:Void
Description:N/A
Parameters
BuildRecordIdColumn(String,String,BuildRecordIdMode,Int32)
Static API used to build RecordId from the specified starting Id number.
Return Value
Type:Void
Description:N/A
Parameters
BuildRecordIdColumn(String,String,BuildRecordIdMode,Int32,Encoding)
Static API used to build RecordId from the specified starting Id number.
Return Value
Type:Void
Description:N/A
Parameters
SaveToProjection(String,String,Projection,OverwriteMode)
This API provide a easy way to project features in a shape file into another projection and save it to shape file.
Return Value
Type:Void
Description:N/A
Parameters
GetValidColumns(IEnumerable<DbfColumn>)
Return Value
Parameters
GetValidColumns(IEnumerable<DbfColumn>,Encoding)
Return Value
Parameters
encoding
Type:Encoding
Description:N/A
GetValidColumnNames(IEnumerable<String>)
Return Value
Type:Collection<String>
Description:N/A
Parameters
columnNames
Type:IEnumerable<String>
Description:N/A
GetValidColumnNames(IEnumerable<String>,Encoding)
Return Value
Type:Collection<String>
Description:N/A
Parameters
columnNames
Type:IEnumerable<String>
Description:N/A
encoding
Type:Encoding
Description:N/A
Protected Methods
CloneDeepCore()
Return Value
Parameters
DrawCore(GeoCanvas,Collection<SimpleCandidate>)
Return Value
Type:Void
Description:N/A
Parameters
RequireLinkProcess(IEnumerable<String>)
Return Value
Type:Boolean
Description:N/A
Parameters
returningColumnNames
Type:IEnumerable<String>
Description:N/A
DrawFeaturesWithStyleFilters(GeoCanvas,Dictionary<String,Collection<Feature»,Collection<SimpleCandidate>,ZoomLevel,RectangleShape)
Return Value
Type:Void
Description:N/A
Parameters
featuresForFilters
Type:Dictionary<String,Collection<
Feature»
Description:N/A
OnDrawingFeatures(DrawingFeaturesEventArgs)
Return Value
Type:Void
Description:N/A
Parameters
OnDrawingWrappingFeatures(DrawingWrappingFeaturesFeatureLayerEventArgs)
Return Value
Type:Void
Description:N/A
Parameters
SetupTools()
Return Value
Type:Void
Description:N/A
Parameters
SetupToolsCore()
Return Value
Type:Void
Description:N/A
Parameters
OpenCore()
Return Value
Type:Void
Description:N/A
Parameters
CloseCore()
Return Value
Type:Void
Description:N/A
Parameters
GetBoundingBoxCore()
Return Value
Parameters
OnRequestedDrawing(RequestedDrawingLayerEventArgs)
Return Value
Type:Void
Description:N/A
Parameters
OnRequestingDrawing(RequestingDrawingLayerEventArgs)
Return Value
Type:Void
Description:N/A
Parameters
GetThreadSafetyLevelCore()
Return Value
Parameters
DrawException(GeoCanvas,Exception)
Return Value
Type:Void
Description:N/A
Parameters
e
Type:Exception
Description:N/A
DrawExceptionCore(GeoCanvas,Exception)
Return Value
Type:Void
Description:N/A
Parameters
e
Type:Exception
Description:N/A
OnDrawingException(DrawingExceptionLayerEventArgs)
Return Value
Type:Void
Description:N/A
Parameters
OnDrawnException(DrawnExceptionLayerEventArgs)
Return Value
Type:Void
Description:N/A
Parameters
DrawAttributionCore(GeoCanvas,String)
Return Value
Type:Void
Description:N/A
Parameters
attribution
Type:String
Description:N/A
OnDrawingAttribution(DrawingAttributionLayerEventArgs)
Return Value
Type:Void
Description:N/A
Parameters
OnDrawnAttribution(DrawnAttributionLayerEventArgs)
Return Value
Type:Void
Description:N/A
Parameters
OnDrawingProgressChanged(DrawingProgressChangedEventArgs)
Return Value
Type:Void
Description:N/A
Parameters
Finalize()
Return Value
Type:Void
Description:N/A
Parameters
MemberwiseClone()
Return Value
Type:Object
Description:N/A
Parameters
Public Properties
HasBoundingBox
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.
The default implementation in the base class returns false.
Return Value
UsingSpatialIndex
This property gets whether the Shape File FeatureSource has an index or not.
Return Value
Encoding
This property gets and sets the encoding information for the DBF.
Return Value
ShapePathFileName
This property returns the path and filename of the Shape File you want to represent.
Return Value
IndexPathFileName
This property returns the path and filename of the index file you want to represent.
Return Value
ReadWriteMode
N/A
Return Value
RequireIndex
This property gets and sets whether an index is required when reading data. The default value is true.
Return Value
ProgressiveDrawingRecordsCount
N/A
Return Value
SimplificationAreaInPixel
N/A
Return Value
WrappingExtent
N/A
Return Value
WrappingMode
N/A
Return Value
EditTools
N/A
Return Value
FeatureIdsToExclude
N/A
Return Value
QueryTools
N/A
Return Value
MaxRecordsToDraw
N/A
Return Value
FeatureSource
N/A
Return Value
DrawingQuality
N/A
Return Value
ZoomLevelSet
N/A
Return Value
DrawingMarginPercentage
N/A
Return Value
DrawingMarginInPixel
N/A
Return Value
GeometryValidationMode
N/A
Return Value
RequestDrawingInterval
N/A
Return Value
IsOpen
N/A
Return Value
DrawingTime
N/A
Return Value
Name
N/A
Return Value
Attribution
N/A
Return Value
IsVisible
N/A
Return Value
Transparency
N/A
Return Value
BlueTranslation
N/A
Return Value
RedTranslation
N/A
Return Value
GreenTranslation
N/A
Return Value
KeyColors
N/A
Return Value
IsNegative
N/A
Return Value
IsGrayscale
N/A
Return Value
DrawingExceptionMode
N/A
Return Value
Protected Properties
FetchedCount
N/A
Return Value
FetchedBytes
N/A
Return Value
StyleTime
N/A
Return Value
FetchTime
N/A
Return Value
IsOpenCore
N/A
Return Value
Public Events
StreamLoading
This event allows you to pass in your own stream to represent the files.
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