ThinkGeo Cloud
ThinkGeo UI Controls
ThinkGeo Open Source
Help and Support
External Resources
Sidebar
thinkgeo.mapsuite.core.fontpointstyle
Table of Contents
ThinkGeo.MapSuite.Core.FontPointStyle
Note: The page was created before Map Suite 10. Map Suite 10.0 organized many classes into new namespaces and assemblies as well as had a few minor breaks in compatibility. The majority of previously built code should work without modification assuming the new namespaces are added. For guidance on upgrading your existing code, please check out MapSuite 10 Upgrade Guide.
<!– Class –>
Inheritance Hierarchy
*System.Object ThinkGeo.MapSuite.Core.Style *ThinkGeo.MapSuite.Core.PointBaseStyle ThinkGeo.MapSuite.Core.PointStyle *ThinkGeo.MapSuite.Core.FontPointStyle
Members Summary
Public Constructors
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 FontPointStyle |
Protected Constructors
| Name | Parameters | DeclaringType | Summary |
|---|
Public Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
| CloneDeep | Style | Create a copy of style using the deep clone process. | |
| Draw | IEnumerable<Feature>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate> | Style | This method draws the features on the canvas you provided. |
| Draw | IEnumerable<BaseShape>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate> | Style | This method draws the shapes on the canvas you provided. |
| DrawSample | GeoCanvas, DrawingRectangleF | Style | This method draws a sample feature on the canvas you provided. |
| DrawSample | GeoCanvas | Style | |
| Equals | Object | Object | |
| GetHashCode | Object | ||
| GetRequiredColumnNames | Style | This method returns the column data for each feature that is required for the style to properly draw. | |
| GetType | Object | ||
 LoadStyle | Uri | Style | |
| LoadStyle | Stream | Style | |
| ToString | Object |
Protected Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 CloneDeepCore | Style | Create a copy of style using the deep clone process. The default implementation method uses serialization. | |
| DrawCore | IEnumerable<Feature>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate> | Style(overriden) | |
| DrawSampleCore | GeoCanvas, DrawingRectangleF | Style(overriden) | |
| Finalize | Object | ||
| GetRequiredColumnNamesCore | Style | This method returns the column data for each feature that is required for the style to properly draw. | |
| MemberwiseClone | Object |
Public Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 Advanced | PointStyleAdvanced | PointBaseStyle | |
| CharacterFont | GeoFont | PointStyle | This property gets and sets the font that is used for the character if the PointType is Character. |
| CharacterIndex | Int32 | PointStyle | This property gets and sets the index position of the character you want to use from the font you selected in the CharacterFont property. |
| CharacterSolidBrush | GeoSolidBrush | PointStyle | This property gets and sets the SolidBrush used to color the font character for the point. |
| CustomPointStyles | Collection<PointBaseStyle> | PointStyle | This property returns a collection of area styles allowing you to stack multiple area styles on top of each other. |
| DrawingLevel | DrawingLevel | PointBaseStyle | |
| Filters | Collection<String> | Style | |
| Image | GeoImage | PointStyle | This property gets and sets the image used if the PointType property is Bitmap. |
| ImageScale | Double | PointStyle | This property gets and sets the scale of the image you want to draw. |
| IsActive | Boolean | Style | This property gets and sets the active status of the style. |
| Name | String | Style | This property gets and set the name of the style. |
| PointType | PointType | PointStyle | This property gets and sets the type of point you want to draw. |
| RequiredColumnNames | Collection<String> | Style | This property gets the collection of fields that are required for the style. |
| RotationAngle | Single | PointBaseStyle | This property gets and sets the angle of rotation for the drawing of the point. |
| SymbolPen | GeoPen | PointBaseStyle | This property gets and sets the SolidBrush used to draw the oultine of the Symbol. |
| SymbolSize | Single | PointBaseStyle | This property gets and sets the size of the symbol if the PointType is Symbol. |
| SymbolSolidBrush | GeoSolidBrush | PointBaseStyle | This property gets and sets the SolidBrush used to color the interior of the Symbol. |
| SymbolType | PointSymbolType | PointStyle | This property gets and sets the type of symbol you want to use if the PointType is Symbol. |
| XOffsetInPixel | Single | PointBaseStyle | This property gets and sets the X pixel offset for drawing each feature. |
| YOffsetInPixel | Single | PointBaseStyle | This property gets and sets the Y pixel offset for drawing each feature. |
Protected Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 FiltersCore | Collection<String> | Style |
Public Events
| Name | Event Arguments | DeclaringType | Summary |
|---|
Public Constructors
FontPointStyle()
Parameters
| Name | Type | Description |
|---|
Protected Constructors
Public Methods
CloneDeep()
Create a copy of style using the deep clone process.
Remarks
The difference between deep clone and shallow clone is as follows: In shallow cloning, only the object is copied; the objects within it are not. By contrast, deep cloning copies the cloned object as well as all the objects within.
Return Value
| Return Type | Description |
|---|---|
| Style<!– ThinkGeo.MapSuite.Core.Style –> | A cloned style. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.Style –> Go Back
Draw(IEnumerable<Feature>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate>)
This method draws the features on the canvas you provided.
Remarks
This method is the concrete wrapper for the abstract method DrawCore. In this method, we take the features you passed in and draw them on the canvas you provided. Each style (based on its properties) may draw each feature differently.
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<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| features | IEnumerable<Feature><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.Feature} –> | This parameter represents the features you want to draw on the canvas. |
| canvas | GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> | This parameter represents the canvas you want to draw the features on. |
| labelsInThisLayer | Collection<SimpleCandidate><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} –> | The labels will be drawn in the current layer only. |
| labelsInAllLayers | Collection<SimpleCandidate><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} –> | The labels will be drawn in all layers. |
<!– ThinkGeo.MapSuite.Core.Style –> Go Back
Draw(IEnumerable<BaseShape>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate>)
This method draws the shapes on the canvas you provided.
Remarks
This method is the concrete wrapper for the abstract method DrawCore. In this method, we take the shapes you passed in and draw them on the canvas you provided. Each style (based on its properties) may draw each shape differently.
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<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| shapes | IEnumerable<BaseShape><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.BaseShape} –> | This parameter represents the shapes you want to draw on the canvas. |
| canvas | GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> | This parameter represents the canvas you want to draw the shapes on. |
| labelsInThisLayer | Collection<SimpleCandidate><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} –> | The labels will be drawn in the current layer only. |
| labelsInAllLayers | Collection<SimpleCandidate><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} –> | The labels will be drawn in all layers. |
<!– ThinkGeo.MapSuite.Core.Style –> Go Back
DrawSample(GeoCanvas, DrawingRectangleF)
This method draws a sample feature on the canvas you provided.
Remarks
This method is the concrete wrapper for the abstract method DrawSampleCore. In this method we draw a sample style on the canvas you provided. This is typically used to display a legend or other sample area.
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<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| canvas | GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> | This parameter represents the canvas you want to draw the features on. |
| drawingExtent | DrawingRectangleF<!– ThinkGeo.MapSuite.Core.DrawingRectangleF –> |
<!– ThinkGeo.MapSuite.Core.Style –> Go Back
DrawSample(GeoCanvas)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| canvas | GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> |
<!– ThinkGeo.MapSuite.Core.Style –> Go Back
Equals(Object)
Return Value
| Return Type | Description |
|---|---|
| Boolean<!– System.Boolean –> |
Parameters
| Name | Type | Description |
|---|---|---|
| obj | Object<!– System.Object –> |
<!– System.Object –> Go Back
GetHashCode()
Return Value
| Return Type | Description |
|---|---|
| Int32<!– System.Int32 –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
GetRequiredColumnNames()
This method returns the column data for each feature that is required for the style to properly draw.
Remarks
This method is the concrete wrapper for the abstract method GetRequiredColumnNamesCore. In this method, we return the column names that are required for the style to draw the feature properly. For example, if you have a style that colors areas blue when a certain column value is over 100, then you need to be sure you include that column name. This will ensure that the column data is returned to you in the feature when it is ready to draw.
In many of the styles, we add properties to allow the user to specify which field they need; then, in the GetRequiredColumnNamesCore we read that property and add it to the collection.
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 |
|---|---|
| Collection<String><!– System.Collections.ObjectModel.Collection{System.String} –> | This method returns a collection of column names that the style needs. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.Style –> Go Back
GetType()
Return Value
| Return Type | Description |
|---|---|
| Type<!– System.Type –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
LoadStyle(Uri)
<!– static –>
Return Value
| Return Type | Description |
|---|---|
| Style<!– ThinkGeo.MapSuite.Core.Style –> |
Parameters
| Name | Type | Description |
|---|---|---|
| styleUri | Uri<!– System.Uri –> |
<!– ThinkGeo.MapSuite.Core.Style –> Go Back
LoadStyle(Stream)
<!– static –>
Return Value
| Return Type | Description |
|---|---|
| Style<!– ThinkGeo.MapSuite.Core.Style –> |
Parameters
| Name | Type | Description |
|---|---|---|
| styleStream | Stream<!– System.IO.Stream –> |
<!– ThinkGeo.MapSuite.Core.Style –> Go Back
ToString()
Return Value
| Return Type | Description |
|---|---|
| String<!– System.String –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
Protected Methods
CloneDeepCore()
Create a copy of style using the deep clone process. The default implementation method uses serialization.
Remarks
The difference between deep clone and shallow clone is as follows: In shallow cloning, only the object is copied; the objects within it are not. By contrast, deep cloning copies the cloned object as well as all the objects within.
Return Value
| Return Type | Description |
|---|---|
| Style<!– ThinkGeo.MapSuite.Core.Style –> | A cloned style. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.Style –> Go Back
DrawCore(IEnumerable<Feature>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate>)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| features | IEnumerable<Feature><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.Feature} –> | |
| canvas | GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> | |
| labelsInThisLayer | Collection<SimpleCandidate><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} –> | |
| labelsInAllLayers | Collection<SimpleCandidate><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} –> |
<!– ThinkGeo.MapSuite.Core.Style(overriden) –> Go Back
DrawSampleCore(GeoCanvas, DrawingRectangleF)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| canvas | GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> | |
| drawingExtent | DrawingRectangleF<!– ThinkGeo.MapSuite.Core.DrawingRectangleF –> |
<!– ThinkGeo.MapSuite.Core.Style(overriden) –> Go Back
Finalize()
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
GetRequiredColumnNamesCore()
This method returns the column data for each feature that is required for the style to properly draw.
Remarks
This abstract method is called from the concrete public method GetRequiredFieldNames. In this method, we return the column names that are required for the style to draw the feature properly. For example, if you have a style that colors areas blue when a certain column value is over 100, then you need to be sure you include that column name. This will ensure that the column data is returned to you in the feature when it is ready to draw.
In many of the styles, we add properties to allow the user to specify which field they need; then, in the GetRequiredColumnNamesCore we read that property and add it to the collection.
Return Value
| Return Type | Description |
|---|---|
| Collection<String><!– System.Collections.ObjectModel.Collection{System.String} –> | This method returns a collection of column names that the style needs. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.Core.Style –> Go Back
MemberwiseClone()
Return Value
| Return Type | Description |
|---|---|
| Object<!– System.Object –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
Public Properties
Advanced
Return Value
| Return Type |
|---|
| PointStyleAdvanced<!– ThinkGeo.MapSuite.Core.PointStyleAdvanced –> |
<!– ThinkGeo.MapSuite.Core.PointBaseStyle –> Go Back
CharacterFont
This property gets and sets the font that is used for the character if the PointType is Character.
Remarks
This property allows you to set the font from which to select a character index if you choose the Character PointType.
Return Value
| Return Type |
|---|
| GeoFont<!– ThinkGeo.MapSuite.Core.GeoFont –> |
<!– ThinkGeo.MapSuite.Core.PointStyle –> Go Back
CharacterIndex
This property gets and sets the index position of the character you want to use from the font you selected in the CharacterFont property.
Remarks
You need to specify the index position of the character you want to use from the font you selected. For example, if you choose 1, then we will use the first character in the font you set in the CharacterFont property.
Return Value
| Return Type |
|---|
| Int32<!– System.Int32 –> |
<!– ThinkGeo.MapSuite.Core.PointStyle –> Go Back
CharacterSolidBrush
This property gets and sets the SolidBrush used to color the font character for the point.
Remarks
This brush is used to draw the character. It is only used if the PointType is Character. If you need a brush other than the SolidBrush, you should look in the advanced property of the class.
Return Value
| Return Type |
|---|
| GeoSolidBrush<!– ThinkGeo.MapSuite.Core.GeoSolidBrush –> |
<!– ThinkGeo.MapSuite.Core.PointStyle –> Go Back
CustomPointStyles
This property returns a collection of area styles allowing you to stack multiple area styles on top of each other.
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.
Return Value
| Return Type |
|---|
| Collection<PointBaseStyle><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.PointBaseStyle} –> |
<!– ThinkGeo.MapSuite.Core.PointStyle –> Go Back
DrawingLevel
Return Value
| Return Type |
|---|
| DrawingLevel<!– ThinkGeo.MapSuite.Core.DrawingLevel –> |
<!– ThinkGeo.MapSuite.Core.PointBaseStyle –> Go Back
Filters
Return Value
| Return Type |
|---|
| Collection<String><!– System.Collections.ObjectModel.Collection{System.String} –> |
<!– ThinkGeo.MapSuite.Core.Style –> Go Back
Image
This property gets and sets the image used if the PointType property is Bitmap.
Remarks
This property is where you can set the image for the points if the PointType is Bitmap. It uses a GeoImage, so you can either reference a file or supply a stream.
Return Value
| Return Type |
|---|
| GeoImage<!– ThinkGeo.MapSuite.Core.GeoImage –> |
<!– ThinkGeo.MapSuite.Core.PointStyle –> Go Back
ImageScale
This property gets and sets the scale of the image you want to draw.
Remarks
This property allows you to scale the image up and down depending on how large or small you want it. It can be changed dynamically, so you could change it at every scale level to resize the bitmap based on the current scale. A scale of 1 would be the original size, while a scale of 2 would double the size. A scale of .5 would reduce the size of the image by half, and so on.
Return Value
| Return Type |
|---|
| Double<!– System.Double –> |
<!– ThinkGeo.MapSuite.Core.PointStyle –> Go Back
IsActive
This property gets and sets the active status of the style.
Remarks
If the style is not active then it will not draw.
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.Core.Style –> Go Back
Name
This property gets and set 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.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.Core.Style –> Go Back
PointType
This property gets and sets the type of point you want to draw.
Remarks
When using the PointStyle you choose between a bitmap, a font or a predefined symbol to represent the point. Each of these options has corresponding properties on the point symbol. If you set the type to character, then you need to set the properties that start with “Character,” such as “CharacterFont.” The same is true for the symbol.
Return Value
| Return Type |
|---|
| PointType<!– ThinkGeo.MapSuite.Core.PointType –> |
<!– ThinkGeo.MapSuite.Core.PointStyle –> Go Back
RequiredColumnNames
This property gets the collection of fields that are required for the style.
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.
Return Value
| Return Type |
|---|
| Collection<String><!– System.Collections.ObjectModel.Collection{System.String} –> |
<!– ThinkGeo.MapSuite.Core.Style –> Go Back
RotationAngle
This property gets and sets 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.
Return Value
| Return Type |
|---|
| Single<!– System.Single –> |
<!– ThinkGeo.MapSuite.Core.PointBaseStyle –> Go Back
SymbolPen
This property gets and sets the SolidBrush used to draw the oultine 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.
Return Value
| Return Type |
|---|
| GeoPen<!– ThinkGeo.MapSuite.Core.GeoPen –> |
<!– ThinkGeo.MapSuite.Core.PointBaseStyle –> Go Back
SymbolSize
This property gets and sets the size of the symbol if the PointType is Symbol.
Remarks
The allows you to make the symbol larger and smaller.
Return Value
| Return Type |
|---|
| Single<!– System.Single –> |
<!– ThinkGeo.MapSuite.Core.PointBaseStyle –> Go Back
SymbolSolidBrush
This property gets and sets the SolidBrush used to color the interior of the Symbol.
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.
Return Value
| Return Type |
|---|
| GeoSolidBrush<!– ThinkGeo.MapSuite.Core.GeoSolidBrush –> |
<!– ThinkGeo.MapSuite.Core.PointBaseStyle –> Go Back
SymbolType
This property gets and sets the type of symbol you want to use if the PointType is Symbol.
Remarks
You can choose between a number of predefined symbols. The symbols are simple geometric objects that are typically used for abstract representations on a map. If there is a specific symbol you need that is not part of our symbol collection, you can submit it to us and we will consider adding it.
Return Value
| Return Type |
|---|
| PointSymbolType<!– ThinkGeo.MapSuite.Core.PointSymbolType –> |
<!– ThinkGeo.MapSuite.Core.PointStyle –> Go Back
XOffsetInPixel
This property gets and sets 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.
Return Value
| Return Type |
|---|
| Single<!– System.Single –> |
<!– ThinkGeo.MapSuite.Core.PointBaseStyle –> Go Back
YOffsetInPixel
This property gets and sets 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.
Return Value
| Return Type |
|---|
| Single<!– System.Single –> |
<!– ThinkGeo.MapSuite.Core.PointBaseStyle –> Go Back
Protected Properties
FiltersCore
Return Value
| Return Type |
|---|
| Collection<String><!– System.Collections.ObjectModel.Collection{System.String} –> |
<!– ThinkGeo.MapSuite.Core.Style –> Go Back
Public Events
thinkgeo.mapsuite.core.fontpointstyle.txt · Last modified: 2017/03/16 21:59 (external edit)