====== ThinkGeo.MapSuite.WindowsPhoneCore.ShapeFileFeatureLayer ====== {{section>upgrade_map_suite_to_10.0}} This class represents a Layer backed by a Shape File. ===== Inheritance Hierarchy ===== *System.Object **[[ThinkGeo.MapSuite.WindowsPhoneCore.Layer]] ***[[ThinkGeo.MapSuite.WindowsPhoneCore.FeatureLayer]] ****[[ThinkGeo.MapSuite.WindowsPhoneCore.ShapeFileFeatureLayer]] ===== Members Summary ===== ==== Public Constructors ==== ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | {{wiki:PublicMethod.gif|Public Method}}[[#ShapeFileFeatureLayer()|ShapeFileFeatureLayer]] | | | This is a constructor for the class. | | {{wiki:PublicMethod.gif|Public Method}}[[#ShapeFileFeatureLayer(String)|ShapeFileFeatureLayer]] | String | | This is a constructor for the class. | | {{wiki:PublicMethod.gif|Public Method}}[[#ShapeFileFeatureLayer(String, ShapeFileReadWriteMode)|ShapeFileFeatureLayer]] | String, [[ThinkGeo.MapSuite.WindowsPhoneCore.ShapeFileReadWriteMode|ShapeFileReadWriteMode]] | | This is a constructor for the class. | | {{wiki:PublicMethod.gif|Public Method}}[[#ShapeFileFeatureLayer(String, String)|ShapeFileFeatureLayer]] | String, String | | This is a constructor for the class. | | {{wiki:PublicMethod.gif|Public Method}}[[#ShapeFileFeatureLayer(String, String, ShapeFileReadWriteMode)|ShapeFileFeatureLayer]] | String, String, [[ThinkGeo.MapSuite.WindowsPhoneCore.ShapeFileReadWriteMode|ShapeFileReadWriteMode]] | | This is a constructor for the class. | | {{wiki:PublicMethod.gif|Public Method}}[[#ShapeFileFeatureLayer(String, String, ShapeFileReadWriteMode, Encoding)|ShapeFileFeatureLayer]] | String, String, [[ThinkGeo.MapSuite.WindowsPhoneCore.ShapeFileReadWriteMode|ShapeFileReadWriteMode]], Encoding | | This is a constructor for the class. | ==== Protected Constructors ==== ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ ==== Public Methods ==== ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#BuildIndexFile(IEnumerable, String, BuildIndexMode)|BuildIndexFile]] | IEnumerable<[[ThinkGeo.MapSuite.WindowsPhoneCore.Feature|Feature]]>, String, [[ThinkGeo.MapSuite.WindowsPhoneCore.BuildIndexMode|BuildIndexMode]] | | This method builds a spatial index for the specified group of features. | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#BuildIndexFile(IEnumerable, String, Projection)|BuildIndexFile]] | IEnumerable<[[ThinkGeo.MapSuite.WindowsPhoneCore.Feature|Feature]]>, String, [[ThinkGeo.MapSuite.WindowsPhoneCore.Projection|Projection]] | | This method builds a spatial index for the specified group of features and target projection. | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#BuildIndexFile(IEnumerable, String)|BuildIndexFile]] | IEnumerable<[[ThinkGeo.MapSuite.WindowsPhoneCore.Feature|Feature]]>, String | | This method builds a spatial index for the specified group of features. | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#BuildIndexFile(String, String, Projection, String, String, BuildIndexMode)|BuildIndexFile]] | String, String, [[ThinkGeo.MapSuite.WindowsPhoneCore.Projection|Projection]], String, String, [[ThinkGeo.MapSuite.WindowsPhoneCore.BuildIndexMode|BuildIndexMode]] | | This method builds a spatial index only for those features that satisfy a regular expression, based on a passed-in projection. | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#BuildIndexFile(String, String, String, String, BuildIndexMode)|BuildIndexFile]] | String, String, String, String, [[ThinkGeo.MapSuite.WindowsPhoneCore.BuildIndexMode|BuildIndexMode]] | | This method builds a spatial index only for those features that satisfy a regular expression. | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#BuildIndexFile(IEnumerable, String, Projection, BuildIndexMode)|BuildIndexFile]] | IEnumerable<[[ThinkGeo.MapSuite.WindowsPhoneCore.Feature|Feature]]>, String, [[ThinkGeo.MapSuite.WindowsPhoneCore.Projection|Projection]], [[ThinkGeo.MapSuite.WindowsPhoneCore.BuildIndexMode|BuildIndexMode]] | | This method builds a spatial index for the specified group of features. | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#BuildIndexFile(String, BuildIndexMode)|BuildIndexFile]] | String, [[ThinkGeo.MapSuite.WindowsPhoneCore.BuildIndexMode|BuildIndexMode]] | | This method builds a spatial index for the layer. | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#BuildIndexFile(String, String, Projection, String, String, BuildIndexMode, Encoding)|BuildIndexFile]] | String, String, [[ThinkGeo.MapSuite.WindowsPhoneCore.Projection|Projection]], String, String, [[ThinkGeo.MapSuite.WindowsPhoneCore.BuildIndexMode|BuildIndexMode]], Encoding | | This method builds a spatial index only for those features that satisfy a regular expression, based on a passed-in projection. | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#BuildIndexFile(String)|BuildIndexFile]] | String | | This method builds a spatial index for the layer. | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#BuildIndexFile(String, String, BuildIndexMode)|BuildIndexFile]] | String, String, [[ThinkGeo.MapSuite.WindowsPhoneCore.BuildIndexMode|BuildIndexMode]] | | This method build a spatial index for the shape file which increases accessspeed. | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#BuildRecordIdColumn(String, String, BuildRecordIdMode, Int32)|BuildRecordIdColumn]] | String, String, [[ThinkGeo.MapSuite.WindowsPhoneCore.BuildRecordIdMode|BuildRecordIdMode]], Int32 | | Static API used to build RecordId from the specified starting Id number. | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#BuildRecordIdColumn(String, String, BuildRecordIdMode, Int32, Encoding)|BuildRecordIdColumn]] | String, String, [[ThinkGeo.MapSuite.WindowsPhoneCore.BuildRecordIdMode|BuildRecordIdMode]], Int32, Encoding | | Static API used to build RecordId from the specified starting Id number. | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#BuildRecordIdColumn(String, String, BuildRecordIdMode)|BuildRecordIdColumn]] | String, String, [[ThinkGeo.MapSuite.WindowsPhoneCore.BuildRecordIdMode|BuildRecordIdMode]] | | Static API used to build RecordId. The Id will start from 0. | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#CloneShapeFileStructure(String, String, OverwriteMode, Encoding)|CloneShapeFileStructure]] | String, String, [[ThinkGeo.MapSuite.WindowsPhoneCore.OverwriteMode|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. | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#CloneShapeFileStructure(String, String)|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. | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#CloneShapeFileStructure(String, String, OverwriteMode)|CloneShapeFileStructure]] | String, String, [[ThinkGeo.MapSuite.WindowsPhoneCore.OverwriteMode|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. | | {{wiki:PublicMethod.gif|Public Method}}[[#Close()|Close]] | | [[ThinkGeo.MapSuite.WindowsPhoneCore.Layer|Layer]] | This method closes the Layer and releases any resources it was using. | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#CreateShapeFile(ShapeFileType, String, IEnumerable, Encoding, OverwriteMode)|CreateShapeFile]] | [[ThinkGeo.MapSuite.WindowsPhoneCore.ShapeFileType|ShapeFileType]], String, IEnumerable<[[ThinkGeo.MapSuite.WindowsPhoneCore.DbfColumn|DbfColumn]]>, Encoding, [[ThinkGeo.MapSuite.WindowsPhoneCore.OverwriteMode|OverwriteMode]] | | Static API to create a new Shape File. | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#CreateShapeFile(ShapeFileType, String, IEnumerable)|CreateShapeFile]] | [[ThinkGeo.MapSuite.WindowsPhoneCore.ShapeFileType|ShapeFileType]], String, IEnumerable<[[ThinkGeo.MapSuite.WindowsPhoneCore.DbfColumn|DbfColumn]]> | | Static API to create a new Shape File. | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#CreateShapeFile(ShapeFileType, String, IEnumerable, Encoding)|CreateShapeFile]] | [[ThinkGeo.MapSuite.WindowsPhoneCore.ShapeFileType|ShapeFileType]], String, IEnumerable<[[ThinkGeo.MapSuite.WindowsPhoneCore.DbfColumn|DbfColumn]]>, Encoding | | Static API to create a new Shape File. | | {{wiki:PublicMethod.gif|Public Method}}[[#Draw(GeoCanvas, Collection)|Draw]] | [[ThinkGeo.MapSuite.WindowsPhoneCore.GeoCanvas|GeoCanvas]], Collection<[[ThinkGeo.MapSuite.WindowsPhoneCore.SimpleCandidate|SimpleCandidate]]> | [[ThinkGeo.MapSuite.WindowsPhoneCore.Layer|Layer]] | This method draws the Layer. | | {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]] | Object | Object | | | {{wiki:PublicMethod.gif|Public Method}}[[#GetBoundingBox()|GetBoundingBox]] | | [[ThinkGeo.MapSuite.WindowsPhoneCore.Layer|Layer]] | This method returns the bounding box of the Layer. | | {{wiki:PublicMethod.gif|Public Method}}[[#GetDataFromDbf(String)|GetDataFromDbf]] | String | | | | {{wiki:PublicMethod.gif|Public Method}}[[#GetDataFromDbf(String, String)|GetDataFromDbf]] | String, String | | | | {{wiki:PublicMethod.gif|Public Method}}[[#GetDataFromDbf(String, IEnumerable)|GetDataFromDbf]] | String, IEnumerable | | | | {{wiki:PublicMethod.gif|Public Method}}[[#GetDataFromDbf(IEnumerable, String)|GetDataFromDbf]] | IEnumerable, String | | | | {{wiki:PublicMethod.gif|Public Method}}[[#GetDataFromDbf(IEnumerable)|GetDataFromDbf]] | IEnumerable | | | | {{wiki:PublicMethod.gif|Public Method}}[[#GetDataFromDbf(IEnumerable, IEnumerable)|GetDataFromDbf]] | IEnumerable, IEnumerable | | | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object | | | {{wiki:PublicMethod.gif|Public Method}}[[#GetShapeFileType()|GetShapeFileType]] | | | Get the Shape File type for the Shape File FeatureSource. | | {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]] | | Object | | | {{wiki:PublicMethod.gif|Public Method}}[[#Open()|Open]] | | [[ThinkGeo.MapSuite.WindowsPhoneCore.Layer|Layer]] | This method opens the Layer so that it is initialized and ready to use. | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#Rebuild(String)|Rebuild]] | String | | This method rebuilds the SHP, SHX, DBF, IDX and IDS files for the given shape file. | | {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#SaveToProjection(String, String, Projection, OverwriteMode)|SaveToProjection]] | String, String, [[ThinkGeo.MapSuite.WindowsPhoneCore.Projection|Projection]], [[ThinkGeo.MapSuite.WindowsPhoneCore.OverwriteMode|OverwriteMode]] | | This API provide a easy way to project features in a shape file into another projection and save it to shape file. | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object | | | {{wiki:PublicMethod.gif|Public Method}}[[#UpdateDbfData(String, IEnumerable, IEnumerable)|UpdateDbfData]] | String, IEnumerable, IEnumerable | | | | {{wiki:PublicMethod.gif|Public Method}}[[#UpdateDbfData(String, String, String)|UpdateDbfData]] | String, String, String | | | | {{wiki:PublicMethod.gif|Public Method}}[[#Validate()|Validate]] | | | This method checks all features in a shapefile is supported by Mapsuite or not. | ==== Protected Methods ==== ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | {{wiki:ProtectedMethod.gif|Protected Method}}[[#CloseCore()|CloseCore]] | | [[ThinkGeo.MapSuite.WindowsPhoneCore.Layer|Layer]](overriden) | | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawCore(GeoCanvas, Collection)|DrawCore]] | [[ThinkGeo.MapSuite.WindowsPhoneCore.GeoCanvas|GeoCanvas]], Collection<[[ThinkGeo.MapSuite.WindowsPhoneCore.SimpleCandidate|SimpleCandidate]]> | [[ThinkGeo.MapSuite.WindowsPhoneCore.Layer|Layer]](overriden) | | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawException(GeoCanvas, Exception)|DrawException]] | [[ThinkGeo.MapSuite.WindowsPhoneCore.GeoCanvas|GeoCanvas]], Exception | [[ThinkGeo.MapSuite.WindowsPhoneCore.Layer|Layer]] | This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException. | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawExceptionCore(GeoCanvas, Exception)|DrawExceptionCore]] | [[ThinkGeo.MapSuite.WindowsPhoneCore.GeoCanvas|GeoCanvas]], Exception | [[ThinkGeo.MapSuite.WindowsPhoneCore.Layer|Layer]] | This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException. | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetBoundingBoxCore()|GetBoundingBoxCore]] | | [[ThinkGeo.MapSuite.WindowsPhoneCore.Layer|Layer]](overriden) | | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawingFeatures(DrawingFeaturesEventArgs)|OnDrawingFeatures]] | [[ThinkGeo.MapSuite.WindowsPhoneCore.DrawingFeaturesEventArgs|DrawingFeaturesEventArgs]] | [[ThinkGeo.MapSuite.WindowsPhoneCore.FeatureLayer|FeatureLayer]] | This method raises the DrawingFeatures event. | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawingProgressChanged(DrawingProgressChangedEventArgs)|OnDrawingProgressChanged]] | [[ThinkGeo.MapSuite.WindowsPhoneCore.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] | [[ThinkGeo.MapSuite.WindowsPhoneCore.Layer|Layer]] | | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawingWrappingFeatures(DrawingWrappingFeaturesFeatureLayerEventArgs)|OnDrawingWrappingFeatures]] | [[ThinkGeo.MapSuite.WindowsPhoneCore.DrawingWrappingFeaturesFeatureLayerEventArgs|DrawingWrappingFeaturesFeatureLayerEventArgs]] | [[ThinkGeo.MapSuite.WindowsPhoneCore.FeatureLayer|FeatureLayer]] | | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OpenCore()|OpenCore]] | | [[ThinkGeo.MapSuite.WindowsPhoneCore.Layer|Layer]](overriden) | | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#SetupTools()|SetupTools]] | | [[ThinkGeo.MapSuite.WindowsPhoneCore.FeatureLayer|FeatureLayer]] | This method sets up the EditTools and QueryTools objects. | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#SetupToolsCore()|SetupToolsCore]] | | [[ThinkGeo.MapSuite.WindowsPhoneCore.FeatureLayer|FeatureLayer]] | This method sets up the EditTools and QueryTools objects. | ==== Public Properties ==== ^ Name ^ Return ^ DeclaringType ^ Summary ^ | {{wiki:PublicProperty.gif|Public Property}}[[#DrawingExceptionMode|DrawingExceptionMode]] | [[ThinkGeo.MapSuite.WindowsPhoneCore.DrawingExceptionMode|DrawingExceptionMode]] | [[ThinkGeo.MapSuite.WindowsPhoneCore.Layer|Layer]] | Gets or sets the DrawExcpetionMode when exception happens. | | {{wiki:PublicProperty.gif|Public Property}}[[#DrawingMarginPercentage|DrawingMarginPercentage]] | Double | [[ThinkGeo.MapSuite.WindowsPhoneCore.FeatureLayer|FeatureLayer]] | This property gets and sets the extra drawing margin as a percentage around the map that draw to ensure that labeling is correct. | | {{wiki:PublicProperty.gif|Public Property}}[[#DrawingTime|DrawingTime]] | TimeSpan | [[ThinkGeo.MapSuite.WindowsPhoneCore.Layer|Layer]] | This property gets the last drawing time for the layer. | | {{wiki:PublicProperty.gif|Public Property}}[[#EditTools|EditTools]] | [[ThinkGeo.MapSuite.WindowsPhoneCore.EditTools|EditTools]] | [[ThinkGeo.MapSuite.WindowsPhoneCore.FeatureLayer|FeatureLayer]] | This property gets the EditTools that allow you to easily edit InternalFeatures in the Feature Layer. | | {{wiki:PublicProperty.gif|Public Property}}[[#Encoding|Encoding]] | Encoding | | This property gets and sets the encoding information for the DBF. | | {{wiki:PublicProperty.gif|Public Property}}[[#FeatureIdsToExclude|FeatureIdsToExclude]] | Collection | [[ThinkGeo.MapSuite.WindowsPhoneCore.FeatureLayer|FeatureLayer]] | A collection of strings representing record id of features not to get in the Layer. | | {{wiki:PublicProperty.gif|Public Property}}[[#FeatureSource|FeatureSource]] | [[ThinkGeo.MapSuite.WindowsPhoneCore.FeatureSource|FeatureSource]] | [[ThinkGeo.MapSuite.WindowsPhoneCore.FeatureLayer|FeatureLayer]] | This property gets the FeatureSource for the FeatureLayer. | | {{wiki:PublicProperty.gif|Public Property}}[[#HasBoundingBox|HasBoundingBox]] | Boolean | [[ThinkGeo.MapSuite.WindowsPhoneCore.Layer|Layer]](overriden) | 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. | | {{wiki:PublicProperty.gif|Public Property}}[[#IndexPathFileName|IndexPathFileName]] | String | | This property returns the path and filename of the index file you want to represent. | | {{wiki:PublicProperty.gif|Public Property}}[[#IsOpen|IsOpen]] | Boolean | [[ThinkGeo.MapSuite.WindowsPhoneCore.Layer|Layer]] | This property returns true if the Layer is open and false if it is not. | | {{wiki:PublicProperty.gif|Public Property}}[[#IsVisible|IsVisible]] | Boolean | [[ThinkGeo.MapSuite.WindowsPhoneCore.Layer|Layer]] | This property gets and set the visible state of the layer. | | {{wiki:PublicProperty.gif|Public Property}}[[#MaxRecordsToDraw|MaxRecordsToDraw]] | Int32 | | | | {{wiki:PublicProperty.gif|Public Property}}[[#Name|Name]] | String | [[ThinkGeo.MapSuite.WindowsPhoneCore.Layer|Layer]] | This property gets and sets the name for the layer. | | {{wiki:PublicProperty.gif|Public Property}}[[#QueryTools|QueryTools]] | [[ThinkGeo.MapSuite.WindowsPhoneCore.QueryTools|QueryTools]] | [[ThinkGeo.MapSuite.WindowsPhoneCore.FeatureLayer|FeatureLayer]] | This property gets the QueryTools that allow you to easily query Features from the Feature Layer. | | {{wiki:PublicProperty.gif|Public Property}}[[#ReadWriteMode|ReadWriteMode]] | [[ThinkGeo.MapSuite.WindowsPhoneCore.ShapeFileReadWriteMode|ShapeFileReadWriteMode]] | | | | {{wiki:PublicProperty.gif|Public Property}}[[#RequireIndex|RequireIndex]] | Boolean | | This property gets and sets whether an index is required when reading data. The default value is true. | | {{wiki:PublicProperty.gif|Public Property}}[[#ShapePathFileName|ShapePathFileName]] | String | | This property returns the path and filename of the Shape File you want to represent. | | {{wiki:PublicProperty.gif|Public Property}}[[#UsingSpatialIndex|UsingSpatialIndex]] | Boolean | | This property gets whether the Shape File FeatureSource has an index or not. | | {{wiki:PublicProperty.gif|Public Property}}[[#WrappingExtent|WrappingExtent]] | [[ThinkGeo.MapSuite.WindowsPhoneCore.RectangleShape|RectangleShape]] | [[ThinkGeo.MapSuite.WindowsPhoneCore.FeatureLayer|FeatureLayer]] | | | {{wiki:PublicProperty.gif|Public Property}}[[#WrappingMode|WrappingMode]] | [[ThinkGeo.MapSuite.WindowsPhoneCore.WrappingMode|WrappingMode]] | [[ThinkGeo.MapSuite.WindowsPhoneCore.FeatureLayer|FeatureLayer]] | Thie property gets or sets whether allow wrap date line. | | {{wiki:PublicProperty.gif|Public Property}}[[#ZoomLevelSet|ZoomLevelSet]] | [[ThinkGeo.MapSuite.WindowsPhoneCore.ZoomLevelSet|ZoomLevelSet]] | [[ThinkGeo.MapSuite.WindowsPhoneCore.FeatureLayer|FeatureLayer]] | This property gets and sets the ZoomLevelSet, which contains the specific zoom levels for the FeatureLayer. | ==== Protected Properties ==== ^ Name ^ Return ^ DeclaringType ^ Summary ^ | {{wiki:ProtectedProperty.gif|Protected Property}}[[#IsOpenCore|IsOpenCore]] | Boolean | [[ThinkGeo.MapSuite.WindowsPhoneCore.Layer|Layer]](overriden) | | ==== Public Events ==== ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | {{wiki:PublicEvent.gif|Public Event}}[[#DrawingFeatures|DrawingFeatures]] | [[ThinkGeo.MapSuite.WindowsPhoneCore.DrawingFeaturesEventArgs|DrawingFeaturesEventArgs]] | [[ThinkGeo.MapSuite.WindowsPhoneCore.FeatureLayer|FeatureLayer]] | This event is raised when features are about to be drawn in the layer. | | {{wiki:PublicEvent.gif|Public Event}}[[#DrawingProgressChanged|DrawingProgressChanged]] | [[ThinkGeo.MapSuite.WindowsPhoneCore.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] | [[ThinkGeo.MapSuite.WindowsPhoneCore.Layer|Layer]] | | | {{wiki:PublicEvent.gif|Public Event}}[[#DrawingWrappingFeatures|DrawingWrappingFeatures]] | [[ThinkGeo.MapSuite.WindowsPhoneCore.DrawingWrappingFeaturesFeatureLayerEventArgs|DrawingWrappingFeaturesFeatureLayerEventArgs]] | [[ThinkGeo.MapSuite.WindowsPhoneCore.FeatureLayer|FeatureLayer]] | | | {{wiki:PublicEvent.gif|Public Event}}[[#StreamLoading|StreamLoading]] | [[ThinkGeo.MapSuite.WindowsPhoneCore.StreamLoadingEventArgs|StreamLoadingEventArgs]] | | This event allows you to pass in your own stream to represent the files. | ===== Public Constructors ===== ==== ShapeFileFeatureLayer() ==== This is a constructor for the class. === Overloads === This is the default constructor. If you use this constructor, then you should set the required methods manually. === Remarks === This is the default constructor. If you use this constructor, then you should set the required methods manually. === Parameters === ^ Name ^ Type ^ Description ^ [[#Public Constructors|Go Back]] ==== ShapeFileFeatureLayer(String) ==== This is a constructor for the class. === Overloads === This constructor allows you to provide a path and filename to a shape file. === Parameters === ^ Name ^ Type ^ Description ^ | shapePathFilename | String | This parameter is the Shape File path and filename. | [[#Public Constructors|Go Back]] ==== ShapeFileFeatureLayer(String, ShapeFileReadWriteMode) ==== This is a constructor for the class. === Overloads === This constructor allows you to provide a path and filename to a Shape File and the read/write mode for the files. === Parameters === ^ Name ^ Type ^ Description ^ | shapePathFilename | String | This parameter is the Shape File path and filename. | | readWriteMode | [[ThinkGeo.MapSuite.WindowsPhoneCore.ShapeFileReadWriteMode|ShapeFileReadWriteMode]] | This parameter specifies whether the file will be opened in read-only or read/write mode. | [[#Public Constructors|Go Back]] ==== ShapeFileFeatureLayer(String, String) ==== This is a constructor for the class. === Overloads === This constructor allows you to provide a path and filename to a Shape File and its spatial index file. === Parameters === ^ Name ^ Type ^ Description ^ | shapePathFilename | String | This parameter is the Shape File path and filename. | | indexPathFilename | String | This parameter is the index file path and filename. | [[#Public Constructors|Go Back]] ==== ShapeFileFeatureLayer(String, String, ShapeFileReadWriteMode) ==== This is a constructor for the class. === Overloads === This constructor allows you to provide a path and filename to a Shape File, its index file, and to specify the read/write mode for the files. === Parameters === ^ Name ^ Type ^ Description ^ | shapePathFilename | String | This parameter is the Shape File path and filename. | | indexPathFilename | String | This parameter is the index file path and filename. | | readWriteMode | [[ThinkGeo.MapSuite.WindowsPhoneCore.ShapeFileReadWriteMode|ShapeFileReadWriteMode]] | This parameter specifies whether the file will be opened in read-only or read/write mode. | [[#Public Constructors|Go Back]] ==== ShapeFileFeatureLayer(String, String, ShapeFileReadWriteMode, Encoding) ==== This is a constructor for the class. === Overloads === This constructor allows you to provide a path and filename to a Shape File, the index file, and to specify the read/write mode and the encoding for the files. === Parameters === ^ Name ^ Type ^ Description ^ | shapePathFilename | String | This parameter is the Shape File path and filename. | | indexPathFilename | String | This parameter is the index file path and filename. | | readWriteMode | [[ThinkGeo.MapSuite.WindowsPhoneCore.ShapeFileReadWriteMode|ShapeFileReadWriteMode]] | This parameter specifies whether the file will be opened in read-only or read/write mode. | | encoding | Encoding | This parameter specifies the encoding of the data. | [[#Public Constructors|Go Back]] ===== Protected Constructors ===== ===== Public Methods ===== ==== BuildIndexFile(IEnumerable, String, BuildIndexMode) ==== This method builds a spatial index for the specified group of features. === Overloads === This overload allows you to pass in a group of features and specify the index filename to use. You can also pass in a Shape File and specify whether to rebuild an index file if it already exists. === Remarks === This overload allows you to pass in a group of features and specify the index filename to use. === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ | features | IEnumerable<[[ThinkGeo.MapSuite.WindowsPhoneCore.Feature|Feature]]> | This parameter specifies the features for which to build the index. | | indexPathFilename | String | This parameter determines the target index path filename. | | buildIndexMode | [[ThinkGeo.MapSuite.WindowsPhoneCore.BuildIndexMode|BuildIndexMode]] | This parameter determines whether an index file will be rebuilt if it already exists. | [[#Public Methods|Go Back]] ==== BuildIndexFile(IEnumerable, String, Projection) ==== This method builds a spatial index for the specified group of features and target projection. === Overloads === This overload allows you to pass in a group of features and specify a target projection and the index filename to use. === 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 ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ | features | IEnumerable<[[ThinkGeo.MapSuite.WindowsPhoneCore.Feature|Feature]]> | This parameter specifies the features for which to build the index. | | indexPathFilename | String | This parameter specifies the target index path and filename. | | projection | [[ThinkGeo.MapSuite.WindowsPhoneCore.Projection|Projection]] | This parameter specifies the projection to build index against those features. | [[#Public Methods|Go Back]] ==== BuildIndexFile(IEnumerable, String) ==== This method builds a spatial index for the specified group of features. === Overloads === This overload allows you to pass in a group of features and specify the index filename to use. === Remarks === This overload allows you to pass in a group of features and specify the index filename to use. === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ | features | IEnumerable<[[ThinkGeo.MapSuite.WindowsPhoneCore.Feature|Feature]]> | This parameter specifies the features for which to build the index. | | indexPathFilename | String | This parameter specifies the target index path and filename. | [[#Public Methods|Go Back]] ==== 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. === Overloads === This overload allows you to pass in a Shape File and only build an index for those features that satisfy the regularExpression parameter. === Remarks === This overload allows you to pass in a Shape File and specify the index filename to use. === Return Value === ^ Return Type ^ Description ^ | Void | | === 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. | | projection | [[ThinkGeo.MapSuite.WindowsPhoneCore.Projection|Projection]] | 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 | [[ThinkGeo.MapSuite.WindowsPhoneCore.BuildIndexMode|BuildIndexMode]] | This parameter determines whether an index file will be rebuilt if it already exists. | [[#Public Methods|Go Back]] ==== BuildIndexFile(String, String, String, String, BuildIndexMode) ==== This method builds a spatial index only for those features that satisfy a regular expression. === Overloads === This overload allows you to pass in a Shape File and only build an index for those features that satisfy the regularExpression parameter. === Remarks === This overload allows you to pass in a Shape File and specify the index filename to use. === Return Value === ^ Return Type ^ Description ^ | Void | | === 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 | [[ThinkGeo.MapSuite.WindowsPhoneCore.BuildIndexMode|BuildIndexMode]] | This parameter determines whether an index file will be rebuilt if it already exists. | [[#Public Methods|Go Back]] ==== BuildIndexFile(IEnumerable, String, Projection, BuildIndexMode) ==== This method builds a spatial index for the specified group of features. === Overloads === This overload allows you to pass in a group of features and specify a target projection and the index filename to use. You can also pass in a Shape File and specify whether to rebuild an index file if it already exists. === 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 ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ | features | IEnumerable<[[ThinkGeo.MapSuite.WindowsPhoneCore.Feature|Feature]]> | This parameter specifies the features for which to build the index. | | indexPathFilename | String | This parameter determines the target index path filename. | | projection | [[ThinkGeo.MapSuite.WindowsPhoneCore.Projection|Projection]] | This parameter determines the Projection to build index against those features. | | buildIndexMode | [[ThinkGeo.MapSuite.WindowsPhoneCore.BuildIndexMode|BuildIndexMode]] | This parameter determines whether an index file will be rebuilt if it already exists. | [[#Public Methods|Go Back]] ==== BuildIndexFile(String, BuildIndexMode) ==== This method builds a spatial index for the layer. === Overloads === This overload allows you to pass in the Shape File and determines if we rebuild an index file that already exists. === 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 ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ | pathFilename | String | This parameter is the matching pattern that defines which Shape Files to include. | | rebuildExistingIndexMode | [[ThinkGeo.MapSuite.WindowsPhoneCore.BuildIndexMode|BuildIndexMode]] | This parameter determines whether an index file will be rebuilt if it already exists. | [[#Public Methods|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. === Overloads === This overload allows you to pass in a Shape File and only build an index for those features that satisfy the regularExpression parameter. === Remarks === This overload allows you to pass in a Shape File and specify the index filename to use. === Return Value === ^ Return Type ^ Description ^ | Void | | === 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. | | projection | [[ThinkGeo.MapSuite.WindowsPhoneCore.Projection|Projection]] | 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 | [[ThinkGeo.MapSuite.WindowsPhoneCore.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. | [[#Public Methods|Go Back]] ==== BuildIndexFile(String) ==== This method builds a spatial index for the layer. === Overloads === This overload allows you to pass in the Shape filename. === Remarks === This overload allows you to pass in the Shape File. === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ | pathFilename | String | The path and filename to the Shape File. | [[#Public Methods|Go Back]] ==== BuildIndexFile(String, String, BuildIndexMode) ==== This method build a spatial index for the shape file which increases accessspeed. === Overloads === 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. === 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 ^ Description ^ | Void | | === 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 | [[ThinkGeo.MapSuite.WindowsPhoneCore.BuildIndexMode|BuildIndexMode]] | This parameter determines what will happen if there is an existing index file. | [[#Public Methods|Go Back]] ==== BuildRecordIdColumn(String, String, BuildRecordIdMode, Int32) ==== Static API used to build RecordId from the specified starting Id number. === Return Value === ^ Return Type ^ Description ^ | Void | | === 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 | [[ThinkGeo.MapSuite.WindowsPhoneCore.BuildRecordIdMode|BuildRecordIdMode]] | The RecordId build mode. | | startNumber | Int32 | The starting Id number of the RecordId. | [[#Public Methods|Go Back]] ==== BuildRecordIdColumn(String, String, BuildRecordIdMode, Int32, Encoding) ==== Static API used to build RecordId from the specified starting Id number. === Return Value === ^ Return Type ^ Description ^ | Void | | === 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 | [[ThinkGeo.MapSuite.WindowsPhoneCore.BuildRecordIdMode|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. | [[#Public Methods|Go Back]] ==== BuildRecordIdColumn(String, String, BuildRecordIdMode) ==== Static API used to build RecordId. The Id will start from 0. === Return Value === ^ Return Type ^ Description ^ | Void | | === 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 | [[ThinkGeo.MapSuite.WindowsPhoneCore.BuildRecordIdMode|BuildRecordIdMode]] | The RecordId build mode. | [[#Public Methods|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 ^ Description ^ | Void | | === 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 | [[ThinkGeo.MapSuite.WindowsPhoneCore.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. | [[#Public Methods|Go Back]] ==== 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 === ^ Return Type ^ Description ^ | Void | | === 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. | [[#Public Methods|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 ^ Description ^ | Void | | === 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 | [[ThinkGeo.MapSuite.WindowsPhoneCore.OverwriteMode|OverwriteMode]] | This parameter specifies the overwrite mode when the target ShapeFile already exists. | [[#Public Methods|Go Back]] ==== Close() ==== This method closes the Layer and releases any resources it was using. === Remarks === This method is the concrete wrapper for the abstract method CloseCore. The close method plays an important role in the life cycle of the Layer. It may be called after drawing to release any memory and other resources that were allocated since the Open method was called. If you override this method, it is recommended that you take the following things into account: This method may be called multiple times, so we suggest you write the method so that that a call to a closed Layer is ignored and does not generate an error. We also suggest that in the Close you free all resources that have been opened. Remember that the object will not be destroyed, but will be re-opened possibly in the near future. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ [[#Public Methods|Go Back]] ==== CreateShapeFile(ShapeFileType, String, IEnumerable, 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 ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ | shapeType | [[ThinkGeo.MapSuite.WindowsPhoneCore.ShapeFileType|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<[[ThinkGeo.MapSuite.WindowsPhoneCore.DbfColumn|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 | [[ThinkGeo.MapSuite.WindowsPhoneCore.OverwriteMode|OverwriteMode]] | This parameter specifies the override mode when the target Shape File exists. | [[#Public Methods|Go Back]] ==== CreateShapeFile(ShapeFileType, String, IEnumerable) ==== Static API to create a new Shape File. === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ | shapeType | [[ThinkGeo.MapSuite.WindowsPhoneCore.ShapeFileType|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<[[ThinkGeo.MapSuite.WindowsPhoneCore.DbfColumn|DbfColumn]]> | This parameter specifies the DBF column information for the target Shape File. | [[#Public Methods|Go Back]] ==== CreateShapeFile(ShapeFileType, String, IEnumerable, Encoding) ==== Static API to create a new Shape File. === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ | shapeType | [[ThinkGeo.MapSuite.WindowsPhoneCore.ShapeFileType|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<[[ThinkGeo.MapSuite.WindowsPhoneCore.DbfColumn|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. | [[#Public Methods|Go Back]] ==== Draw(GeoCanvas, Collection) ==== This method draws the Layer. === Remarks === This method is the concrete wrapper for the abstract method DrawCore. This method draws the representation of the layer based on the extent you provided. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ | canvas | [[ThinkGeo.MapSuite.WindowsPhoneCore.GeoCanvas|GeoCanvas]] | This parameter is the canvas object or a GeoImage to draw on. | | labelsInAllLayers | Collection<[[ThinkGeo.MapSuite.WindowsPhoneCore.SimpleCandidate|SimpleCandidate]]> | This parameter represents the labels used for collision detection and duplication checking. | [[#Public Methods|Go Back]] ==== Equals(Object) ==== === Return Value === ^ Return Type ^ Description ^ | Boolean | | === Parameters === ^ Name ^ Type ^ Description ^ | obj | Object | | [[#Public Methods|Go Back]] ==== GetBoundingBox() ==== This method returns the bounding box of the Layer. === Remarks === This method is the concrete wrapper for the abstract method GetBoundingBoxCore. This method returns the bounding box of the RasterLayer. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. === Return Value === ^ Return Type ^ Description ^ | [[ThinkGeo.MapSuite.WindowsPhoneCore.RectangleShape|RectangleShape]] | This method returns the bounding box of the Layer. | === Parameters === ^ Name ^ Type ^ Description ^ [[#Public Methods|Go Back]] ==== GetDataFromDbf(String) ==== === Return Value === ^ Return Type ^ Description ^ | Dictionary | | === Parameters === ^ Name ^ Type ^ Description ^ | id | String | | [[#Public Methods|Go Back]] ==== GetDataFromDbf(String, String) ==== === Return Value === ^ Return Type ^ Description ^ | String | | === Parameters === ^ Name ^ Type ^ Description ^ | id | String | | | columnName | String | | [[#Public Methods|Go Back]] ==== GetDataFromDbf(String, IEnumerable) ==== === Return Value === ^ Return Type ^ Description ^ | Dictionary | | === Parameters === ^ Name ^ Type ^ Description ^ | id | String | | | returningColumnNames | IEnumerable | | [[#Public Methods|Go Back]] ==== GetDataFromDbf(IEnumerable, String) ==== === Return Value === ^ Return Type ^ Description ^ | Collection> | | === Parameters === ^ Name ^ Type ^ Description ^ | ids | IEnumerable | | | columnName | String | | [[#Public Methods|Go Back]] ==== GetDataFromDbf(IEnumerable) ==== === Return Value === ^ Return Type ^ Description ^ | Collection> | | === Parameters === ^ Name ^ Type ^ Description ^ | ids | IEnumerable | | [[#Public Methods|Go Back]] ==== GetDataFromDbf(IEnumerable, IEnumerable) ==== === Return Value === ^ Return Type ^ Description ^ | Collection> | | === Parameters === ^ Name ^ Type ^ Description ^ | ids | IEnumerable | | | returningColumnNames | IEnumerable | | [[#Public Methods|Go Back]] ==== GetHashCode() ==== === Return Value === ^ Return Type ^ Description ^ | Int32 | | === Parameters === ^ Name ^ Type ^ Description ^ [[#Public Methods|Go Back]] ==== GetShapeFileType() ==== Get the Shape File type for the Shape File FeatureSource. === Return Value === ^ Return Type ^ Description ^ | [[ThinkGeo.MapSuite.WindowsPhoneCore.ShapeFileType|ShapeFileType]] | The ShapeFileType for the ShapeFile FeatureSource. | === Parameters === ^ Name ^ Type ^ Description ^ [[#Public Methods|Go Back]] ==== GetType() ==== === Return Value === ^ Return Type ^ Description ^ | Type | | === Parameters === ^ Name ^ Type ^ Description ^ [[#Public Methods|Go Back]] ==== Open() ==== This method opens the Layer so that it is initialized and ready to use. === Remarks === This method is the concrete wrapper for the abstract method OpenCore. The open method plays an important role, as it is responsible for initializing the Layer. Most methods on the Layer will throw an exception if the state of the Layer is not opened. When the map draws each layer, the layer will be opened as one of its first steps; then, after it is finished drawing with that layer, it will close it. In this way, we are sure to release all resources used by the Layer. When implementing the abstract method, consider opening the FeatureSource or RasterSource. You will get a chance to close these in the Close method of the Layer. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ [[#Public Methods|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 ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ | shapePathFilename | String | This parameter is the shape file you want to rebuild. | [[#Public Methods|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. === Return Value === ^ Return Type ^ Description ^ | Void | | === 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. | | projection | [[ThinkGeo.MapSuite.WindowsPhoneCore.Projection|Projection]] | 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 | [[ThinkGeo.MapSuite.WindowsPhoneCore.OverwriteMode|OverwriteMode]] | This parameter specifies the override mode when the target shape file exists. | [[#Public Methods|Go Back]] ==== ToString() ==== === Return Value === ^ Return Type ^ Description ^ | String | | === Parameters === ^ Name ^ Type ^ Description ^ [[#Public Methods|Go Back]] ==== UpdateDbfData(String, IEnumerable, IEnumerable) ==== === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ | id | String | | | returningColumnNames | IEnumerable | | | values | IEnumerable | | [[#Public Methods|Go Back]] ==== UpdateDbfData(String, String, String) ==== === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ | id | String | | | columnName | String | | | decimalDegreesValue | String | | [[#Public Methods|Go Back]] ==== Validate() ==== This method checks all features in a shapefile is supported by Mapsuite or not. === Return Value === ^ Return Type ^ Description ^ | Dictionary | 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 ^ [[#Public Methods|Go Back]] ===== Protected Methods ===== ==== CloseCore() ==== === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ [[#Protected Methods|Go Back]] ==== DrawCore(GeoCanvas, Collection) ==== === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ | canvas | [[ThinkGeo.MapSuite.WindowsPhoneCore.GeoCanvas|GeoCanvas]] | | | labelsInAllLayers | Collection<[[ThinkGeo.MapSuite.WindowsPhoneCore.SimpleCandidate|SimpleCandidate]]> | | [[#Protected Methods|Go Back]] ==== DrawException(GeoCanvas, Exception) ==== This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException. === Remarks === This method can be overriden its logic by rewrite the DrawExceptionCore. === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ | canvas | [[ThinkGeo.MapSuite.WindowsPhoneCore.GeoCanvas|GeoCanvas]] | The target canvas to draw the layer. | | e | Exception | The exception thrown when layer.Draw(). | [[#Protected Methods|Go Back]] ==== DrawExceptionCore(GeoCanvas, Exception) ==== This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException. === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ | canvas | [[ThinkGeo.MapSuite.WindowsPhoneCore.GeoCanvas|GeoCanvas]] | The target canvas to draw the layer. | | e | Exception | The exception thrown when layer.Draw(). | [[#Protected Methods|Go Back]] ==== Finalize() ==== === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ [[#Protected Methods|Go Back]] ==== GetBoundingBoxCore() ==== === Return Value === ^ Return Type ^ Description ^ | [[ThinkGeo.MapSuite.WindowsPhoneCore.RectangleShape|RectangleShape]] | | === Parameters === ^ Name ^ Type ^ Description ^ [[#Protected Methods|Go Back]] ==== MemberwiseClone() ==== === Return Value === ^ Return Type ^ Description ^ | Object | | === Parameters === ^ Name ^ Type ^ Description ^ [[#Protected Methods|Go Back]] ==== OnDrawingFeatures(DrawingFeaturesEventArgs) ==== This method raises the DrawingFeatures event. === Remarks === You can call this method from a derived class to enable it to raise the event. This may be useful if you plan to extend the FeatureLayer and you need access to the event. This event is meant to allow you to add or remove the features to be drawn. === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ | e | [[ThinkGeo.MapSuite.WindowsPhoneCore.DrawingFeaturesEventArgs|DrawingFeaturesEventArgs]] | This parameter represents the event arguments for the event. | [[#Protected Methods|Go Back]] ==== OnDrawingProgressChanged(DrawingProgressChangedEventArgs) ==== === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ | e | [[ThinkGeo.MapSuite.WindowsPhoneCore.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] | | [[#Protected Methods|Go Back]] ==== OnDrawingWrappingFeatures(DrawingWrappingFeaturesFeatureLayerEventArgs) ==== === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ | e | [[ThinkGeo.MapSuite.WindowsPhoneCore.DrawingWrappingFeaturesFeatureLayerEventArgs|DrawingWrappingFeaturesFeatureLayerEventArgs]] | | [[#Protected Methods|Go Back]] ==== OpenCore() ==== === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ [[#Protected Methods|Go Back]] ==== SetupTools() ==== This method sets up the EditTools and QueryTools objects. === Remarks === This method is the concrete wrapper for the abstract method SetupToolsCore. The SetupTools method allows you to create the QueryTool, EditTools and other tools you may need on your object. We created this method so that if you want to extend one of the tool classes, you can override the SetupToolsCore and create any class you want. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ [[#Protected Methods|Go Back]] ==== SetupToolsCore() ==== This method sets up the EditTools and QueryTools objects. === Remarks === This method is the concrete wrapper for the abstract method SetupTools. The SetupTools method allows you to create the QueryTool, EditTools and other tools you may need on your object. We created this method so that if you want to extend one of the tool classes, you can override the SetupToolsCore and create any class you want. === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ [[#Protected Methods|Go Back]] ===== Public Properties ===== ==== DrawingExceptionMode ==== Gets or sets the DrawExcpetionMode when exception happens. === Return Value === ^ Return Type ^ | [[ThinkGeo.MapSuite.WindowsPhoneCore.DrawingExceptionMode|DrawingExceptionMode]] | [[#Public Properties|Go Back]] ==== DrawingMarginPercentage ==== This property gets and sets the extra drawing margin as a percentage around the map that draw to ensure that labeling is correct. === Remarks === This extra margin that we draw exists so that labels match up if they are partially cut off. === Return Value === ^ Return Type ^ | Double | [[#Public Properties|Go Back]] ==== DrawingTime ==== This property gets the last drawing time for the layer. === Remarks === We track the drawing time for the layer and report it back in this method. This is useful for determining the speed of various layers. === Return Value === ^ Return Type ^ | TimeSpan | [[#Public Properties|Go Back]] ==== EditTools ==== This property gets the EditTools that allow you to easily edit InternalFeatures in the Feature Layer. === Remarks === The EditTools are supplied as an easily accessible wrapper for the editing methods of the FeatureSource. === Return Value === ^ Return Type ^ | [[ThinkGeo.MapSuite.WindowsPhoneCore.EditTools|EditTools]] | [[#Public Properties|Go Back]] ==== Encoding ==== This property gets and sets the encoding information for the DBF. === Return Value === ^ Return Type ^ | Encoding | [[#Public Properties|Go Back]] ==== FeatureIdsToExclude ==== A collection of strings representing record id of features not to get in the Layer. === Remarks === This string collection is a handy place to specify what records not to get from the source. Suppose you have a shape file of roads and you want to hide the roads within a particular rectangle, simply execute GetFeaturesInsideBoundingBox() and add the id of the return features to the collection and forget about them. Since you can set this by Layer it makes is easy to determine what to and what not to. === Return Value === ^ Return Type ^ | Collection | [[#Public Properties|Go Back]] ==== FeatureSource ==== This property gets the FeatureSource for the FeatureLayer. === Remarks === The FeatureSource is the provider of data to the FeatureLayer. There are different FeatureSource classes to match the various ways that feature data is stored. It is important that, when you inherit from the FeatureLayer, in the constructor you set the FeatureSource you want to use. === Return Value === ^ Return Type ^ | [[ThinkGeo.MapSuite.WindowsPhoneCore.FeatureSource|FeatureSource]] | [[#Public Properties|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 | [[#Public Properties|Go Back]] ==== IndexPathFileName ==== This property returns the path and filename of the index file you want to represent. === Return Value === ^ Return Type ^ | String | [[#Public Properties|Go Back]] ==== IsOpen ==== This property returns true if the Layer is open and false if it is not. === Remarks === This method is the concrete wrapper for the abstract method IsOpenCore. Various methods on the Layer require that it be in an open state. If one of those methods is called when the state is not open, then the method will throw an exception. To enter the open state, you must call the Layer Open method. The method will raise an exception if the current Layer is already open. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework. === Return Value === ^ Return Type ^ | Boolean | [[#Public Properties|Go Back]] ==== IsVisible ==== This property gets and set the visible state of the layer. === Remarks === If this property is set to false, the layer will not draw. We ensure this in the Draw method. This is useful for legends and other controls that control the visibility of layers. === Return Value === ^ Return Type ^ | Boolean | [[#Public Properties|Go Back]] ==== MaxRecordsToDraw ==== === Return Value === ^ Return Type ^ | Int32 | [[#Public Properties|Go Back]] ==== Name ==== This property gets and sets the name for the layer. === Remarks === The name is user defined. It is useful to set, as it may be used for higher level components such as legends, etc. === Return Value === ^ Return Type ^ | String | [[#Public Properties|Go Back]] ==== QueryTools ==== This property gets the QueryTools that allow you to easily query Features from the Feature Layer. === Remarks === This property gets the QueryTools that allow you to easily query Features from the Feature Layer. The QueryTools are supplied as an easily accessible wrapper for the query methods of the FeatureSource. === Return Value === ^ Return Type ^ | [[ThinkGeo.MapSuite.WindowsPhoneCore.QueryTools|QueryTools]] | [[#Public Properties|Go Back]] ==== ReadWriteMode ==== === Return Value === ^ Return Type ^ | [[ThinkGeo.MapSuite.WindowsPhoneCore.ShapeFileReadWriteMode|ShapeFileReadWriteMode]] | [[#Public Properties|Go Back]] ==== RequireIndex ==== This property gets and sets whether an index is required when reading data. The default value is true. === Return Value === ^ Return Type ^ | Boolean | [[#Public Properties|Go Back]] ==== ShapePathFileName ==== This property returns the path and filename of the Shape File you want to represent. === Return Value === ^ Return Type ^ | String | [[#Public Properties|Go Back]] ==== UsingSpatialIndex ==== This property gets whether the Shape File FeatureSource has an index or not. === Return Value === ^ Return Type ^ | Boolean | [[#Public Properties|Go Back]] ==== WrappingExtent ==== === Return Value === ^ Return Type ^ | [[ThinkGeo.MapSuite.WindowsPhoneCore.RectangleShape|RectangleShape]] | [[#Public Properties|Go Back]] ==== WrappingMode ==== Thie property gets or sets whether allow wrap date line. === Return Value === ^ Return Type ^ | [[ThinkGeo.MapSuite.WindowsPhoneCore.WrappingMode|WrappingMode]] | [[#Public Properties|Go Back]] ==== ZoomLevelSet ==== This property gets and sets the ZoomLevelSet, which contains the specific zoom levels for the FeatureLayer. === Remarks === The ZoomLevelSet is a class that contains all of the ZoomLevels for the FeatureLayer. Each ZoomLevel contains the styles that are used to determine how to draw the InternalFeatures. === Return Value === ^ Return Type ^ | [[ThinkGeo.MapSuite.WindowsPhoneCore.ZoomLevelSet|ZoomLevelSet]] | [[#Public Properties|Go Back]] ===== Protected Properties ===== ==== IsOpenCore ==== === Return Value === ^ Return Type ^ | Boolean | [[#Protected Properties|Go Back]] ===== Public Events ===== ==== DrawingFeatures ==== This event is raised when features are about to be drawn in the layer. === Remarks === This event is raised when features are about to be drawn in the layer. In the event arguments, there is a collection of features to be drawn. You can easily add or remove items from this collection so that extra items will draw or not draw. === Event Arguments === ^ Event Arguments ^ | [[ThinkGeo.MapSuite.WindowsPhoneCore.DrawingFeaturesEventArgs|DrawingFeaturesEventArgs]] | [[#Public Events|Go Back]] ==== DrawingProgressChanged ==== === Event Arguments === ^ Event Arguments ^ | [[ThinkGeo.MapSuite.WindowsPhoneCore.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] | [[#Public Events|Go Back]] ==== DrawingWrappingFeatures ==== === Event Arguments === ^ Event Arguments ^ | [[ThinkGeo.MapSuite.WindowsPhoneCore.DrawingWrappingFeaturesFeatureLayerEventArgs|DrawingWrappingFeaturesFeatureLayerEventArgs]] | [[#Public Events|Go Back]] ==== 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 === ^ Event Arguments ^ | [[ThinkGeo.MapSuite.WindowsPhoneCore.StreamLoadingEventArgs|StreamLoadingEventArgs]] | [[#Public Events|Go Back]] __NOTOC__ [[Category:WindowsPhoneMapSuiteCore]] [[Category:ThinkGeo.MapSuite.WindowsPhoneCore]] [[Category:UpdateDocumentation]]