MultipleShapeFileFeatureLayer¶

Namespace: ThinkGeo.Core

This layer represents multiple Shape Files of the same type.

public class MultipleShapeFileFeatureLayer : FeatureLayer

Inheritance Object → LayerBase → Layer → FeatureLayer → MultipleShapeFileFeatureLayer

Remarks:

This layer represents multiple Shape Files of the same type. Many times, you will have multiple Shape Files that represent the same type and you want to draw all of the InternalFeatures in each Shape Files the same way. For example, you may have Shape Files that contain roads separated by state (TXRoads.shp, FLRoads.shp, etc.) but want them to seem like one layer, draw the same way and let you spatially query seamlessly between them. The MultipleShapeFileFeatureLayer accomplishes that goal. When you create the layer, you enter a pattern matching criterion -- such as C:\Roads\??Roads.shp" -- and the layer will automatically include all of the Shape Files that match that pattern.

In addition to this, you can also generate single large indexes that index the multiple Shape Files. This means you can have one large road index for all of the road Shape Files, instead of having individual indexes for each layer. Not only is this faster to query, but it also allows you to minimize the number of files you need.

Properties¶

ShapeFiles¶

public Collection<string> ShapeFiles { get; }

Property Value¶

Collection<String>

Indexes¶

public Collection<string> Indexes { get; }

Property Value¶

Collection<String>

MultipleShapeFilePattern¶

This property gets and sets the Shape File pattern that makes up this layer.

public string MultipleShapeFilePattern { get; set; }

Property Value¶

String
This property gets the Shape File pattern that makes up this layer.

Remarks:

None

IndexFilePattern¶

This property gets and sets the index file pattern that makes up this layer.

public string IndexFilePattern { get; set; }

Property Value¶

String
This property gets the index file pattern that makes up this layer.

Remarks:

None

Encoding¶

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

public Encoding Encoding { get; set; }

Property Value¶

Encoding

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 MultipleShapeFeatureLayer, we override this API and mark it as true.

public bool HasBoundingBox { get; }

Property Value¶

Boolean

Remarks:

The default implementation in the base class returns false.

Projection¶

public Projection Projection { get; }

Property Value¶

Projection

EditTools¶

This property gets the EditTools that allow you to easily edit InternalFeatures in the Feature Layer.

public EditTools EditTools { get; protected set; }

Property Value¶

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.

FeatureIdsToExclude¶

A collection of strings representing record id of features not to get in the Layer.

public Collection<string> FeatureIdsToExclude { get; }

Property Value¶

Collection<String>

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.

QueryTools¶

This property gets the QueryTools that allow you to easily query Features from the Feature Layer.

public QueryTools QueryTools { get; protected set; }

Property Value¶

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.

MaxRecordsToDraw¶

public int MaxRecordsToDraw { get; set; }

Property Value¶

Int32

FeatureSource¶

This property gets the FeatureSource for the FeatureLayer.

public FeatureSource FeatureSource { get; set; }

Property Value¶

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.

DrawingQuality¶

This property gets and sets the general drawing quality for the FeatureLayer's view.

public DrawingQuality DrawingQuality { get; set; }

Property Value¶

DrawingQuality

        This property gets the general drawing quality for the FeatureLayer's
        view.

Remarks:

The DrawingQuality enumeration allows you to control, in a macro sense, the drawing quality that will be used in the GeoCanvas. Each GeoCanvas, which is responsible for drawing of the features, may have its own specialized drawing quality properties. What the DrawingQuality enumeration does is define some general guidelines for each GeoCanvas. For example, if you set the DrawingQuality to HighSpeed, then inside of the PlatformGeoCanvas there is a profile for HighSpeed. This profile sets specific properties, such as the smoothing mode and composing drawing mode of the PlatformGeoCanvas. As each GeoCanvas may have different drawing quality properties, this offers a general way to control drawing quality and speed.

If you need complete control over how a specific GeoCanvas will draw, then you can set the DrawingQuality to Custom. This will tell the specific GeoCanvas to use the properties on its own object instead of one of the pre-defined profiles. If one of the profiles -- such as HighSpeed or HighQuality -- is set, then the specific GeoCanvas ignores its own properties for drawing quality.

ZoomLevelSet¶

This property gets and sets the ZoomLevelSet, which contains the specific zoom levels for the FeatureLayer.

public ZoomLevelSet ZoomLevelSet { get; set; }

Property Value¶

ZoomLevelSet

        This property gets 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.

DrawingMarginInPixel¶

public float DrawingMarginInPixel { get; set; }

Property Value¶

Single

Attribution¶

public string Attribution { get; set; }

Property Value¶

String

RequestDrawingInterval¶

public TimeSpan RequestDrawingInterval { get; set; }

Property Value¶

TimeSpan

Name¶

This property gets and sets the name for the layer.

public string Name { get; set; }

Property Value¶

String

Remarks:

The name is user defined. It is useful to set, as it may be used for higher level components such as legends, etc.

IsOpen¶

This property returns true if the Layer is open and false if it is not.

public bool IsOpen { get; }

Property Value¶

Boolean

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.

IsVisible¶

This property gets and set the visible state of the layer.

public bool IsVisible { get; set; }

Property Value¶

Boolean

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.

DrawingTime¶

This property gets the last drawing time for the layer.

public TimeSpan DrawingTime { get; protected set; }

Property Value¶

TimeSpan

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.

DrawingExceptionMode¶

public DrawingExceptionMode DrawingExceptionMode { get; set; }

Property Value¶

DrawingExceptionMode

Background¶

Gets and sets the background of the layer.

public GeoColor Background { get; set; }

Property Value¶

GeoColor

Transparency¶

This property gets and sets the amount of transparency to apply to the image.

public float Transparency { get; set; }

Property Value¶

Single
This property gets the amount of transparency to apply to the image.

Remarks:

None

BlueTranslation¶

This property gets and sets the amount of blue to apply to the image.

public float BlueTranslation { get; set; }

Property Value¶

Single
This property gets the amount of blue to apply to the image.

Remarks:

None

RedTranslation¶

This property gets and sets the amount of red to apply to the image.

public float RedTranslation { get; set; }

Property Value¶

Single
This property gets the amount of red to apply to the image.

Remarks:

None

GreenTranslation¶

This property gets and sets the amount of green to apply to the image.

public float GreenTranslation { get; set; }

Property Value¶

Single
This property gets the amount of green to apply to the image.

Remarks:

None

KeyColors¶

Gets a value represents a collection of key colors. If SupportKeyColor property is false, it will throw exception when you use KeyColors.

public Collection<GeoColor> KeyColors { get; }

Property Value¶

Collection<GeoColor>

Remarks:

It will make these colors transparent when draw image.

IsNegative¶

This property gets and sets whether the image should be converted to negative (inverse colors).

public bool IsNegative { get; set; }

Property Value¶

Boolean
This property gets and sets whether the image should be converted to negative (inverse colors).

Remarks:

None

IsGrayscale¶

This property gets and sets if the image should be converted to grayscale.

public bool IsGrayscale { get; set; }

Property Value¶

Boolean

        This property gets and sets if the image should be converted to grayscale.

Remarks:

None

ThreadSafe¶

public ThreadSafetyLevel ThreadSafe { get; set; }

Property Value¶

ThreadSafetyLevel

ColorMappings¶

ColorMapping

public Dictionary<GeoColor, GeoColor> ColorMappings { get; }

Property Value¶

Dictionary<GeoColor, GeoColor>

WrappingMode¶

public WrappingMode WrappingMode { get; set; }

Property Value¶

WrappingMode

WrappingExtent¶

public RectangleShape WrappingExtent { get; set; }

Property Value¶

RectangleShape

Constructors¶

MultipleShapeFileFeatureLayer()¶

This is a constructor for the class.

public MultipleShapeFileFeatureLayer()

Remarks:

If you use this constructor, then you need to set to required properties manually.

MultipleShapeFileFeatureLayer(String)¶

This is a constructor for the class.

public MultipleShapeFileFeatureLayer(string multipleShapeFilePattern)

Parameters¶

multipleShapeFilePattern String

        This parameter is the matching pattern to determine which Shape Files are
        loaded.

Remarks:

This constructor allows you to pass in the path and filename pattern to match.

MultipleShapeFileFeatureLayer(String, String)¶

This is a constructor for the class.

public MultipleShapeFileFeatureLayer(string multipleShapeFilePattern, string indexFilePattern)

Parameters¶

multipleShapeFilePattern String

        This parameter is the path and filename matching pattern that determines which Shape Files are
        loaded.

indexFilePattern String

        This parameter is the path and filename matching pattern that determines which index files are
        loaded.

Remarks:

With this constructor you can specify differently-named indexes for the layer. If you have one large index, specify its path and filename here. If you have smaller single indexes, use wildcards to specify a pattern to match instead.

For example, if you had 50 road Shape Files named C:\Roads\??Roads.shp (where ?? is the two-character state abbreviation), but only one large index, then you would specify a string like "C:\Roads\Roads.idx". If you instead had 50 individual indexes whose names matched the Shape Files, then you would use "C:\Roads\??Roads.idx".

MultipleShapeFileFeatureLayer(IEnumerable<String>)¶

public MultipleShapeFileFeatureLayer(IEnumerable<string> shapeFiles)

Parameters¶

shapeFiles IEnumerable<String>

MultipleShapeFileFeatureLayer(IEnumerable<String>, IEnumerable<String>)¶

This is the constructor for the class.

public MultipleShapeFileFeatureLayer(IEnumerable<string> shapeFiles, IEnumerable<string> indexes)

Parameters¶

shapeFiles IEnumerable<String>

        This parameter represents the shape files to construct the MultipleShapeFileFeatureLayer. The format of it should be
        new string[] { "C:\CA_counties.shp", "C:\AZ_counties.shp" }.

indexes IEnumerable<String>

        This parameter represents the shape files to construct the ShapeFileFeatureLayer. The format of it should be
         new string[] { "C:\CA_counties.midx", "C:\AZ_counties.midx" }.

Remarks:

This is the constructor for this class. You can pass in a group of shapes and its corresponding indexs like string[] shapeFiles = new string[] { "C:\CA_counties.shp", "C:\AZ_counties.shp" }; string[] indexFiles = new string[] { "C:\CA_counties.midx", "C:\AZ_counties.midx" }; In this way, the MultipleShapeFileFeatureLayer will construct from the passing 2 shapes.

Methods¶

BuildIndex(String)¶

This method builds a spatial index for the layer.

public static void BuildIndex(string multipleShapeFilePattern)

Parameters¶

multipleShapeFilePattern String
This parameter is the matching pattern that defines which Shape Files to include.

Remarks:

This overload allows you to pass in a Shape File path and filename pattern. It will generate indexes for each Shape File it finds, matching the index file names to the Shape File names.

BuildIndex(String, BuildIndexMode)¶

This method builds a spatial index for the layer.

public static void BuildIndex(string multipleShapeFilePattern, BuildIndexMode buildIndexMode)

Parameters¶

multipleShapeFilePattern String
This parameter is the matching pattern that defines which Shape Files to include.

buildIndexMode BuildIndexMode

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

Remarks:

This overload allows you to pass in a Shape File path and filename pattern and determines if we re-build index files that already exist. It will generate indexes for each Shape File it finds, matching the index file names to the Shape File names.

BuildIndex(String, String)¶

This method builds a spatial index for the layer.

public static void BuildIndex(string multipleShapeFilePattern, string indexFilePattern)

Parameters¶

multipleShapeFilePattern String
This parameter is the matching pattern that defines which Shape Files to include.

indexFilePattern String

        This parameter is the matching pattern of how to name the index (or
        indexes).

Remarks:

This overload allows you to pass in a path and filename pattern for Shapes Files and index files. If you use a pattern for the index file name, it will generate indexes for each Shape File it finds, matching the index file names to the Shape File names. Alternatively, if you use a concrete index file name, it will generate one large index instead.

If you enter an indexFilePattern like "C:\Roads\??Roads.idx", it will build individual indexes for each Shape File and name them according to the pattern. If you enter an absolute name, like "C:\Roads\Roads.idx", it will create one large index for all of the Shape Files.

BuildIndex(String, String, BuildIndexMode)¶

This method builds a spatial index for the layer.

public static void BuildIndex(string multipleShapeFilePattern, string indexFilePattern, BuildIndexMode buildIndexMode)

Parameters¶

multipleShapeFilePattern String
This parameter is the matching pattern that defines which Shape Files to include.

indexFilePattern String

        This parameter is the matching pattern of how to name the index (or
        indexes).

buildIndexMode BuildIndexMode

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

Remarks:

This overload allows you to pass in a path and filename pattern for Shapes Files and index files. If you use a pattern for the index file name, it will generate indexes for each Shape File it finds, matching the index file names to the Shape File names. Alternatively, if you use a concrete index file name, it will generate one large index instead.

If you enter an indexFilePattern like "C:\Roads\??Roads.idx", it will build individual indexes for each Shape File and name them according to the pattern. If you enter an absolute name, like "C:\Roads\Roads.idx", it will create one large index for all of the Shape Files.

BuildIndex(String, String, String, String)¶

This method builds a spatial index for the layer.

public static void BuildIndex(string multipleShapeFilePattern, string columnName, string regularExpression, string indexFilename)

Parameters¶

multipleShapeFilePattern String
This parameter is the matching pattern that defines which Shape Files to include.

columnName String

        This parameter is the column name you want to apply the regular
        expression towards.

regularExpression String

        This parameter is the regular expression you want to use to select certain
        features for your index.

indexFilename String

        This parameter is the name of the index file you want to generate for the features that match
        the regular expression.

Remarks:

This index-building method is very useful when you have a large number of Shape Files that contain only certain records you want. For example, you may have an individual Shape File for the states of Texas and Florida that contains only those states' roads. They are named TXRoads.shp for Texas and FLRoads.shp for Florida. Inside of these Shape Files there is a column that determines whether the roads are normal streets or highways. You, of course, want to draw highways differently. You could use a ValueStyle, but that would be slow because you'd have to look though all of the records at runtime to determine which are the highways. A better solution is to build a custom index that only has highways in it. In this way, you generate the index once and then runtime performance is fast.

In our scenario, we would create an index to include all of the road Shape Files by using the pattern "*Roads.shp". This will make sure we get both the Texas and Florida roads. Next, we specify the RoadType column as the column parameter. Then we provide a regular expression match that picks out all of the highways, and name the resulting index "Highways.idx". We can then build another, separate index just for the normal streets. In this way, we can quickly sort the roads from the highways -- and we didn't have to cut up our Shape Files to do it.

BuildIndex(String, String, String, String, BuildIndexMode)¶

This method builds a spatial index for the layer.

public static void BuildIndex(string multipleShapeFilePattern, string columnName, string regularExpression, string indexFilename, BuildIndexMode buildIndexMode)

Parameters¶

multipleShapeFilePattern String
This parameter is the matching pattern that defines which Shape Files to include.

columnName String

        This parameter is the column name you want to apply the regular
        expression towards.

regularExpression String

        This parameter is the regular expression you want to use to select certain
        features for your index.

indexFilename String

        This parameter is the name of the index file you want to generate for the features that match
        the regular expression.

buildIndexMode BuildIndexMode

        This parameter determines whether the index file will be rebuilt if it already
        exists.

Remarks:

This index-building method is very useful when you have a large number of Shape Files that contain only certain records you want. For example, you may have an individual Shape File for the states of Texas and Florida that contains only those states' roads. They are named TXRoads.shp for Texas and FLRoads.shp for Florida. Inside of these Shape Files there is a column that determines whether the roads are normal streets or highways. You, of course, want to draw highways differently. You could use a ValueStyle, but that would be slow because you'd have to look though all of the records at runtime to determine which are the highways. A better solution is to build a custom index that only has highways in it. In this way, you generate the index once and then runtime performance is fast.

In our scenario, we would create an index to include all of the road Shape Files by using the pattern "*Roads.shp". This will make sure we get both the Texas and Florida roads. Next, we specify the RoadType column as the column parameter. Then we provide a regular expression match that picks out all of the highways, and name the resulting index "Highways.idx". We can then build another, separate index just for the normal streets. In this way, we can quickly sort the roads from the highways -- and we didn't have to cut up our Shape Files to do it.

BuildIndex(String[], String[])¶

This method builds a spatial index for the layer.

public static void BuildIndex(String[] multipleShapeFiles, String[] multipleShapeFileIndexes)

Parameters¶

multipleShapeFiles String[]

        This parameter represents the shape files to construct the MultipleShapeFileFeatureLayer. The format of it should be
        new string[] { "C:\CA_counties.shp", "C:\AZ_counties.shp" }.

multipleShapeFileIndexes String[]

        This parameter represents the shape files to construct the ShapeFileFeatureLayer. The format of it should be
         new string[] { "C:\CA_counties.midx", "C:\AZ_counties.midx" }.

BuildIndex(String[], String[], BuildIndexMode)¶

This method builds a spatial index for the layer.

public static void BuildIndex(String[] multipleShapeFiles, String[] multipleShapeFileIndexes, BuildIndexMode buildIndexMode)

Parameters¶

multipleShapeFiles String[]

        This parameter represents the shape files to construct the MultipleShapeFileFeatureLayer. The format of it should be
        new string[] { "C:\CA_counties.shp", "C:\AZ_counties.shp" }.

multipleShapeFileIndexes String[]

        This parameter represents the shape files to construct the ShapeFileFeatureLayer. The format of it should be
         new string[] { "C:\CA_counties.midx", "C:\AZ_counties.midx" }.

buildIndexMode BuildIndexMode

GetShapePathFilenames()¶

This method returns a collection of the Shape Files and their paths that make up the layer.

public Collection<string> GetShapePathFilenames()

Returns¶

Collection<String>

        This method returns a collection of the Shape Files and their paths that make up the
        layer.

Remarks:

None

GetIndexPathFilenames()¶

This method returns a collection of the index files and their paths that make up the layer.

public Collection<string> GetIndexPathFilenames()

Returns¶

Collection<String>

        This method returns a collection of the index files and their paths that make up the
        layer.

Remarks:

None

Events¶

DrawingFeatures¶

This event is raised when features are about to be drawn in the layer.

public event EventHandler<DrawingFeaturesEventArgs> DrawingFeatures;

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.

DrawingWrappingFeatures¶

public event EventHandler<DrawingWrappingFeaturesFeatureLayerEventArgs> DrawingWrappingFeatures;

DrawingAttribution¶

public event EventHandler<DrawingAttributionLayerEventArgs> DrawingAttribution;

DrawnAttribution¶

public event EventHandler<DrawnAttributionLayerEventArgs> DrawnAttribution;

DrawingProgressChanged¶

public event EventHandler<DrawingProgressChangedEventArgs> DrawingProgressChanged;

RequestedDrawing¶

public event EventHandler<RequestedDrawingLayerEventArgs> RequestedDrawing;

RequestingDrawing¶

public event EventHandler<RequestingDrawingLayerEventArgs> RequestingDrawing;

DrawingException¶

public event EventHandler<DrawingExceptionLayerEventArgs> DrawingException;

DrawnException¶

public event EventHandler<DrawnExceptionLayerEventArgs> DrawnException;