WellPointStyle¶
Namespace: ThinkGeo.Core
Represents the WellPointStyle class.
public class WellPointStyle : PointBaseStyle
Inheritance object → Style → PointBaseStyle → WellPointStyle
Properties¶
WellPointIndex¶
This property gets or sets the index of the well point style, it is an integer between 1 and 186
public int WellPointIndex { get; set; }
Property Value¶
DrawingLevel¶
Gets or sets the drawing level used when rendering this point style.
public DrawingLevel DrawingLevel { get; set; }
Property Value¶
FillBrush¶
This property gets and sets the SolidBrush used to color the interior of the Symbol.
public GeoBrush FillBrush { get; set; }
Property Value¶
This property gets the SolidBrush used to color the interior of the
Remarks:
This brush is used to draw the interior of the symbol. It is only used if the PointType is Symbol. If you need a brush other than the SolidBrush, you should look in the advanced property of the class.
OutlinePen¶
This property gets and sets the SolidBrush used to draw the oultine of the Symbol.
public GeoPen OutlinePen { get; set; }
Property Value¶
GeoPen
This property gets the SolidBrush used to draw the outline of the Symbol.
Remarks:
This pen is used to draw the outline of the Symbol. By default the pen draws a transparent (invisible) color, which just leaves you with a fill.
SymbolSize¶
This property gets and sets the size of the symbol if the PointType is Symbol.
public float SymbolSize { get; set; }
Property Value¶
float
This property gets the size of the symbol if the PointType is Symbol.
Remarks:
The allows you to make the symbol larger and smaller.
RotationAngle¶
This property gets and sets the angle of rotation for the drawing of the point.
public float RotationAngle { get; set; }
Property Value¶
float
This property gets the angle of rotation for the drawing of the point.
Remarks:
This property controls the rotation of the bitmap, character or symbol, depending on the PointType.
XOffsetInPixel¶
This property gets and sets the X pixel offset for drawing each feature.
public float XOffsetInPixel { get; set; }
Property Value¶
float
This property gets the X pixel offset for drawing each feature.
Remarks:
This property allows you to specify an X offset. When combined with a Y offset, it is useful to allow you to achieve effects such as drop shadows, etc. There also may be times when you need to modify the location of feature data so as to better align it with raster satellite data.
YOffsetInPixel¶
This property gets and sets the Y pixel offset for drawing each feature.
public float YOffsetInPixel { get; set; }
Property Value¶
float
This property gets the Y pixel offset for drawing each feature.
Remarks:
This property allows you to specify a Y offset. When combined with an X offset, it is useful to allow you to achieve effects such as drop shadows, etc. There also may be times when you need to modify the location of feature data so as to better align it with raster satellite data.
CustomPointStyles¶
This property returns a collection of area styles allowing you to stack multiple area styles on top of each other.
public Collection<PointBaseStyle> CustomPointStyles { get; }
Property Value¶
Collection<PointBaseStyle>
This property returns a collection of area styles.
Remarks:
Using this collection, you can stack multiple styles on top of each other. When we draw the feature, we will draw them in order that they exist in the collection. You can use these stacks to create drop shadow effects, multiple colored outlines, etc.
Name¶
This property gets and set the name of the style.
public string Name { get; set; }
Property Value¶
string
This property gets the name of the style.
Remarks:
This name is not used by the system; it is only for the developer. However, it can be used if you generate your own legend.
IsActive¶
This property gets and sets the active status of the style.
public bool IsActive { get; set; }
Property Value¶
bool
This property gets the active status of the style.
Remarks:
If the style is not active then it will not draw.
RequiredColumnNames¶
This property gets the collection of fields that are required for the style.
public Collection<string> RequiredColumnNames { get; }
Property Value¶
Remarks:
This property gets the collection of fields that are required for the style. These are in addition to any other columns you specify in styles that inherit from this one. For example, if you have use a ValueStyle and it requires a column name for the value comparison, then that column does not need to be in this collection. You only use the RequiredColumnNames for columns you need beyond those required by specific inherited styles.
Filters¶
Gets the list of SQL-style filters applied to this style.
public Collection<string> Filters { get; }
Property Value¶
LabelDisplayMode¶
Gets the current label display mode that determines whether labels, shapes, or both are rendered.
public LabelDisplayMode LabelDisplayMode { get; }
Property Value¶
Constructors¶
WellPointStyle()¶
This is the default constructor for the class.
public WellPointStyle()
WellPointStyle(int)¶
This is the constructor for the class.
public WellPointStyle(int wellPointIndex)
Parameters¶
wellPointIndex int
This parameter is the index of the well point style, it would be between 1 and 186
WellPointStyle(int, int, GeoBrush)¶
This is the constructor for the class.
public WellPointStyle(int wellPointIndex, int symbolSize, GeoBrush fillBrush)
Parameters¶
wellPointIndex int
This parameter is the index of the well point style, it would be between 1 and 186
symbolSize int
This parameter is the size of the well point.
fillBrush GeoBrush
This parameter is the brush used to draw the well point style.
WellPointStyle(int, int, GeoBrush, GeoPen)¶
This is the constructor for the class.
public WellPointStyle(int wellPointIndex, int symbolSize, GeoBrush fillBrush, GeoPen outlinePen)
Parameters¶
wellPointIndex int
This parameter is the index of the well point style, it would be between 1 and 186
symbolSize int
This parameter is the size of the well point.
fillBrush GeoBrush
This parameter is the brush used to draw the well point style.
outlinePen GeoPen
This parameter is the pen used to draw the well point style.
Methods¶
DrawCore(IEnumerable<Feature>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate>)¶
Provides the overridable implementation that draws onto and appends any label candidates to .
protected void DrawCore(IEnumerable<Feature> features, GeoCanvas canvas, Collection<SimpleCandidate> labelsInThisLayer, Collection<SimpleCandidate> labelsInAllLayers)
Parameters¶
features IEnumerable<Feature>
The features.
canvas GeoCanvas
The to draw to.
labelsInThisLayer Collection<SimpleCandidate>
The labels in this layer.
labelsInAllLayers Collection<SimpleCandidate>
A shared collection that receives label candidates generated during drawing.
Returns¶
DrawSampleCore(GeoCanvas, DrawingRectangleF)¶
This method draws a sample feature on the view you provided.
protected void DrawSampleCore(GeoCanvas canvas, DrawingRectangleF drawingExtent)
Parameters¶
canvas GeoCanvas
This parameter represents the view you want to draw the features on.
drawingExtent DrawingRectangleF
Specifies the drawingExtent.
Returns¶
void
None
Exceptions¶
ArgumentNullException
If you pass a null as the view, we will throw an ArgumentNullException.
InvalidOperationException
In the event you attempt to call this method when the GeoCanvas's IsDrawing mode is false, it will throw an InvalidOperationException.
Remarks:
This virtual method is called from the concrete public method Draw. In this method, we draw a sample style on the view you provided. This is typically used to display a legend or other sample area.
When implementing this virtual method, consider the view size and draw the sample image appropriately. You should keep in mind that the sample typically shows up on a legend.