TabFeatureLayer¶
Namespace: ThinkGeo.Core
Represents a feature layer that reads and writes MapInfo TAB datasets.
public class TabFeatureLayer : FeatureLayer, IFeatureLayer
Inheritance object → LayerBase → Layer → FeatureLayer → TabFeatureLayer
Implements IFeatureLayer
Properties¶
TabPathFilename¶
Gets or sets the full path to the TAB file associated with this layer.
public string TabPathFilename { get; set; }
Property Value¶
ReadWriteMode¶
Gets or sets the access mode used when opening the TAB file.
public FileAccess ReadWriteMode { get; set; }
Property Value¶
HasBoundingBox¶
Gets a value indicating that the layer always exposes a bounding box.
public bool HasBoundingBox { get; }
Property Value¶
StylingType¶
Gets or sets the styling mode used when drawing TAB features.
public TabStylingType StylingType { get; set; }
Property Value¶
RequireIndex¶
This property gets and sets whether an index is required when reading data. The default value is true.
public bool RequireIndex { get; set; }
Property Value¶
Encoding¶
Gets or sets the text encoding used when reading and writing attribute values.
public Encoding Encoding { get; set; }
Property Value¶
Projection¶
Gets the projection used by the underlying FeatureLayer.FeatureSource.
public Projection Projection { get; }
Property Value¶
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¶
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¶
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¶
Remarks:
Feature Layer. The QueryTools are supplied as an easily accessible wrapper for the query methods of the FeatureSource.
MaxRecordsToDraw¶
Gets or sets the maximum number of features that may be rendered per draw call.
public int MaxRecordsToDraw { get; set; }
Property Value¶
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¶
This property gets the general drawing quality for the FeatureLayer's
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¶
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.
LabelDisplayMode¶
Gets or sets the labeling strategy to apply when drawing this layer.
public LabelDisplayMode LabelDisplayMode { get; set; }
Property Value¶
DrawingMarginInPixel¶
Gets or sets the pixel margin applied when requesting data for this layer.
public float DrawingMarginInPixel { get; set; }
Property Value¶
RequestDrawingInterval¶
Gets or sets the interval between automatic draw requests. Obsolete.
public TimeSpan RequestDrawingInterval { get; set; }
Property Value¶
Name¶
Gets or sets the display name for the layer.
public string Name { get; set; }
Property Value¶
string
The name used to identify the layer within UI components such as legends.
Remarks:
The name is user defined. Assign a descriptive value so tooling such as legends and layer lists can surface a meaningful label to end users.
IsOpen¶
Gets a value indicating whether the layer is currently open.
public bool IsOpen { get; }
Property Value¶
bool
true if the layer has completed its open routine; otherwise, false.
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¶
Gets or sets a value indicating whether the layer is visible.
public bool IsVisible { get; set; }
Property Value¶
bool
true to draw the layer; otherwise, false.
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¶
Gets the last recorded drawing time for the layer.
public TimeSpan DrawingTime { get; protected set; }
Property Value¶
TimeSpan
The duration of the most recent draw operation.
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¶
Gets or sets how drawing exceptions are handled when the layer renders.
public DrawingExceptionMode DrawingExceptionMode { get; set; }
Property Value¶
Background¶
Gets or sets the background color used when rendering the layer.
public GeoColor Background { get; set; }
Property Value¶
GeoColor
The fill applied to areas not covered by layer content.
Transparency¶
Gets or sets the amount of transparency applied to the rendered image.
public float Transparency { get; set; }
Property Value¶
float
A value between 0 (fully transparent) and 255 (fully opaque).
BlueTranslation¶
Gets or sets the intensity adjustment applied to the blue channel.
public float BlueTranslation { get; set; }
Property Value¶
float
A value between -255 and 255 representing the blue channel translation.
RedTranslation¶
Gets or sets the intensity adjustment applied to the red channel.
public float RedTranslation { get; set; }
Property Value¶
float
A value between -255 and 255 representing the red channel translation.
GreenTranslation¶
Gets or sets the intensity adjustment applied to the green channel.
public float GreenTranslation { get; set; }
Property Value¶
float
A value between -255 and 255 representing the green channel translation.
KeyColors¶
Gets the collection of key colors that should be rendered as transparent.
public Collection<GeoColor> KeyColors { get; }
Property Value¶
Remarks:
Attempting to access this collection when the associated GeoCanvas does not support key colors (see GeoCanvas.SupportKeyColor) results in an exception. Add colors to this collection to ensure they render as transparent.
IsNegative¶
Gets or sets a value indicating whether the image should be rendered with inverted colors.
public bool IsNegative { get; set; }
Property Value¶
bool
true to invert the color channels; otherwise, false.
IsGrayscale¶
Gets or sets a value indicating whether the image should be converted to grayscale prior to rendering.
public bool IsGrayscale { get; set; }
Property Value¶
bool
true to apply a grayscale filter; otherwise, false.
ThreadSafe¶
Gets or sets the threading guarantees provided by the layer implementation.
public ThreadSafetyLevel ThreadSafe { get; set; }
Property Value¶
ThreadSafetyLevel
The level of thread safety that callers can expect when interacting with the layer.
ColorMappings¶
Gets the color translation map that will be applied when rendering the layer.
public Dictionary<GeoColor, GeoColor> ColorMappings { get; }
Property Value¶
Dictionary<GeoColor, GeoColor>
WrappingMode¶
Gets or sets how the layer wraps when the map extent crosses world boundaries.
public WrappingMode WrappingMode { get; set; }
Property Value¶
WrappingExtent¶
Gets or sets the geographic extent to use when wrapping is enabled.
public RectangleShape WrappingExtent { get; set; }
Property Value¶
Constructors¶
TabFeatureLayer()¶
Initializes a new instance of the TabFeatureLayer class with default settings.
public TabFeatureLayer()
TabFeatureLayer(string)¶
Initializes a new instance of the TabFeatureLayer class for the specified TAB file.
public TabFeatureLayer(string tabPathFilename)
Parameters¶
tabPathFilename string
The full path of the TAB file to open.
TabFeatureLayer(string, FileAccess)¶
Initializes a new instance of the TabFeatureLayer class using the specified file and access mode.
public TabFeatureLayer(string tabPathFilename, FileAccess readWriteMode)
Parameters¶
tabPathFilename string
The full path of the TAB file to open.
readWriteMode FileAccess
The desired file access, such as or .
Methods¶
CloneDeepCore()¶
Provides the overridable implementation that performs clone deep.
protected LayerBase CloneDeepCore()
Returns¶
LayerBase
The result of the operation.
Ah0=(Byte[], int)¶
internal static WkbShapeType Ah0=(Byte[] wkb, int startIndex)
Parameters¶
wkb Byte[]
startIndex int
Returns¶
CreateTabFile(string, IEnumerable<TabDbfColumn>, IEnumerable<Feature>)¶
Creates a new TAB file using the specified schema and features.
public static void CreateTabFile(string tabPathFilename, IEnumerable<TabDbfColumn> databaseColumns, IEnumerable<Feature> features)
Parameters¶
tabPathFilename string
The full path of the TAB file to create.
databaseColumns IEnumerable<TabDbfColumn>
The column definitions that make up the TAB schema.
features IEnumerable<Feature>
The collection of features to write to the TAB file.
Returns¶
CreateTabFile(string, IEnumerable<TabDbfColumn>, IEnumerable<Feature>, OverwriteMode)¶
Creates a new TAB file using the specified schema, features, and overwrite behavior.
public static void CreateTabFile(string tabPathFilename, IEnumerable<TabDbfColumn> databaseColumns, IEnumerable<Feature> features, OverwriteMode overwriteMode)
Parameters¶
tabPathFilename string
The full path of the TAB file to create.
databaseColumns IEnumerable<TabDbfColumn>
The column definitions that make up the TAB schema.
features IEnumerable<Feature>
The collection of features to write to the TAB file.
overwriteMode OverwriteMode
Specifies how to handle existing files at the same location.
Returns¶
CreateTabFile(string, IEnumerable<TabDbfColumn>, IEnumerable<Feature>, OverwriteMode, Encoding)¶
Creates a new TAB file using the specified schema, features, overwrite behavior, and text encoding.
public static void CreateTabFile(string tabPathFilename, IEnumerable<TabDbfColumn> databaseColumns, IEnumerable<Feature> features, OverwriteMode overwriteMode, Encoding encoding)
Parameters¶
tabPathFilename string
The full path of the TAB file to create.
databaseColumns IEnumerable<TabDbfColumn>
The column definitions that make up the TAB schema.
features IEnumerable<Feature>
The collection of features to write to the TAB file.
overwriteMode OverwriteMode
Specifies how to handle existing files at the same location.
encoding Encoding
The text encoding to apply when writing attribute values.
Returns¶
BuildIndexFile(string)¶
Builds or rebuilds the index file associated with the specified TAB dataset using the default rebuild mode.
public static void BuildIndexFile(string tabPathFilename)
Parameters¶
tabPathFilename string
The full path of the TAB file whose index should be built.
Returns¶
BuildIndexFile(string, BuildIndexMode)¶
Builds or rebuilds the index file associated with the specified TAB dataset.
public static void BuildIndexFile(string tabPathFilename, BuildIndexMode buildIndexMode)
Parameters¶
tabPathFilename string
The full path of the TAB file whose index should be built.
buildIndexMode BuildIndexMode
Determines how the index should be rebuilt.
Returns¶
BuildRecordIdColumn(string, string, BuildRecordIdMode)¶
Adds or rebuilds a record identifier column in the specified TAB dataset.
public static void BuildRecordIdColumn(string tabFileName, string fieldName, BuildRecordIdMode buildRecordIdMode)
Parameters¶
tabFileName string
The full path of the TAB file to update.
fieldName string
The name of the field that will contain the record identifier.
buildRecordIdMode BuildRecordIdMode
Specifies how the record identifier should be generated.
Returns¶
BuildRecordIdColumn(string, string, BuildRecordIdMode, int)¶
Adds or rebuilds a record identifier column in the specified TAB dataset, starting from the provided number.
public static void BuildRecordIdColumn(string tabFileName, string fieldName, BuildRecordIdMode buildRecordIdMode, int startNumber)
Parameters¶
tabFileName string
The full path of the TAB file to update.
fieldName string
The name of the field that will contain the record identifier.
buildRecordIdMode BuildRecordIdMode
Specifies how the record identifier should be generated.
startNumber int
The starting value for the new record identifiers.
Returns¶
BuildRecordIdColumn(string, string, BuildRecordIdMode, int, Encoding)¶
Adds or rebuilds a record identifier column in the specified TAB dataset using the provided start value and encoding.
public static void BuildRecordIdColumn(string tabFileName, string fieldName, BuildRecordIdMode buildRecordIdMode, int startNumber, Encoding encoding)
Parameters¶
tabFileName string
The full path of the TAB file to update.
fieldName string
The name of the field that will contain the record identifier.
buildRecordIdMode BuildRecordIdMode
Specifies how the record identifier should be generated.
startNumber int
The starting value for the new record identifiers.
encoding Encoding
The encoding to use when writing the identifier values.
Returns¶
DrawCore(GeoCanvas, Collection<SimpleCandidate>)¶
Provides the overridable implementation that draws onto and appends any label candidates to .
protected void DrawCore(GeoCanvas canvas, Collection<SimpleCandidate> labelsInAllLayers)
Parameters¶
canvas GeoCanvas
The to draw to.
labelsInAllLayers Collection<SimpleCandidate>
A shared collection that receives label candidates generated during drawing.
Returns¶
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¶
Raised when wrapping features are about to be drawn. Deprecated; use FeatureLayer.DrawingFeatures instead.
public event EventHandler<DrawingWrappingFeaturesFeatureLayerEventArgs> DrawingWrappingFeatures;
DrawingProgressChanged¶
Occurs as the layer reports drawing progress (useful for async or tiled rendering scenarios).
public event EventHandler<DrawingProgressChangedEventArgs> DrawingProgressChanged;
RequestedDrawing¶
Raised after the drawing buffer elapses so consumers can handle a legacy drawing cycle. Obsolete.
public event EventHandler<RequestedDrawingLayerEventArgs> RequestedDrawing;
RequestingDrawing¶
Raised before the drawing buffer elapses so consumers can cancel a legacy drawing operation. Obsolete.
public event EventHandler<RequestingDrawingLayerEventArgs> RequestingDrawing;
DrawingException¶
Occurs when the DrawingException event is raised.
public event EventHandler<DrawingExceptionLayerEventArgs> DrawingException;
DrawnException¶
Occurs when the DrawnException event is raised.
public event EventHandler<DrawnExceptionLayerEventArgs> DrawnException;