Skip to content

IconStyle

Inheritance Hierarchy

Members Summary

Public Constructors Summary

Name
IconStyle()
IconStyle(String,String,GeoFont,GeoBrush)
IconStyle(GeoImage,String,GeoFont,GeoBrush)

Protected Constructors Summary

Name
N/A

Public Properties Summary

Name Return Type Description
AbbreviationDictionary Dictionary<String,String> N/A
Alignment DrawingTextAlignment N/A
AllowLineCarriage Boolean N/A
BasePoint PointStyle N/A
BestPlacementSymbolHeight Single N/A
BestPlacementSymbolWidth Single N/A
CustomTextStyles Collection<TextStyle> N/A
DateFormat String N/A
DrawingLevel DrawingLevel N/A
DuplicateRule LabelDuplicateRule N/A
Filters Collection<String> N/A
FittingLineInScreen Boolean N/A
FittingPolygon Boolean N/A
FittingPolygonFactor Double N/A
FittingPolygonInScreen Boolean N/A
Font GeoFont N/A
ForceHorizontalLabelForLine Boolean N/A
ForceLineCarriage Boolean N/A
GridSize Int32 N/A
HaloPen GeoPen N/A
IconImage GeoImage This property gets and sets the NativeImage you want to use for the image.
IconImageScale Double This property gets and sets the scale of the image you want to draw.
IconPathFilename String This property gets and sets the filename and path for the image you want to use in the style.
IsActive Boolean N/A
LabelAllLineParts Boolean N/A
LabelAllPolygonParts Boolean N/A
LabelPositions Dictionary<String,WorldLabelingCandidate> N/A
LeaderLineMinimumLengthInPixels Single N/A
LeaderLineRule LabelLeaderLinesRule N/A
LeaderLineStyle LineStyle N/A
LetterCase DrawingTextLetterCase N/A
Mask AreaStyle N/A
MaskMargin DrawingMargin N/A
MaskType MaskType N/A
MaxCharAngleDelta Double N/A
MaxNudgingInPixel Int32 N/A
MinDistance Double N/A
Name String N/A
NudgingIntervalInPixel Single N/A
NumericFormat String N/A
OverlappingRule LabelOverlappingRule N/A
PolygonLabelingLocationMode PolygonLabelingLocationMode N/A
RequiredColumnNames Collection<String> N/A
RotationAngle Double N/A
Spacing Double N/A
SplineType SplineType N/A
SuppressPartialLabels Boolean This property gets and sets whether a partial label in the current extent will be drawn or not.
TextBrush GeoBrush N/A
TextColumnName String N/A
TextFormat String N/A
TextLineSegmentRatio Double N/A
TextPlacement TextPlacement N/A
WrapWidth Double N/A
XOffsetInPixel Single N/A
YOffsetInPixel Single N/A

Protected Properties Summary

Name Return Type Description
AllowOverlapping Boolean N/A
AllowSpline Boolean N/A
DrawBasePointWithoutText Boolean N/A
FiltersCore Collection<String> N/A
IsDefault Boolean N/A
IsStyleDefault Boolean N/A
IsStyleJsonStyle Boolean N/A
LabelFeatures Collection<Feature> N/A
TextBaseline DrawingTextBaseline N/A
TextContent String N/A
TextLetterSpacing Double N/A
TextLineSpacing Single N/A

Public Methods Summary

Name
CloneDeep()
Draw(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)
Draw(IEnumerable<BaseShape>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)
DrawSample(GeoCanvas,DrawingRectangleF)
DrawSample(GeoCanvas)
Equals(Object)
GetHashCode()
GetRequiredColumnNames()
GetType()
SaveStyle(String)
SaveStyle(Stream)
ToString()

Protected Methods Summary

Name
AbbreviateText(Feature,GeoCanvas)
AbbreviateTextCore(Feature,GeoCanvas)
CheckDuplicate(LabelingCandidate,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)
CheckDuplicateCore(LabelingCandidate,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)
CheckOverlapping(LabelingCandidate,GeoCanvas,GeoFont,Single,Single,Double,Collection<SimpleCandidate>,Collection<SimpleCandidate>)
CheckOverlappingCore(LabelingCandidate,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)
CloneDeepCore()
DrawCore(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)
DrawMask(LabelingCandidate,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)
DrawSampleCore(GeoCanvas,DrawingRectangleF)
DrawText(Feature,GeoCanvas,GeoFont,GeoBrush,GeoPen,DrawingLevel,Single,Single,DrawingTextAlignment,Double,Collection<SimpleCandidate>,Collection<SimpleCandidate>)
FilterFeatures(IEnumerable<Feature>,GeoCanvas)
FilterFeaturesCore(IEnumerable<Feature>,GeoCanvas)
Finalize()
Format(String,BaseShape)
FormatCore(String,BaseShape)
GetLabelingCandidateCore(Feature,GeoCanvas,GeoFont,Single,Single,Double)
GetLabelingCandidateForOnePolygon(PolygonShape,String,GeoFont,Single,Single,GeoCanvas,Double)
GetLabelingCandidates(Feature,GeoCanvas,GeoFont,Single,Single,Double)
GetRequiredColumnNamesCore()
MeasureText(GeoCanvas,String,GeoFont)
MemberwiseClone()
OnFormatted(FormattedPositionStyleEventArgs)
OnFormatting(FormattingPositionStyleEventArgs)

Public Events Summary

Name Event Arguments Description
Formatting FormattingPositionStyleEventArgs N/A
Formatted FormattedPositionStyleEventArgs N/A

Members Detail

Public Constructors

Name
IconStyle()
IconStyle(String,String,GeoFont,GeoBrush)
IconStyle(GeoImage,String,GeoFont,GeoBrush)

Protected Constructors

Public Properties

AbbreviationDictionary

Summary

N/A

Remarks

N/A

Return Value

Dictionary<String,String>


Alignment

Summary

N/A

Remarks

N/A

Return Value

DrawingTextAlignment


AllowLineCarriage

Summary

N/A

Remarks

N/A

Return Value

Boolean


BasePoint

Summary

N/A

Remarks

N/A

Return Value

PointStyle


BestPlacementSymbolHeight

Summary

N/A

Remarks

N/A

Return Value

Single


BestPlacementSymbolWidth

Summary

N/A

Remarks

N/A

Return Value

Single


CustomTextStyles

Summary

N/A

Remarks

N/A

Return Value

Collection<TextStyle>


DateFormat

Summary

N/A

Remarks

N/A

Return Value

String


DrawingLevel

Summary

N/A

Remarks

N/A

Return Value

DrawingLevel


DuplicateRule

Summary

N/A

Remarks

N/A

Return Value

LabelDuplicateRule


Filters

Summary

N/A

Remarks

N/A

Return Value

Collection<String>


FittingLineInScreen

Summary

N/A

Remarks

N/A

Return Value

Boolean


FittingPolygon

Summary

N/A

Remarks

N/A

Return Value

Boolean


FittingPolygonFactor

Summary

N/A

Remarks

N/A

Return Value

Double


FittingPolygonInScreen

Summary

N/A

Remarks

N/A

Return Value

Boolean


Font

Summary

N/A

Remarks

N/A

Return Value

GeoFont


ForceHorizontalLabelForLine

Summary

N/A

Remarks

N/A

Return Value

Boolean


ForceLineCarriage

Summary

N/A

Remarks

N/A

Return Value

Boolean


GridSize

Summary

N/A

Remarks

N/A

Return Value

Int32


HaloPen

Summary

N/A

Remarks

N/A

Return Value

GeoPen


IconImage

Summary

This property gets and sets the NativeImage you want to use for the image.

Remarks

You will typically want to use this property if your image is derived from a stream. Otherwise, you can use the IconFilePathName property to specify where the icon is located and we will handle the rest.

Return Value

GeoImage


IconImageScale

Summary

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

Double


IconPathFilename

Summary

This property gets and sets the filename and path for the image you want to use in the style.

Remarks

You can also optionally use the IconImage property if the image you want to use is derived from a stream.

Return Value

String


IsActive

Summary

N/A

Remarks

N/A

Return Value

Boolean


LabelAllLineParts

Summary

N/A

Remarks

N/A

Return Value

Boolean


LabelAllPolygonParts

Summary

N/A

Remarks

N/A

Return Value

Boolean


LabelPositions

Summary

N/A

Remarks

N/A

Return Value

Dictionary<String,WorldLabelingCandidate>


LeaderLineMinimumLengthInPixels

Summary

N/A

Remarks

N/A

Return Value

Single


LeaderLineRule

Summary

N/A

Remarks

N/A

Return Value

LabelLeaderLinesRule


LeaderLineStyle

Summary

N/A

Remarks

N/A

Return Value

LineStyle


LetterCase

Summary

N/A

Remarks

N/A

Return Value

DrawingTextLetterCase


Mask

Summary

N/A

Remarks

N/A

Return Value

AreaStyle


MaskMargin

Summary

N/A

Remarks

N/A

Return Value

DrawingMargin


MaskType

Summary

N/A

Remarks

N/A

Return Value

MaskType


MaxCharAngleDelta

Summary

N/A

Remarks

N/A

Return Value

Double


MaxNudgingInPixel

Summary

N/A

Remarks

N/A

Return Value

Int32


MinDistance

Summary

N/A

Remarks

N/A

Return Value

Double


Name

Summary

N/A

Remarks

N/A

Return Value

String


NudgingIntervalInPixel

Summary

N/A

Remarks

N/A

Return Value

Single


NumericFormat

Summary

N/A

Remarks

N/A

Return Value

String


OverlappingRule

Summary

N/A

Remarks

N/A

Return Value

LabelOverlappingRule


PolygonLabelingLocationMode

Summary

N/A

Remarks

N/A

Return Value

PolygonLabelingLocationMode


RequiredColumnNames

Summary

N/A

Remarks

N/A

Return Value

Collection<String>


RotationAngle

Summary

N/A

Remarks

N/A

Return Value

Double


Spacing

Summary

N/A

Remarks

N/A

Return Value

Double


SplineType

Summary

N/A

Remarks

N/A

Return Value

SplineType


SuppressPartialLabels

Summary

This property gets and sets whether a partial label in the current extent will be drawn or not.

Remarks

This property provides a solution to the "cut off" label issue in Map Suite Web Edition and Desktop Edition, which occurs when multiple tiles exist. When you set this property to true, any labels outside of the current extent will not be drawn.

Return Value

Boolean


TextBrush

Summary

N/A

Remarks

N/A

Return Value

GeoBrush


TextColumnName

Summary

N/A

Remarks

N/A

Return Value

String


TextFormat

Summary

N/A

Remarks

N/A

Return Value

String


TextLineSegmentRatio

Summary

N/A

Remarks

N/A

Return Value

Double


TextPlacement

Summary

N/A

Remarks

N/A

Return Value

TextPlacement


WrapWidth

Summary

N/A

Remarks

N/A

Return Value

Double


XOffsetInPixel

Summary

N/A

Remarks

N/A

Return Value

Single


YOffsetInPixel

Summary

N/A

Remarks

N/A

Return Value

Single


Protected Properties

AllowOverlapping

Summary

N/A

Remarks

N/A

Return Value

Boolean


AllowSpline

Summary

N/A

Remarks

N/A

Return Value

Boolean


DrawBasePointWithoutText

Summary

N/A

Remarks

N/A

Return Value

Boolean


FiltersCore

Summary

N/A

Remarks

N/A

Return Value

Collection<String>


IsDefault

Summary

N/A

Remarks

N/A

Return Value

Boolean


IsStyleDefault

Summary

N/A

Remarks

N/A

Return Value

Boolean


IsStyleJsonStyle

Summary

N/A

Remarks

N/A

Return Value

Boolean


LabelFeatures

Summary

N/A

Remarks

N/A

Return Value

Collection<Feature>


TextBaseline

Summary

N/A

Remarks

N/A

Return Value

DrawingTextBaseline


TextContent

Summary

N/A

Remarks

N/A

Return Value

String


TextLetterSpacing

Summary

N/A

Remarks

N/A

Return Value

Double


TextLineSpacing

Summary

N/A

Remarks

N/A

Return Value

Single


Public Methods

CloneDeep()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Style N/A

Parameters

Name Type Description
N/A N/A N/A

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

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
features IEnumerable<Feature> N/A
canvas GeoCanvas N/A
labelsInThisLayer Collection<SimpleCandidate> N/A
labelsInAllLayers Collection<SimpleCandidate> N/A

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

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
shapes IEnumerable<BaseShape> N/A
canvas GeoCanvas N/A
labelsInThisLayer Collection<SimpleCandidate> N/A
labelsInAllLayers Collection<SimpleCandidate> N/A

DrawSample(GeoCanvas,DrawingRectangleF)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
canvas GeoCanvas N/A
drawingExtent DrawingRectangleF N/A

DrawSample(GeoCanvas)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
canvas GeoCanvas N/A

Equals(Object)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Boolean N/A

Parameters

Name Type Description
obj Object N/A

GetHashCode()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Int32 N/A

Parameters

Name Type Description
N/A N/A N/A

GetRequiredColumnNames()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<String> N/A

Parameters

Name Type Description
N/A N/A N/A

GetType()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Type N/A

Parameters

Name Type Description
N/A N/A N/A

SaveStyle(String)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
filePathName String N/A

SaveStyle(Stream)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
stream Stream N/A

ToString()

Summary

N/A

Remarks

N/A

Return Value

Type Description
String N/A

Parameters

Name Type Description
N/A N/A N/A

Protected Methods

AbbreviateText(Feature,GeoCanvas)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
feature Feature N/A
canvas GeoCanvas N/A

AbbreviateTextCore(Feature,GeoCanvas)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
feature Feature N/A
canvas GeoCanvas N/A

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

Summary

N/A

Remarks

N/A

Return Value

Type Description
Boolean N/A

Parameters

Name Type Description
labelingCandidate LabelingCandidate N/A
canvas GeoCanvas N/A
labelsInThisLayer Collection<SimpleCandidate> N/A
labelsInAllLayers Collection<SimpleCandidate> N/A

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

Summary

N/A

Remarks

N/A

Return Value

Type Description
Boolean N/A

Parameters

Name Type Description
labelingCandidate LabelingCandidate N/A
canvas GeoCanvas N/A
labelsInThisLayer Collection<SimpleCandidate> N/A
labelsInAllLayers Collection<SimpleCandidate> N/A

CheckOverlapping(LabelingCandidate,GeoCanvas,GeoFont,Single,Single,Double,Collection<SimpleCandidate>,Collection<SimpleCandidate>)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Boolean N/A

Parameters

Name Type Description
labelingCandidate LabelingCandidate N/A
canvas GeoCanvas N/A
font GeoFont N/A
xOffsetInPixel Single N/A
yOffsetInPixel Single N/A
rotationAngle Double N/A
labelsInThisLayer Collection<SimpleCandidate> N/A
labelsInAllLayers Collection<SimpleCandidate> N/A

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

Summary

N/A

Remarks

N/A

Return Value

Type Description
Boolean N/A

Parameters

Name Type Description
labelingCandidate LabelingCandidate N/A
canvas GeoCanvas N/A
labelsInThisLayer Collection<SimpleCandidate> N/A
labelsInAllLayers Collection<SimpleCandidate> N/A

CloneDeepCore()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Style N/A

Parameters

Name Type Description
N/A N/A N/A

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

Summary

This method draws the features on the view you provided.

Remarks

This overridden method is called from the concrete public method Draw. In this method, we take the features you passed in and draw them on the view you provided. Each style (based on its properties) may draw each feature differently. When overriding this method, consider each feature and its column data values. You can use the full power of the GeoCanvas to do the drawing. If you need column data for a feature, be sure to override the GetRequiredColumnNamesCore and add the columns you need to the collection. 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

Type Description
Void None

Parameters

Name Type Description
features IEnumerable<Feature> This parameter represents the features you want to draw on the view.
canvas GeoCanvas This parameter represents the view you want to draw the features on.
labelsInThisLayer Collection<SimpleCandidate> The labels will be drawn in the current layer only.
labelsInAllLayers Collection<SimpleCandidate> The labels will be drawn in all layers.

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

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
labelingCandidate LabelingCandidate N/A
canvas GeoCanvas N/A
labelsInThisLayer Collection<SimpleCandidate> N/A
labelsInAllLayers Collection<SimpleCandidate> N/A

DrawSampleCore(GeoCanvas,DrawingRectangleF)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
canvas GeoCanvas N/A
drawingExtent DrawingRectangleF N/A

DrawText(Feature,GeoCanvas,GeoFont,GeoBrush,GeoPen,DrawingLevel,Single,Single,DrawingTextAlignment,Double,Collection<SimpleCandidate>,Collection<SimpleCandidate>)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
feature Feature N/A
canvas GeoCanvas N/A
font GeoFont N/A
textBrush GeoBrush N/A
haloPen GeoPen N/A
drawingLevel DrawingLevel N/A
xOffsetInPixel Single N/A
yOffsetInPixel Single N/A
alignment DrawingTextAlignment N/A
rotationAngle Double N/A
labelsInThisLayer Collection<SimpleCandidate> N/A
labelsInAllLayers Collection<SimpleCandidate> N/A

FilterFeatures(IEnumerable<Feature>,GeoCanvas)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
features IEnumerable<Feature> N/A
canvas GeoCanvas N/A

FilterFeaturesCore(IEnumerable<Feature>,GeoCanvas)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<Feature> N/A

Parameters

Name Type Description
features IEnumerable<Feature> N/A
canvas GeoCanvas N/A

Finalize()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

Format(String,BaseShape)

Summary

N/A

Remarks

N/A

Return Value

Type Description
String N/A

Parameters

Name Type Description
text String N/A
labeledShape BaseShape N/A

FormatCore(String,BaseShape)

Summary

N/A

Remarks

N/A

Return Value

Type Description
String N/A

Parameters

Name Type Description
text String N/A
labeledShape BaseShape N/A

GetLabelingCandidateCore(Feature,GeoCanvas,GeoFont,Single,Single,Double)

Summary

This method determines which labels will be candidates for drawing.

Remarks

This overridden method is called from the concrete public method GetLabelingCandidate. In this method, we determine if the feature passed in will be a candidate for drawing. If you have the grid method enabled, then we determine this by ensuring that only one label will be eligible per grid cell. In this way, we can ensure that labels always draw in the same place at the same scale.

Return Value

Type Description
Collection<LabelingCandidate> This method returns a collection of labeling candidates.

Parameters

Name Type Description
feature Feature This parameter represents the features you want to draw on the view.
canvas GeoCanvas This parameter represents the view you want to draw the features on.
font GeoFont N/A
xOffsetInPixel Single N/A
yOffsetInPixel Single N/A
rotationAngle Double N/A

GetLabelingCandidateForOnePolygon(PolygonShape,String,GeoFont,Single,Single,GeoCanvas,Double)

Summary

N/A

Remarks

N/A

Return Value

Type Description
LabelingCandidate N/A

Parameters

Name Type Description
polygon PolygonShape N/A
text String N/A
font GeoFont N/A
xOffsetInPixel Single N/A
yOffsetInPixel Single N/A
canvas GeoCanvas N/A
rotationAngle Double N/A

GetLabelingCandidates(Feature,GeoCanvas,GeoFont,Single,Single,Double)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<LabelingCandidate> N/A

Parameters

Name Type Description
feature Feature N/A
canvas GeoCanvas N/A
font GeoFont N/A
xOffsetInPixel Single N/A
yOffsetInPixel Single N/A
rotationAngle Double N/A

GetRequiredColumnNamesCore()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<String> N/A

Parameters

Name Type Description
N/A N/A N/A

MeasureText(GeoCanvas,String,GeoFont)

Summary

N/A

Remarks

N/A

Return Value

Type Description
DrawingRectangleF N/A

Parameters

Name Type Description
canvas GeoCanvas N/A
text String N/A
font GeoFont N/A

MemberwiseClone()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Object N/A

Parameters

Name Type Description
N/A N/A N/A

OnFormatted(FormattedPositionStyleEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
e FormattedPositionStyleEventArgs N/A

OnFormatting(FormattingPositionStyleEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
e FormattingPositionStyleEventArgs N/A

Public Events

Formatting

N/A

Remarks

N/A

Event Arguments

FormattingPositionStyleEventArgs

Formatted

N/A

Remarks

N/A

Event Arguments

FormattedPositionStyleEventArgs