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

AbbreviationDictionary

• Return:Dictionary<String,String>
• Summary:N/A

Advanced

• Return:TextStyleAdvanced
• Summary:This property gets the advanced properties of the class.

AllowLineCarriage

• Return:Boolean
• Summary:N/A

BestPlacement

• Return:Boolean
• Summary:N/A

BestPlacementSymbolHeight

• Return:Single
• Summary:N/A

BestPlacementSymbolWidth

• Return:Single
• Summary:N/A

CustomTextStyles

• Return:Collection<TextStyle>
• Summary:This property returns a collection of area styles allowing you to stack multiple area styles on top of each other.

DateFormat

• Return:String
• Summary:This property gets and sets the format that will be applied to the text which can be parsed to DateTime type.

DrawingLevel

• Return:DrawingLevel
• Summary:Gets or sets the DrawingLavel for this style.

DuplicateRule

• Return:LabelDuplicateRule
• Summary:N/A

Filters

• Return:Collection<String>
• Summary:N/A

FittingLineInScreen

• Return:Boolean
• Summary: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.

FittingPolygon

• Return:Boolean
• Summary:N/A

FittingPolygonFactor

• Return:Double
• Summary:N/A

FittingPolygonInScreen

• Return:Boolean
• Summary: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.

Font

• Return:GeoFont
• Summary:This property gets and sets the font that will be used to draw the text.

ForceHorizontalLabelForLine

• Return:Boolean
• Summary:This property gets and sets whether we should force horizontal labeling for lines.

ForceLineCarriage

• Return:Boolean
• Summary:N/A

GridSize

• Return:Int32
• Summary:N/A

HaloPen

• Return:GeoPen
• Summary:This property gets and sets the halo pen you may use to draw a halo around the text.

IsActive

• Return:Boolean
• Summary:N/A

LabelAllLineParts

• Return:Boolean
• Summary:N/A

LabelAllPolygonParts

• Return:Boolean
• Summary:N/A

LabelPositions

• Return:Dictionary<String,WorldLabelingCandidate>
• Summary:Gets a value represents a keyValuepair which is a feature id and label position of the feature

LeaderLineMinimumLengthInPixels

• Return:Single
• Summary:N/A

LeaderLineRule

• Return:LabelLeaderLinesRule
• Summary:N/A

LeaderLineStyle

• Return:LineStyle
• Summary:N/A

Mask

• Return:AreaStyle
• Summary:This property gets and sets the AreaStyle used to draw a mask behind the text.

MaskMargin

• Return:Int32
• Summary:This property gets and sets the margin around the text that will be used for the mask.

MaskType

• Return:MaskType
• Summary:N/A

MaxNudgingInPixel

• Return:Int32
• Summary:N/A

Name

• Return:String
• Summary:N/A

NudgingIntervalInPixel

• Return:Single
• Summary:N/A

NumericFormat

• Return:String
• Summary:This property gets and sets the format that will be applied to the text which can be parsed to double type.

OverlappingRule

• Return:LabelOverlappingRule
• Summary:N/A

PointPlacement

• Return:PointPlacement
• Summary:N/A

PolygonLabelingLocationMode

• Return:PolygonLabelingLocationMode
• Summary:N/A

RequiredColumnNames

• Return:Collection<String>
• Summary:N/A

RotationAngle

• Return:Double
• Summary:This property gets and sets the rotation angle of the item being positioned.

SplineType

• Return:SplineType
• Summary:Gets or sets the SplineType for labeling.

SuppressPartialLabels

• Return:Boolean
• Summary:N/A

TextColumnName

• Return:String
• Summary:This property gets and sets the column name in the data that you want to get the text from.

TextFormat

• Return:String
• Summary:This property gets and sets the format that will be applied to the text.

TextLineSegmentRatio

• Return:Double
• Summary:N/A

TextSolidBrush

• Return:GeoSolidBrush
• Summary:This property gets and sets the SolidBrush that will be used to draw the text.

XOffsetInPixel

• Return:Single
• Summary:This property gets and sets the X pixel offset for drawing each feature.

YOffsetInPixel

• Return:Single
• Summary:This property gets and sets the Y pixel offset for drawing each feature.

AllowSpline

• Return:Boolean
• Summary:N/A

FiltersCore

• Return:Collection<String>
• Summary:N/A

uBs=

• Return:Boolean
• Summary:N/A

Formatted

• Event Arguments:FormattedPositionStyleEventArgs
• Summary:N/A

Formatting

• Event Arguments:FormattingPositionStyleEventArgs
• Summary:N/A

This is a constructor for the class.

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

Go Back

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. Go Back ===== Protected Constructors ===== ===== Public Methods ===== === CloneDeep() === N/A ==== Remarks ==== N/A Return Value * Return Type:Style * Description:N/A ==== Parameters ==== Go Back === Draw(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== 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 Go Back === Draw(IEnumerable<BaseShape>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== 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 Go Back === DrawSample(GeoCanvas,DrawingRectangleF) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== canvas * Type:GeoCanvas * Description:N/A drawingExtent * Type:DrawingRectangleF * Description:N/A Go Back === DrawSample(GeoCanvas) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== canvas * Type:GeoCanvas * Description:N/A Go Back === Equals(Object) === N/A ==== Remarks ==== N/A Return Value * Return Type:Boolean * Description:N/A ==== Parameters ==== obj * Type:Object * Description:N/A Go Back === GetHashCode() === N/A ==== Remarks ==== N/A Return Value * Return Type:Int32 * Description:N/A ==== Parameters ==== Go Back === GetRequiredColumnNames() === N/A ==== Remarks ==== N/A Return Value * Return Type:Collection<String> * Description:N/A ==== Parameters ==== Go Back === GetType() === N/A ==== Remarks ==== N/A Return Value * Return Type:Type * Description:N/A ==== Parameters ==== Go Back === SaveStyle(String) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== filePathName * Type:String * Description:N/A Go Back === SaveStyle(Stream) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== stream * Type:Stream * Description:N/A Go Back === ToString() === N/A ==== Remarks ==== N/A Return Value * Return Type:String * Description:N/A ==== Parameters ==== Go Back ===== Protected Methods ===== === AbbreviateText(Feature,GeoCanvas) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== feature * Type:Feature * Description:N/A canvas * Type:GeoCanvas * Description:N/A Go Back === AbbreviateTextCore(Feature,GeoCanvas) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== feature * Type:Feature * Description:N/A canvas * Type:GeoCanvas * Description:N/A Go Back === CheckDuplicate(LabelingCandidate,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) === N/A ==== Remarks ==== N/A Return Value * Return Type:Boolean * Description:N/A ==== Parameters ==== 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 Go Back === CheckDuplicateCore(LabelingCandidate,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) === N/A ==== Remarks ==== N/A Return Value * Return Type:Boolean * Description:N/A ==== Parameters ==== 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 Go Back === CheckOverlapping(LabelingCandidate,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) === N/A ==== Remarks ==== N/A Return Value * Return Type:Boolean * Description:N/A ==== Parameters ==== 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 Go Back === CheckOverlappingCore(LabelingCandidate,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) === N/A ==== Remarks ==== N/A Return Value * Return Type:Boolean * Description:N/A ==== Parameters ==== 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 Go Back === CloneDeepCore() === N/A ==== Remarks ==== N/A Return Value * Return Type:Style * Description:N/A ==== Parameters ==== Go Back === DrawCore(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== 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 Go Back === DrawSampleCore(GeoCanvas,DrawingRectangleF) === This method draws a sample feature on the canvas you provided. ==== Remarks ==== 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. Return Value * Return Type:Void * Description:None ==== Parameters ==== canvas * Type:GeoCanvas * Description:This parameter represents the canvas you want to draw the features on. drawingExtent * Type:DrawingRectangleF * Description:N/A Go Back === FilterFeatures(IEnumerable<Feature>,GeoCanvas) === N/A ==== Remarks ==== N/A Return Value * Return Type:Collection<Feature> * Description:N/A ==== Parameters ==== features * Type:IEnumerable<Feature> * Description:N/A canvas * Type:GeoCanvas * Description:N/A Go Back === FilterFeaturesCore(IEnumerable<Feature>,GeoCanvas) === N/A ==== Remarks ==== N/A Return Value * Return Type:Collection<Feature> * Description:N/A ==== Parameters ==== features * Type:IEnumerable<Feature> * Description:N/A canvas * Type:GeoCanvas * Description:N/A Go Back === Finalize() === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== Go Back === Format(String,BaseShape) === N/A ==== Remarks ==== N/A Return Value * Return Type:String * Description:N/A ==== Parameters ==== text * Type:String * Description:N/A labeledShape * Type:BaseShape * Description:N/A Go Back === FormatCore(String,BaseShape) === N/A ==== Remarks ==== N/A Return Value * Return Type:String * Description:N/A ==== Parameters ==== text * Type:String * Description:N/A labeledShape * Type:BaseShape * Description:N/A Go Back === GetLabelingCandidateCore(Feature,GeoCanvas) === N/A ==== Remarks ==== N/A Return Value * Return Type:Collection<LabelingCandidate> * Description:N/A ==== Parameters ==== feature * Type:Feature * Description:N/A canvas * Type:GeoCanvas * Description:N/A Go Back === GetLabelingCandidates(Feature,GeoCanvas) === N/A ==== Remarks ==== N/A Return Value * Return Type:Collection<LabelingCandidate> * Description:N/A ==== Parameters ==== feature * Type:Feature * Description:N/A canvas * Type:GeoCanvas * Description:N/A Go Back === GetRequiredColumnNamesCore() === N/A ==== Remarks ==== N/A Return Value * Return Type:Collection<String> * Description:N/A ==== Parameters ==== Go Back === MemberwiseClone() === N/A ==== Remarks ==== N/A Return Value * Return Type:Object * Description:N/A ==== Parameters ==== Go Back === OnFormatted(FormattedPositionStyleEventArgs) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== e * Type:FormattedPositionStyleEventArgs * Description:N/A Go Back === OnFormatting(FormattingPositionStyleEventArgs) === N/A ==== Remarks ==== N/A Return Value * Return Type:Void * Description:N/A ==== Parameters ==== e * Type:FormattingPositionStyleEventArgs * Description:N/A Go Back === lD8=(PolygonShape,String,GeoCanvas) === N/A ==== Remarks ==== N/A Return Value * Return Type:LabelingCandidate * Description:N/A ==== Parameters ==== polygon * Type:PolygonShape * Description:N/A text * Type:String * Description:N/A canvas * Type:GeoCanvas * Description:N/A Go Back ===== Public Properties ===== === AbbreviationDictionary === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Dictionary<String,String> Go Back === Advanced === This property gets the advanced properties of the class. ==== Remarks ==== 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. ==== Return Value ==== Return Type:TextStyleAdvanced Go Back === AllowLineCarriage === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Boolean Go Back === BestPlacement === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Boolean Go Back === BestPlacementSymbolHeight === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Single Go Back === BestPlacementSymbolWidth === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Single Go Back === CustomTextStyles === 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 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. ==== Return Value ==== Return Type:Collection<TextStyle> Go Back === DateFormat === This property gets and sets the format that will be applied to the text which can be parsed to DateTime type. ==== Remarks ==== With this property, you can apply formats to the text that is retrieved from the feature. ==== Return Value ==== Return Type:String Go Back === DrawingLevel === Gets or sets the DrawingLavel for this style. ==== Remarks ==== N/A ==== Return Value ==== Return Type:DrawingLevel Go Back === DuplicateRule === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:LabelDuplicateRule Go Back === Filters === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Collection<String> Go Back === 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. ==== Remarks ==== 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. ==== Return Value ==== Return Type:Boolean Go Back === FittingPolygon === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Boolean Go Back === FittingPolygonFactor === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Double Go Back === 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. ==== Remarks ==== 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. ==== Return Value ==== Return Type:Boolean Go Back === Font === This property gets and sets the font that will be used to draw the text. ==== Remarks ==== None ==== Return Value ==== Return Type:GeoFont Go Back === ForceHorizontalLabelForLine === This property gets and sets whether we should force horizontal labeling for lines. ==== Remarks ==== 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. ==== Return Value ==== Return Type:Boolean Go Back === ForceLineCarriage === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Boolean Go Back === GridSize === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Int32 Go Back === HaloPen === This property gets and sets the halo pen you may use to draw a halo around the text. ==== Remarks ==== The halo pen allows you to draw a halo effect around the text, making it stand out more on a busy background. ==== Return Value ==== Return Type:GeoPen Go Back === IsActive === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Boolean Go Back === LabelAllLineParts === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Boolean Go Back === LabelAllPolygonParts === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Boolean Go Back === LabelPositions === Gets a value represents a keyValuepair which is a feature id and label position of the feature ==== Remarks ==== N/A ==== Return Value ==== Return Type:Dictionary<String,WorldLabelingCandidate> Go Back === LeaderLineMinimumLengthInPixels === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Single Go Back === LeaderLineRule === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:LabelLeaderLinesRule Go Back === LeaderLineStyle === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:LineStyle Go Back === Mask === This property gets and sets the AreaStyle used to draw a mask behind the text. ==== Remarks ==== 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. ==== Return Value ==== Return Type:AreaStyle Go Back === MaskMargin === This property gets and sets the margin around the text that will be used for the mask. ==== Remarks ==== This determines how much larger the mask is than the text, in pixels. ==== Return Value ==== Return Type:Int32 Go Back === MaskType === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:MaskType Go Back === MaxNudgingInPixel === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Int32 Go Back === Name === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:String Go Back === NudgingIntervalInPixel === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Single Go Back === NumericFormat === This property gets and sets the format that will be applied to the text which can be parsed to double type. ==== Remarks ==== With this property, you can apply formats to the text that is retrieved from the feature. ==== Return Value ==== Return Type:String Go Back === OverlappingRule === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:LabelOverlappingRule Go Back === PointPlacement === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:PointPlacement Go Back === PolygonLabelingLocationMode === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:PolygonLabelingLocationMode Go Back === RequiredColumnNames === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Collection<String> Go Back === RotationAngle === This property gets and sets the rotation angle of the item being positioned. ==== Remarks ==== None ==== Return Value ==== Return Type:Double Go Back === SplineType === Gets or sets the SplineType for labeling. ==== Remarks ==== N/A ==== Return Value ==== Return Type:SplineType Go Back === SuppressPartialLabels === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Boolean Go Back === TextColumnName === This property gets and sets the column name in the data that you want to get the text from. ==== Remarks ==== 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. ==== Return Value ==== Return Type:String Go Back === TextFormat === This property gets and sets the format that will be applied to the text. ==== Remarks ==== With this property, you can apply formats to the text that is retrieved from the feature. ==== Return Value ==== Return Type:String Go Back === TextLineSegmentRatio === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Double Go Back === TextSolidBrush === This property gets and sets the SolidBrush that will be used to draw the text. ==== Remarks ==== 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. ==== Return Value ==== Return Type:GeoSolidBrush 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 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 Go Back ===== Protected Properties ===== === AllowSpline === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Boolean Go Back === FiltersCore === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Collection<String> Go Back === uBs= === N/A ==== Remarks ==== N/A ==== Return Value ==== Return Type:Boolean Go Back ===== Public Events ===== === Formatted === N/A ==== Remarks ==== N/A Event Arguments:FormattedPositionStyleEventArgs Go Back === Formatting === N/A ==== Remarks ==== N/A Event Arguments**:FormattingPositionStyleEventArgs

Go Back