User Tools

Site Tools


thinkgeo.mapsuite.core.shapefilefeaturelayer

This is an old revision of the document!


Table of Contents

ThinkGeo.MapSuite.Core.ShapeFileFeatureLayer

This class represents a Layer backed by a Shape File.

Inheritance Hierarchy

  • System.Object
    • ThinkGeo.MapSuite.Core.Layer
      • ThinkGeo.MapSuite.Core.FeatureLayer
        • ThinkGeo.MapSuite.Core.ShapeFileFeatureLayer

Members Summary

Public Constructors

ShapeFileFeatureLayer

  • Parameters:N/A
  • DeclaringType:N/A
  • Summary:This is a constructor for the class.

ShapeFileFeatureLayer

  • Parameters:String
  • DeclaringType:N/A
  • Summary:This is a constructor for the class.

ShapeFileFeatureLayer

ShapeFileFeatureLayer

  • Parameters:String,String
  • DeclaringType:N/A
  • Summary:This is a constructor for the class.

ShapeFileFeatureLayer

  • Parameters:String,String,ShapeFileReadWriteMode
  • DeclaringType:N/A
  • Summary:This is a constructor for the class.

ShapeFileFeatureLayer

  • Parameters:String,String,ShapeFileReadWriteMode,Encoding
  • DeclaringType:N/A
  • Summary:This is a constructor for the class.

Protected Constructors

Public Methods

BuildIndexFile

  • Parameters:String,String,Projection,String,String,BuildIndexMode
  • DeclaringType:N/A
  • Summary:This method builds a spatial index only for those features that satisfy a regular expression, based on a passed-in projection.

BuildIndexFile

  • Parameters:String,String,BuildIndexMode
  • DeclaringType:N/A
  • Summary:This method build a spatial index for the shape file which increases accessspeed.

BuildIndexFile

  • Parameters:IEnumerable<Feature>,String,Projection
  • DeclaringType:N/A
  • Summary:This method builds a spatial index for the specified group of features and target projection.

BuildIndexFile

  • Parameters:String
  • DeclaringType:N/A
  • Summary:This method builds a spatial index for the layer.

BuildIndexFile

  • Parameters:IEnumerable<Feature>,String,BuildIndexMode
  • DeclaringType:N/A
  • Summary:This method builds a spatial index for the specified group of features.

BuildIndexFile

  • Parameters:IEnumerable<Feature>,String,Projection,BuildIndexMode
  • DeclaringType:N/A
  • Summary:This method builds a spatial index for the specified group of features.

BuildIndexFile

  • Parameters:String,String,String,String,BuildIndexMode
  • DeclaringType:N/A
  • Summary:This method builds a spatial index only for those features that satisfy a regular expression.

BuildIndexFile

  • Parameters:String,BuildIndexMode
  • DeclaringType:N/A
  • Summary:This method builds a spatial index for the layer.

BuildIndexFile

  • Parameters:IEnumerable<Feature>,String
  • DeclaringType:N/A
  • Summary:This method builds a spatial index for the specified group of features.

BuildIndexFile

  • Parameters:String,String,Projection,String,String,BuildIndexMode,Encoding
  • DeclaringType:N/A
  • Summary:This method builds a spatial index only for those features that satisfy a regular expression, based on a passed-in projection.

BuildRecordIdColumn

  • Parameters:String,String,BuildRecordIdMode
  • DeclaringType:N/A
  • Summary:Static API used to build RecordId. The Id will start from 0.

BuildRecordIdColumn

  • Parameters:String,String,BuildRecordIdMode,Int32
  • DeclaringType:N/A
  • Summary:Static API used to build RecordId from the specified starting Id number.

BuildRecordIdColumn

  • Parameters:String,String,BuildRecordIdMode,Int32,Encoding
  • DeclaringType:N/A
  • Summary:Static API used to build RecordId from the specified starting Id number.

CloneDeep

  • Parameters:N/A
  • DeclaringType:Layer
  • Summary:N/A

CloneShapeFileStructure

  • Parameters:String,String
  • DeclaringType:N/A
  • 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.

CloneShapeFileStructure

  • Parameters:String,String,OverwriteMode
  • DeclaringType:N/A
  • 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.

CloneShapeFileStructure

  • Parameters:String,String,OverwriteMode,Encoding
  • DeclaringType:N/A
  • 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.

Close

  • Parameters:N/A
  • DeclaringType:Layer
  • Summary:N/A

CreateShapeFile

  • Parameters:ShapeFileType,String,IEnumerable<DbfColumn>
  • DeclaringType:N/A
  • Summary:Static API to create a new Shape File.

CreateShapeFile

CreateShapeFile

  • Parameters:ShapeFileType,String,IEnumerable<DbfColumn>,Encoding
  • DeclaringType:N/A
  • Summary:Static API to create a new Shape File.

Draw

Equals

  • Parameters:Object
  • DeclaringType:Object
  • Summary:N/A

GetBoundingBox

  • Parameters:N/A
  • DeclaringType:Layer
  • Summary:N/A

GetHashCode

  • Parameters:N/A
  • DeclaringType:Object
  • Summary:N/A

GetShapeFileType

  • Parameters:N/A
  • DeclaringType:N/A
  • Summary:Get the Shape File type for the Shape File FeatureSource.

GetThreadSafetyLevel

  • Parameters:N/A
  • DeclaringType:Layer
  • Summary:N/A

GetType

  • Parameters:N/A
  • DeclaringType:Object
  • Summary:N/A

GetValidColumnNames

  • Parameters:IEnumerable<String>,Encoding
  • DeclaringType:N/A
  • Summary:N/A

GetValidColumnNames

  • Parameters:IEnumerable<String>
  • DeclaringType:N/A
  • Summary:N/A

GetValidColumns

  • Parameters:IEnumerable<DbfColumn>,Encoding
  • DeclaringType:N/A
  • Summary:N/A

GetValidColumns

  • Parameters:IEnumerable<DbfColumn>
  • DeclaringType:N/A
  • Summary:N/A

Open

  • Parameters:N/A
  • DeclaringType:Layer
  • Summary:N/A

Rebuild

Rebuild

  • Parameters:String
  • DeclaringType:N/A
  • Summary:This method rebuilds the SHP, SHX, DBF, IDX and IDS files for the given shape file.

RequestDrawing

RequestDrawing

RequestDrawing

RequestDrawing

  • Parameters:TimeSpan
  • DeclaringType:Layer
  • Summary:N/A

RequestDrawing

RequestDrawing

RequestDrawing

  • Parameters:N/A
  • DeclaringType:Layer
  • Summary:N/A

RequestDrawing

RequestDrawing

SaveToProjection

  • Parameters:String,String,Projection,OverwriteMode
  • DeclaringType:N/A
  • Summary:This API provide a easy way to project features in a shape file into another projection and save it to shape file.

ToString

  • Parameters:N/A
  • DeclaringType:Object
  • Summary:N/A

Validate

  • Parameters:N/A
  • DeclaringType:N/A
  • Summary:This method checks all features in a shapefile is supported by Mapsuite or not.

Protected Methods

1BU=

  • Parameters:IEnumerable<String>
  • DeclaringType:FeatureLayer
  • Summary:N/A

1xU=

CloneDeepCore

  • Parameters:N/A
  • DeclaringType:N/A
  • Summary:N/A

CloseCore

DrawAttributionCore

DrawCore

DrawException

DrawExceptionCore

Finalize

  • Parameters:N/A
  • DeclaringType:Object
  • Summary:N/A

GetBoundingBoxCore

GetThreadSafetyLevelCore

  • Parameters:N/A
  • DeclaringType:Layer
  • Summary:N/A

MemberwiseClone

  • Parameters:N/A
  • DeclaringType:Object
  • Summary:N/A

OnDrawingAttribution

OnDrawingException

OnDrawingFeatures

OnDrawingProgressChanged

OnDrawnAttribution

OnDrawnException

OnRequestedDrawing

OnRequestingDrawing

OpenCore

SetupTools

SetupToolsCore

Public Properties

Attribution

  • Return:String
  • Summary:N/A

BlueTranslation

  • Return:Single
  • Summary:N/A

DrawingExceptionMode

DrawingMarginInPixel

  • Return:Single
  • Summary:N/A

DrawingMarginPercentage

  • Return:Double
  • Summary:N/A

DrawingQuality

DrawingTime

  • Return:TimeSpan
  • Summary:N/A

EditTools

Encoding

  • Return:Encoding
  • Summary:This property gets and sets the encoding information for the DBF.

FeatureIdsToExclude

  • Return:Collection<String>
  • Summary:N/A

FeatureSource

GeometryValidationMode

GreenTranslation

  • Return:Single
  • Summary:N/A

HasBoundingBox

  • Return:Boolean
  • 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.

IndexPathFileName

  • Return:String
  • Summary:This property returns the path and filename of the index file you want to represent.

IsGrayscale

  • Return:Boolean
  • Summary:N/A

IsNegative

  • Return:Boolean
  • Summary:N/A

IsOpen

  • Return:Boolean
  • Summary:N/A

IsVisible

  • Return:Boolean
  • Summary:N/A

KeyColors

  • Return:Collection<GeoColor>
  • Summary:N/A

MaxRecordsToDraw

  • Return:Int32
  • Summary:N/A

Name

  • Return:String
  • Summary:N/A

ProgressiveDrawingRecordsCount

  • Return:Int32
  • Summary:N/A

QueryTools

ReadWriteMode

RedTranslation

  • Return:Single
  • Summary:N/A

RequestDrawingInterval

  • Return:TimeSpan
  • Summary:N/A

RequireIndex

  • Return:Boolean
  • Summary:This property gets and sets whether an index is required when reading data. The default value is true.

ShapePathFileName

  • Return:String
  • Summary:This property returns the path and filename of the Shape File you want to represent.

SimplificationAreaInPixel

  • Return:Int32
  • Summary:N/A

Transparency

  • Return:Single
  • Summary:N/A

UsingSpatialIndex

  • Return:Boolean
  • Summary:This property gets whether the Shape File FeatureSource has an index or not.

WrappingExtent

WrappingMode

ZoomLevelSet

Protected Properties

0BU=

  • Return:TimeSpan
  • Summary:N/A

0xU=

  • Return:TimeSpan
  • Summary:N/A

IsOpenCore

  • Return:Boolean
  • Summary:N/A

yhU=

  • Return:Int64
  • Summary:N/A

zRU=

  • Return:Int64
  • Summary:N/A

Public Events

DrawingAttribution

DrawingException

DrawingFeatures

DrawingProgressChanged

DrawingWrappingFeatures

DrawnAttribution

DrawnException

RequestedDrawing

RequestingDrawing

StreamLoading

  • Event Arguments:StreamLoadingEventArgs
  • Summary:This event allows you to pass in your own stream to represent the files.

Public Constructors

ShapeFileFeatureLayer()

This is a constructor for the class.

Remarks

This is the default constructor. If you use this constructor, then you should set the required methods manually.

Parameters

ShapeFileFeatureLayer(String)

This is a constructor for the class.

Remarks

None

Parameters

shapePathFilename

  • Type:String
  • Description:This parameter is the Shape File path and filename. Go Back === ShapeFileFeatureLayer(String,ShapeFileReadWriteMode) === This is a constructor for the class. ==== Remarks ==== None ==== Parameters ==== shapePathFilename * Type:String * Description:This parameter is the Shape File path and filename.

readWriteMode

  • Description:This parameter specifies whether the file will be opened in read-only or read/write mode. Go Back === ShapeFileFeatureLayer(String,String) === This is a constructor for the class. ==== Remarks ==== None ==== Parameters ==== shapePathFilename * Type:String * Description:This parameter is the Shape File path and filename.

indexPathFilename

  • Type:String
  • Description:This parameter is the index file path and filename. Go Back === ShapeFileFeatureLayer(String,String,ShapeFileReadWriteMode) === This is a constructor for the class. ==== Remarks ==== None ==== Parameters ==== shapePathFilename * Type:String * Description:This parameter is the Shape File path and filename.

indexPathFilename

  • Type:String
  • Description:This parameter is the index file path and filename. readWriteMode * Type:ShapeFileReadWriteMode * Description:This parameter specifies whether the file will be opened in read-only or read/write mode.

Go Back

ShapeFileFeatureLayer(String,String,ShapeFileReadWriteMode,Encoding)

This is a constructor for the class.

Remarks

None

Parameters

shapePathFilename

  • Type:String
  • Description:This parameter is the Shape File path and filename. indexPathFilename * Type:String * Description:This parameter is the index file path and filename.

readWriteMode

  • Description:This parameter specifies whether the file will be opened in read-only or read/write mode. encoding * Type:Encoding * Description:This parameter specifies the encoding of the data.

Go Back

Protected Constructors

Public Methods

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

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

  • Return Type:Void
  • Description:None

Parameters

shapePathFilename

  • Type:String
  • Description:This parameter specifies the Shape File for which to build the index.

indexPathFilename

  • Type:String
  • Description:This parameter determines the target index path filename.

projection

  • Description:This parameter determines the projection that will be used to build the index against those features that satisfy the regular expression.

columnName

  • Type:String
  • Description:This parameter determines the column name whose values will be tested against the regular expression.

regularExpression

  • Type:String
  • Description:This parameter represents the regular expression to test against each feature for inclusion in the index.

buildIndexMode

  • Description:This parameter determines whether an index file will be rebuilt if it already exists.

Go Back

BuildIndexFile(String,String,BuildIndexMode)

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

  • Return Type:Void
  • Description:None

Parameters

shapePathFilename

  • Type:String
  • Description:This parameter is the shape file name and path that you want to build an index for.

indexPathFilename

  • Type:String
  • Description:This parameter specifies the index file name.

buildIndexMode

  • Description:This parameter determines what will happen if there is an existing index file.

Go Back

BuildIndexFile(IEnumerable<Feature>,String,Projection)

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

  • Return Type:Void
  • Description:None

Parameters

features

  • Type:IEnumerable<Feature>
  • Description:This parameter specifies the features for which to build the index.

indexPathFilename

  • Type:String
  • Description:This parameter specifies the target index path and filename.

projection

  • Description:This parameter specifies the projection to build index against those features.

Go Back

BuildIndexFile(String)

This method builds a spatial index for the layer.

Remarks

This overload allows you to pass in the Shape File.

Return Value

  • Return Type:Void
  • Description:None

Parameters

pathFilename

  • Type:String
  • Description:The path and filename to the Shape File.

Go Back

BuildIndexFile(IEnumerable<Feature>,String,BuildIndexMode)

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

  • Return Type:Void
  • Description:None

Parameters

features

  • Type:IEnumerable<Feature>
  • Description:This parameter specifies the features for which to build the index.

indexPathFilename

  • Type:String
  • Description:This parameter determines the target index path filename.

buildIndexMode

  • Description:This parameter determines whether an index file will be rebuilt if it already exists.

Go Back

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

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

  • Return Type:Void
  • Description:None

Parameters

features

  • Type:IEnumerable<Feature>
  • Description:This parameter specifies the features for which to build the index.

indexPathFilename

  • Type:String
  • Description:This parameter determines the target index path filename.

projection

  • Description:This parameter determines the Projection to build index against those features.

buildIndexMode

  • Description:This parameter determines whether an index file will be rebuilt if it already exists.

Go Back

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

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

  • Return Type:Void
  • Description:None

Parameters

shapePathFilename

  • Type:String
  • Description:This parameter specifies the Shape File for which to build the index.

indexPathFilename

  • Type:String
  • Description:This parameter determines the target index path filename.

columnName

  • Type:String
  • Description:This parameter determines the column name whose values will be tested against the regular expression.

regularExpression

  • Type:String
  • Description:This parameter represents the regular expression to test against each feature for inclusion in the index.

buildIndexMode

  • Description:This parameter determines whether an index file will be rebuilt if it already exists.

Go Back

BuildIndexFile(String,BuildIndexMode)

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

  • Return Type:Void
  • Description:None

Parameters

pathFilename

  • Type:String
  • Description:This parameter is the matching pattern that defines which Shape Files to include.

rebuildExistingIndexMode

  • Description:This parameter determines whether an index file will be rebuilt if it already exists.

Go Back

BuildIndexFile(IEnumerable<Feature>,String)

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

  • Return Type:Void
  • Description:None

Parameters

features

  • Type:IEnumerable<Feature>
  • Description:This parameter specifies the features for which to build the index.

indexPathFilename

  • Type:String
  • Description:This parameter specifies the target index path and filename.

Go Back

BuildIndexFile(String,String,Projection,String,String,BuildIndexMode,Encoding)

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

  • Return Type:Void
  • Description:None

Parameters

shapePathFilename

  • Type:String
  • Description:This parameter specifies the Shape File for which to build the index.

indexPathFilename

  • Type:String
  • Description:This parameter determines the target index path filename.

projection

  • Description:This parameter determines the projection that will be used to build the index against those features that satisfy the regular expression.

columnName

  • Type:String
  • Description:This parameter determines the column name whose values will be tested against the regular expression.

regularExpression

  • Type:String
  • Description:This parameter represents the regular expression to test against each feature for inclusion in the index.

buildIndexMode

  • Description:This parameter determines whether an index file will be rebuilt if it already exists.

encoding

  • Type:Encoding
  • Description:This parameter specifies the encoding information used in the source DBF file.

Go Back

BuildRecordIdColumn(String,String,BuildRecordIdMode)

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

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

shapeFilename

  • Type:String
  • Description:The name of the target ShapeFile on which to base the newly built RecordId.

fieldname

  • Type:String
  • Description:The field name for the RecordId.

rebuildNeeded

Go Back

BuildRecordIdColumn(String,String,BuildRecordIdMode,Int32)

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

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

shapeFilename

  • Type:String
  • Description:The name of the target ShapeFile on which to base the newly built RecordId.

fieldname

  • Type:String
  • Description:The field name for the RecordId.

rebuildNeeded

startNumber

  • Type:Int32
  • Description:The starting Id number of the RecordId.

Go Back

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

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

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

shapeFilename

  • Type:String
  • Description:The name of the target ShapeFile on which to base the newly built RecordId.

fieldname

  • Type:String
  • Description:The field name for the RecordId.

rebuildNeeded

startNumber

  • Type:Int32
  • Description:The starting Id number of the RecordId.

encoding

  • Type:Encoding
  • Description:This parameter specifies the encoding information in the DBF.

Go Back

CloneDeep()

N/A

Remarks

N/A

Return Value

  • Return Type:Layer
  • Description:N/A

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.

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

sourceShapePathFilename

  • Type:String
  • Description:The source Shape File to be cloned.

targetShapePathFilename

  • Type:String
  • Description:The target Shape File, which will have the same structure as the source Shape File after cloning operation is complete.

Go Back

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.

Remarks

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

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

sourceShapePathFilename

  • Type:String
  • Description:The source Shape File to be cloned.

targetShapePathFilename

  • Type:String
  • Description:The target Shape File, which will have the same structure as the source Shape File after cloning operation is complete.

overwriteMode

  • Description:This parameter specifies the overwrite mode when the target ShapeFile already exists.

Go Back

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.

Remarks

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

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

sourceShapePathFilename

  • Type:String
  • Description:The source Shape File to be cloned.

targetShapePathFilename

  • Type:String
  • Description:The target Shape File, which will have the same structure as the source Shape File after cloning operation is complete.

overwriteMode

  • Description:This parameter specifies the overwrite mode when the target ShapeFile already exists.

encoding

  • Type:Encoding
  • Description:This parameter specifies the encoding information in the source Shape File.

Go Back

Close()

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

CreateShapeFile(ShapeFileType,String,IEnumerable<DbfColumn>)

Static API to create a new Shape File.

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

shapeType

  • Description:This parameter specifies the the Shape File type for the target Shape File.

pathFilename

  • Type:String
  • Description:This parameter specifies the Shape filename for the target Shape File.

databaseColumns

  • Type:IEnumerable<DbfColumn>
  • Description:This parameter specifies the DBF column information for the target Shape File.

Go Back

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

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

  • Return Type:Void
  • Description:N/A

Parameters

shapeType

  • Description:This parameter specifies the the Shape File type for the target Shape File.

pathFilename

  • Type:String
  • Description:This parameter specifies the Shape filename for the target Shape File.

databaseColumns

  • Type:IEnumerable<DbfColumn>
  • Description:This parameter specifies the DBF column information for the target Shape File.

encoding

  • Type:Encoding
  • Description:This parameter specifies the DBF encoding infromation for the target Shape File.

overwriteMode

  • Description:This parameter specifies the override mode when the target Shape File exists.

Go Back

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

Static API to create a new Shape File.

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

shapeType

  • Description:This parameter specifies the the Shape File type for the target Shape File.

pathFilename

  • Type:String
  • Description:This parameter specifies the Shape filename for the target Shape File.

databaseColumns

  • Type:IEnumerable<DbfColumn>
  • Description:This parameter specifies the DBF column information for the target Shape File.

encoding

  • Type:Encoding
  • Description:This parameter specifies the DBF encoding infromation for the target Shape File.

Go Back

Draw(GeoCanvas,Collection<SimpleCandidate>)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

canvas

labelsInAllLayers

Go Back

Equals(Object)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

obj

  • Type:Object
  • Description:N/A

Go Back

GetBoundingBox()

N/A

Remarks

N/A

Return Value

Parameters

GetHashCode()

N/A

Remarks

N/A

Return Value

  • Return Type:Int32
  • Description:N/A

Parameters

GetShapeFileType()

Get the Shape File type for the Shape File FeatureSource.

Remarks

N/A

Return Value

  • Return Type:ShapeFileType
  • Description:The ShapeFileType for the ShapeFile FeatureSource.

Parameters

GetThreadSafetyLevel()

N/A

Remarks

N/A

Return Value

Parameters

GetType()

N/A

Remarks

N/A

Return Value

  • Return Type:Type
  • Description:N/A

Parameters

GetValidColumnNames(IEnumerable<String>,Encoding)

N/A

Remarks

N/A

Return Value

  • Return Type:Collection<String>
  • Description:N/A

Parameters

columnNames

  • Type:IEnumerable<String>
  • Description:N/A

encoding

  • Type:Encoding
  • Description:N/A

Go Back

GetValidColumnNames(IEnumerable<String>)

N/A

Remarks

N/A

Return Value

  • Return Type:Collection<String>
  • Description:N/A

Parameters

columnNames

  • Type:IEnumerable<String>
  • Description:N/A

Go Back

GetValidColumns(IEnumerable<DbfColumn>,Encoding)

N/A

Remarks

N/A

Return Value

  • Return Type:Collection<DbfColumn>
  • Description:N/A

Parameters

columns

  • Type:IEnumerable<DbfColumn>
  • Description:N/A

encoding

  • Type:Encoding
  • Description:N/A

Go Back

GetValidColumns(IEnumerable<DbfColumn>)

N/A

Remarks

N/A

Return Value

  • Return Type:Collection<DbfColumn>
  • Description:N/A

Parameters

columns

  • Type:IEnumerable<DbfColumn>
  • Description:N/A

Go Back

Open()

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

Rebuild(String,ShapeFileSortingMode,Int32)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

shapePathFilename

  • Type:String
  • Description:N/A

sortingMode

sridForSorting

  • Type:Int32
  • Description:N/A

Go Back

Rebuild(String)

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

  • Return Type:Void
  • Description:None

Parameters

shapePathFilename

  • Type:String
  • Description:This parameter is the shape file you want to rebuild.

Go Back

RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

extentToRefresh

bufferTime

  • Type:TimeSpan
  • Description:N/A

bufferTimeType

Go Back

RequestDrawing(RectangleShape,TimeSpan)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

extentToRefresh

bufferTime

  • Type:TimeSpan
  • Description:N/A

Go Back

RequestDrawing(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

extentsToRefresh

bufferTime

  • Type:TimeSpan
  • Description:N/A

bufferTimeType

Go Back

RequestDrawing(TimeSpan)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

bufferTime

  • Type:TimeSpan
  • Description:N/A

Go Back

RequestDrawing(IEnumerable<RectangleShape>)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

extentsToRefresh

Go Back

RequestDrawing(RectangleShape)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

extentToRefresh

Go Back

RequestDrawing()

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

RequestDrawing(IEnumerable<RectangleShape>,TimeSpan)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

extentsToRefresh

bufferTime

  • Type:TimeSpan
  • Description:N/A

Go Back

RequestDrawing(TimeSpan,RequestDrawingBufferTimeType)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

bufferTime

  • Type:TimeSpan
  • Description:N/A

bufferTimeType

Go Back

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.

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

sourceShapeFile

  • Type:String
  • Description:This parameter specifies the source shape file to be projected.

targetShapeFile

  • Type:String
  • Description:This parameter specifies the target shape file to be saved for the projected features.

projection

  • Description: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

  • Description:This parameter specifies the override mode when the target shape file exists.

Go Back

ToString()

N/A

Remarks

N/A

Return Value

  • Return Type:String
  • Description:N/A

Parameters

Validate()

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

Remarks

N/A

Return Value

  • Return 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

Protected Methods

1BU=(IEnumerable<String>)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

returningColumnNames

  • Type:IEnumerable<String>
  • Description:N/A

Go Back

1xU=(GeoCanvas,Dictionary<String,Collection<Feature>>,Collection<SimpleCandidate>,ZoomLevel,RectangleShape)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

canvas

featuresForFilters

  • Type:Dictionary<String,Collection<Feature»
  • Description:N/A

labelsInAllLayers

currentZoomLevel

marginWorldExtent

Go Back

CloneDeepCore()

N/A

Remarks

N/A

Return Value

  • Return Type:Layer
  • Description:N/A

Parameters

CloseCore()

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

DrawAttributionCore(GeoCanvas,String)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

canvas

attribution

  • Type:String
  • Description:N/A

Go Back

DrawCore(GeoCanvas,Collection<SimpleCandidate>)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

canvas

labelsInAllLayers

Go Back

DrawException(GeoCanvas,Exception)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

canvas

e

  • Type:Exception
  • Description:N/A

Go Back

DrawExceptionCore(GeoCanvas,Exception)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

canvas

e

  • Type:Exception
  • Description:N/A

Go Back

Finalize()

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

GetBoundingBoxCore()

N/A

Remarks

N/A

Return Value

Parameters

GetThreadSafetyLevelCore()

N/A

Remarks

N/A

Return Value

Parameters

MemberwiseClone()

N/A

Remarks

N/A

Return Value

  • Return Type:Object
  • Description:N/A

Parameters

OnDrawingAttribution(DrawingAttributionLayerEventArgs)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

args

Go Back

OnDrawingException(DrawingExceptionLayerEventArgs)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

e

Go Back

OnDrawingFeatures(DrawingFeaturesEventArgs)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

e

Go Back

OnDrawingProgressChanged(DrawingProgressChangedEventArgs)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

e

Go Back

OnDrawingWrappingFeatures(DrawingWrappingFeaturesFeatureLayerEventArgs)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

OnDrawnAttribution(DrawnAttributionLayerEventArgs)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

args

Go Back

OnDrawnException(DrawnExceptionLayerEventArgs)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

e

Go Back

OnRequestedDrawing(RequestedDrawingLayerEventArgs)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

eventArgs

Go Back

OnRequestingDrawing(RequestingDrawingLayerEventArgs)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

eventArgs

Go Back

OpenCore()

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

SetupTools()

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

SetupToolsCore()

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

Public Properties

Attribution

N/A

Remarks

N/A

Return Value

Return Type:String

Go Back

BlueTranslation

N/A

Remarks

N/A

Return Value

Return Type:Single

Go Back

DrawingExceptionMode

N/A

Remarks

N/A

Return Value

DrawingMarginInPixel

N/A

Remarks

N/A

Return Value

Return Type:Single

Go Back

DrawingMarginPercentage

N/A

Remarks

N/A

Return Value

Return Type:Double

Go Back

DrawingQuality

N/A

Remarks

N/A

Return Value

Return Type:DrawingQuality

Go Back

DrawingTime

N/A

Remarks

N/A

Return Value

Return Type:TimeSpan

Go Back

EditTools

N/A

Remarks

N/A

Return Value

Return Type:EditTools

Go Back

Encoding

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

Remarks

N/A

Return Value

Return Type:Encoding

Go Back

FeatureIdsToExclude

N/A

Remarks

N/A

Return Value

Return Type:Collection<String>

Go Back

FeatureSource

N/A

Remarks

N/A

Return Value

Return Type:FeatureSource

Go Back

GeometryValidationMode

N/A

Remarks

N/A

Return Value

GreenTranslation

N/A

Remarks

N/A

Return Value

Return Type:Single

Go Back

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.

Remarks

The default implementation in the base class returns false.

Return Value

Return Type:Boolean

Go Back

IndexPathFileName

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

Remarks

None

Return Value

Return Type:String

Go Back

IsGrayscale

N/A

Remarks

N/A

Return Value

Return Type:Boolean

Go Back

IsNegative

N/A

Remarks

N/A

Return Value

Return Type:Boolean

Go Back

IsOpen

N/A

Remarks

N/A

Return Value

Return Type:Boolean

Go Back

IsVisible

N/A

Remarks

N/A

Return Value

Return Type:Boolean

Go Back

KeyColors

N/A

Remarks

N/A

Return Value

Return Type:Collection<GeoColor>

Go Back

MaxRecordsToDraw

N/A

Remarks

N/A

Return Value

Return Type:Int32

Go Back

Name

N/A

Remarks

N/A

Return Value

Return Type:String

Go Back

ProgressiveDrawingRecordsCount

N/A

Remarks

N/A

Return Value

Return Type:Int32

Go Back

QueryTools

N/A

Remarks

N/A

Return Value

Return Type:QueryTools

Go Back

ReadWriteMode

N/A

Remarks

N/A

Return Value

RedTranslation

N/A

Remarks

N/A

Return Value

Return Type:Single

Go Back

RequestDrawingInterval

N/A

Remarks

N/A

Return Value

Return Type:TimeSpan

Go Back

RequireIndex

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

Remarks

N/A

Return Value

Return Type:Boolean

Go Back

ShapePathFileName

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

Remarks

None

Return Value

Return Type:String

Go Back

SimplificationAreaInPixel

N/A

Remarks

N/A

Return Value

Return Type:Int32

Go Back

Transparency

N/A

Remarks

N/A

Return Value

Return Type:Single

Go Back

UsingSpatialIndex

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

Remarks

N/A

Return Value

Return Type:Boolean

Go Back

WrappingExtent

N/A

Remarks

N/A

Return Value

Return Type:RectangleShape

Go Back

WrappingMode

N/A

Remarks

N/A

Return Value

Return Type:WrappingMode

Go Back

ZoomLevelSet

N/A

Remarks

N/A

Return Value

Return Type:ZoomLevelSet

Go Back

Protected Properties

0BU=

N/A

Remarks

N/A

Return Value

Return Type:TimeSpan

Go Back

0xU=

N/A

Remarks

N/A

Return Value

Return Type:TimeSpan

Go Back

IsOpenCore

N/A

Remarks

N/A

Return Value

Return Type:Boolean

Go Back

yhU=

N/A

Remarks

N/A

Return Value

Return Type:Int64

Go Back

zRU=

N/A

Remarks

N/A

Return Value

Return Type:Int64

Go Back

Public Events

DrawingAttribution

N/A

Remarks

DrawingException

N/A

Remarks

DrawingFeatures

N/A

Remarks

N/A

Event Arguments:DrawingFeaturesEventArgs

Go Back

DrawingProgressChanged

N/A

Remarks

DrawingWrappingFeatures

N/A

Remarks

DrawnAttribution

N/A

Remarks

DrawnException

N/A

Remarks

RequestedDrawing

N/A

Remarks

RequestingDrawing

N/A

Remarks

StreamLoading

This event allows you to pass in your own stream to represent the files.

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

Go Back

thinkgeo.mapsuite.core.shapefilefeaturelayer.1442486375.txt.gz · Last modified: 2015/09/17 10:39 by admin