This class is used to label features on the map.

• System.Object
  • ThinkGeo.MapSuite.Core.Style
    • ThinkGeo.MapSuite.Core.PositionStyle
      • ThinkGeo.MapSuite.Core.TextStyle
        • ThinkGeo.MapSuite.Core.IconStyle

TextStyle()

This is a constructor for the class.

If you use this constructor, you should set the required properties manually.

TextStyle(String,GeoFont,GeoSolidBrush)

This is a constructor for the class.

This constructor allows you to pass in the minimum required fields for labeling. You may want to explore the other properties to control how your labels look.

• textColumnName
  • Type:String
  • Description:This parameter is the name of the column that contains the text you want to draw.

• textFont
  • Type:GeoFont
  • Description:This parameter is the font used to draw the text.

• textSolidBrush
  • Type:GeoSolidBrush
  • Description:This parameter is the TextSolidBrush used to draw the text.

CloneDeep()

N/A

N/A

• Type:Style
• Description:N/A

Draw(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)

N/A

N/A

• Type:Void
• Description:N/A

• features
  • Type:IEnumerable<Feature>
  • Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

• labelsInThisLayer
  • Type:Collection<SimpleCandidate>
  • Description:N/A

• labelsInAllLayers
  • Type:Collection<SimpleCandidate>
  • Description:N/A

Draw(IEnumerable<BaseShape>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)

N/A

N/A

• Type:Void
• Description:N/A

• shapes
  • Type:IEnumerable<BaseShape>
  • Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

• labelsInThisLayer
  • Type:Collection<SimpleCandidate>
  • Description:N/A

• labelsInAllLayers
  • Type:Collection<SimpleCandidate>
  • Description:N/A

GetRequiredColumnNames()

N/A

N/A

• Type:Collection<String>
• Description:N/A

DrawSample(GeoCanvas,DrawingRectangleF)

N/A

N/A

• Type:Void
• Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

• drawingExtent
  • Type:DrawingRectangleF
  • Description:N/A

DrawSample(GeoCanvas)

N/A

N/A

• Type:Void
• Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

SaveStyle(String)

N/A

N/A

• Type:Void
• Description:N/A

• filePathName
  • Type:String
  • Description:N/A

SaveStyle(Stream)

N/A

N/A

• Type:Void
• Description:N/A

• stream
  • Type:Stream
  • Description:N/A

ToString()

N/A

N/A

• Type:String
• Description:N/A

Equals(Object)

N/A

N/A

• Type:Boolean
• Description:N/A

• obj
  • Type:Object
  • Description:N/A

GetHashCode()

N/A

N/A

• Type:Int32
• Description:N/A

GetType()

N/A

N/A

• Type:Type
• Description:N/A

DrawSampleCore(GeoCanvas,DrawingRectangleF)

This method draws a sample feature on the canvas you provided.

This virtual method is called from the concrete public method Draw. 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. When implementing this virtual method, consider the canvas size and draw the sample image appropriately. You should keep in mind that the sample typically shows up on a legend.

• Type:Void
• Description:None

• canvas
  • Type:GeoCanvas
  • Description:This parameter represents the canvas you want to draw the features on.

• drawingExtent
  • Type:DrawingRectangleF
  • Description:N/A

DrawCore(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)

N/A

N/A

• Type:Void
• Description:N/A

• features
  • Type:IEnumerable<Feature>
  • Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

• labelsInThisLayer
  • Type:Collection<SimpleCandidate>
  • Description:N/A

• labelsInAllLayers
  • Type:Collection<SimpleCandidate>
  • Description:N/A

GetRequiredColumnNamesCore()

N/A

N/A

• Type:Collection<String>
• Description:N/A

FilterFeatures(IEnumerable<Feature>,GeoCanvas)

N/A

N/A

• Type:Collection<Feature>
• Description:N/A

• features
  • Type:IEnumerable<Feature>
  • Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

FilterFeaturesCore(IEnumerable<Feature>,GeoCanvas)

N/A

N/A

• Type:Collection<Feature>
• Description:N/A

• features
  • Type:IEnumerable<Feature>
  • Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

AbbreviateText(Feature,GeoCanvas)

N/A

N/A

• Type:Void
• Description:N/A

• feature
  • Type:Feature
  • Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

AbbreviateTextCore(Feature,GeoCanvas)

N/A

N/A

• Type:Void
• Description:N/A

• feature
  • Type:Feature
  • Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

GetLabelingCandidates(Feature,GeoCanvas)

N/A

N/A

• Type:Collection<LabelingCandidate>
• Description:N/A

• feature
  • Type:Feature
  • Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

GetLabelingCandidateCore(Feature,GeoCanvas)

N/A

N/A

• Type:Collection<LabelingCandidate>
• Description:N/A

• feature
  • Type:Feature
  • Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

CheckDuplicate(LabelingCandidate,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)

N/A

N/A

• Type:Boolean
• Description:N/A

• labelingCandidate
  • Type:LabelingCandidate
  • Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

• labelsInThisLayer
  • Type:Collection<SimpleCandidate>
  • Description:N/A

• labelsInAllLayers
  • Type:Collection<SimpleCandidate>
  • Description:N/A

CheckDuplicateCore(LabelingCandidate,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)

N/A

N/A

• Type:Boolean
• Description:N/A

• labelingCandidate
  • Type:LabelingCandidate
  • Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

• labelsInThisLayer
  • Type:Collection<SimpleCandidate>
  • Description:N/A

• labelsInAllLayers
  • Type:Collection<SimpleCandidate>
  • Description:N/A

CheckOverlapping(LabelingCandidate,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)

N/A

N/A

• Type:Boolean
• Description:N/A

• labelingCandidate
  • Type:LabelingCandidate
  • Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

• labelsInThisLayer
  • Type:Collection<SimpleCandidate>
  • Description:N/A

• labelsInAllLayers
  • Type:Collection<SimpleCandidate>
  • Description:N/A

CheckOverlappingCore(LabelingCandidate,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)

N/A

N/A

• Type:Boolean
• Description:N/A

• labelingCandidate
  • Type:LabelingCandidate
  • Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

• labelsInThisLayer
  • Type:Collection<SimpleCandidate>
  • Description:N/A

• labelsInAllLayers
  • Type:Collection<SimpleCandidate>
  • Description:N/A

lD8=(PolygonShape,String,GeoCanvas)

N/A

N/A

• Type:LabelingCandidate
• Description:N/A

• polygon
  • Type:PolygonShape
  • Description:N/A

• text
  • Type:String
  • Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

Format(String,BaseShape)

N/A

N/A

• Type:String
• Description:N/A

• text
  • Type:String
  • Description:N/A

• labeledShape
  • Type:BaseShape
  • Description:N/A

FormatCore(String,BaseShape)

N/A

N/A

• Type:String
• Description:N/A

• text
  • Type:String
  • Description:N/A

• labeledShape
  • Type:BaseShape
  • Description:N/A

OnFormatting(FormattingPositionStyleEventArgs)

N/A

N/A

• Type:Void
• Description:N/A

• e
  • Type:FormattingPositionStyleEventArgs
  • Description:N/A

OnFormatted(FormattedPositionStyleEventArgs)

N/A

N/A

• Type:Void
• Description:N/A

• e
  • Type:FormattedPositionStyleEventArgs
  • Description:N/A

CloneDeepCore()

N/A

N/A

• Type:Style
• Description:N/A

Finalize()

N/A

N/A

• Type:Void
• Description:N/A

MemberwiseClone()

N/A

N/A

• Type:Object
• Description:N/A

XOffsetInPixel

This property gets and sets the X pixel offset for drawing each feature.

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.

• Type:Single

YOffsetInPixel

This property gets and sets the Y pixel offset for drawing each feature.

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.

• Type:Single

FittingLineInScreen

This property gets and sets whether the labeler will try to fit the label as best as it can on the visible part of a line on the screen.

A label will normally be displayed in the center of a line. If only a small piece of the line is visible on the screen, we cannot see it's label by default. If we set this property to ture though, the label will be displayed in the center of that piece in screen.

• Type:Boolean

FittingPolygonInScreen

This property gets and sets whether the labeler will try to fit the label as best as it can on the visible part of a polygon on the screen.

A label will normally be displayed in the center of a polygon. If only a small piece of the polygon is visible on the screen, we cannot see it's label by default. If we set this property to ture though, the label will be displayed in the center of that piece in screen.

• Type:Boolean

CustomTextStyles

This property returns a collection of area styles allowing you to stack multiple area styles on top of each other.

Using this collection, you can stack multiple area styles on top of each other. When we draw the features, 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.

• Type:Collection<TextStyle>

RotationAngle

This property gets and sets the rotation angle of the item being positioned.

None

• Type:Double

TextFormat

This property gets and sets the format that will be applied to the text.

With this property, you can apply formats to the text that is retrieved from the feature.

• Type:String

NumericFormat

This property gets and sets the format that will be applied to the text which can be parsed to double type.

With this property, you can apply formats to the text that is retrieved from the feature.

• Type:String

DateFormat

This property gets and sets the format that will be applied to the text which can be parsed to DateTime type.

With this property, you can apply formats to the text that is retrieved from the feature.

• Type:String

TextSolidBrush

This property gets and sets the SolidBrush that will be used to draw the text.

You can use this property to draw a solid color; however, if you need to use other brushes, you can access them through the Advanced property of this class.

• Type:GeoSolidBrush

Font

This property gets and sets the font that will be used to draw the text.

None

• Type:GeoFont

HaloPen

This property gets and sets the halo pen you may use to draw a halo around the text.

The halo pen allows you to draw a halo effect around the text, making it stand out more on a busy background.

• Type:GeoPen

TextColumnName

This property gets and sets the column name in the data that you want to get the text from.

This property is used when retrieving text from a feature. You will want to specify the name of the column that contains the text you want to draw.

• Type:String

Mask

This property gets and sets the AreaStyle used to draw a mask behind the text.

A mask is a plate behind the text that is rectangular and slightly larger than the width and height of the text. It allows the label to stand out well on a busy background. You can also try the HaloPen property instead of the mask, if the mask effect is too pronounced.

• Type:AreaStyle

MaskMargin

This property gets and sets the margin around the text that will be used for the mask.

This determines how much larger the mask is than the text, in pixels.

• Type:Int32

Advanced

This property gets the advanced properties of the class.

The advanced properties have been consolidated in the Advanced property. This way, the standard options are more easily visible and the advanced options are hidden away.

• Type:TextStyleAdvanced

ForceHorizontalLabelForLine

This property gets and sets whether we should force horizontal labeling for lines.

Normally, lines are labeled in the direction of the line. There may be some cases, however, when you want to have the line labeled horizontally regardless of the line's direction. In such a case, you can set this property to force the lines to be labeled horizontally.

• Type:Boolean

SplineType

Gets or sets the SplineType for labeling.

N/A

• Type:SplineType

DrawingLevel

Gets or sets the DrawingLavel for this style.

N/A

• Type:DrawingLevel

LabelPositions

Gets a value represents a keyValuepair which is a feature id and label position of the feature

N/A

• Type:Dictionary<String,WorldLabelingCandidate>

PolygonLabelingLocationMode

N/A

N/A

• Type:PolygonLabelingLocationMode

MaxNudgingInPixel

N/A

N/A

• Type:Int32

NudgingIntervalInPixel

N/A

N/A

• Type:Single

BestPlacementSymbolWidth

N/A

N/A

• Type:Single

BestPlacementSymbolHeight

N/A

N/A

• Type:Single

AbbreviationDictionary

N/A

N/A

• Type:Dictionary<String,String>

LeaderLineStyle

N/A

N/A

• Type:LineStyle

LeaderLineRule

N/A

N/A

• Type:LabelLeaderLinesRule

LeaderLineMinimumLengthInPixels

N/A

N/A

• Type:Single

GridSize

N/A

N/A

• Type:Int32

DuplicateRule

N/A

N/A

• Type:LabelDuplicateRule

OverlappingRule

N/A

N/A

• Type:LabelOverlappingRule

AllowLineCarriage

N/A

N/A

• Type:Boolean

SuppressPartialLabels

N/A

N/A

• Type:Boolean

ForceLineCarriage

N/A

N/A

• Type:Boolean

FittingPolygon

N/A

N/A

• Type:Boolean

LabelAllPolygonParts

N/A

N/A

• Type:Boolean

LabelAllLineParts

N/A

N/A

• Type:Boolean

FittingPolygonFactor

N/A

N/A

• Type:Double

TextLineSegmentRatio

N/A

N/A

• Type:Double

BestPlacement

N/A

N/A

• Type:Boolean

PointPlacement

N/A

N/A

• Type:PointPlacement

MaskType

N/A

N/A

• Type:MaskType

Name

N/A

N/A

• Type:String

IsActive

N/A

N/A

• Type:Boolean

RequiredColumnNames

N/A

N/A

• Type:Collection<String>

Filters

N/A

N/A

• Type:Collection<String>

AllowSpline

N/A

N/A

• Type:Boolean

uBs=

N/A

N/A

• Type:Boolean

FiltersCore

N/A

N/A

• Type:Collection<String>

Formatting N/A

N/A

Event Arguments:FormattingPositionStyleEventArgs

Formatted N/A

N/A

Event Arguments:FormattedPositionStyleEventArgs