Skip to content

IconValueStyle

Inheritance Hierarchy

Members Summary

Public Constructors Summary

Name
IconValueStyle()
IconValueStyle(String)
IconValueStyle(String,IEnumerable<IconValueItem>)

Protected Constructors Summary

Name
N/A

Public Properties Summary

Name Return Type Description
AbbreviationDictionary Dictionary<String,String> N/A
AllowLineCarriage Boolean N/A
BestPlacementSymbolHeight Single N/A
BestPlacementSymbolWidth Single N/A
ColumnName String This property gets and sets the column name that will be used for the drawing and matching.
DuplicateRule LabelDuplicateRule N/A
Filters Collection<String> N/A
FittingPolygon Boolean N/A
FittingPolygonFactor Double N/A
ForceLineCarriage Boolean N/A
GridSize Int32 N/A
IconValueItems Collection<IconValueItem> This property gets the collection of IconValueItems for matching.
IsActive Boolean N/A
LabelAllLineParts Boolean N/A
LabelAllPolygonParts Boolean N/A
LeaderLineMinimumLengthInPixels Single N/A
LeaderLineRule LabelLeaderLinesRule N/A
LeaderLineStyle LineStyle N/A
MaskType MaskType N/A
MaxNudgingInPixel Int32 N/A
Name String N/A
NudgingIntervalInPixel Single N/A
OverlappingRule LabelOverlappingRule N/A
PolygonLabelingLocationMode PolygonLabelingLocationMode N/A
RequiredColumnNames Collection<String> N/A
SuppressPartialLabels Boolean N/A
TextLineSegmentRatio Double N/A
TextPlacement TextPlacement N/A

Protected Properties Summary

Name Return Type Description
Alignment DrawingTextAlignment N/A
AllowOverlapping Boolean N/A
AllowSpline Boolean N/A
BasePoint PointStyle N/A
CustomTextStyles Collection<TextStyle> N/A
DateFormat String N/A
DrawBasePointWithoutText Boolean N/A
DrawingLevel DrawingLevel N/A
FiltersCore Collection<String> N/A
FittingLineInScreen Boolean N/A
FittingPolygonInScreen Boolean N/A
Font GeoFont N/A
ForceHorizontalLabelForLine Boolean N/A
HaloPen GeoPen N/A
IsDefault Boolean N/A
IsStyleDefault Boolean N/A
IsStyleJsonStyle Boolean N/A
LabelFeatures Collection<Feature> N/A
LabelPositions Dictionary<String,WorldLabelingCandidate> N/A
LetterCase DrawingTextLetterCase N/A
Mask AreaStyle N/A
MaskMargin DrawingMargin N/A
MaxCharAngleDelta Double N/A
MinDistance Double N/A
NumericFormat String N/A
RotationAngle Double N/A
Spacing Double N/A
SplineType SplineType N/A
TextBaseline DrawingTextBaseline N/A
TextBrush GeoBrush N/A
TextColumnName String N/A
TextContent String N/A
TextFormat String N/A
TextLetterSpacing Double N/A
TextLineSpacing Single N/A
WrapWidth Double N/A
XOffsetInPixel Single N/A
YOffsetInPixel 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
IconValueStyle()
IconValueStyle(String)
IconValueStyle(String,IEnumerable<IconValueItem>)

Protected Constructors

Public Properties

AbbreviationDictionary

Summary

N/A

Remarks

N/A

Return Value

Dictionary<String,String>


AllowLineCarriage

Summary

N/A

Remarks

N/A

Return Value

Boolean


BestPlacementSymbolHeight

Summary

N/A

Remarks

N/A

Return Value

Single


BestPlacementSymbolWidth

Summary

N/A

Remarks

N/A

Return Value

Single


ColumnName

Summary

This property gets and sets the column name that will be used for the drawing and matching.

Remarks

This column name will be used to draw the text on the icon (if necessary) and to also match the value in the IconStyleItem.

Return Value

String


DuplicateRule

Summary

N/A

Remarks

N/A

Return Value

LabelDuplicateRule


Filters

Summary

N/A

Remarks

N/A

Return Value

Collection<String>


FittingPolygon

Summary

N/A

Remarks

N/A

Return Value

Boolean


FittingPolygonFactor

Summary

N/A

Remarks

N/A

Return Value

Double


ForceLineCarriage

Summary

N/A

Remarks

N/A

Return Value

Boolean


GridSize

Summary

N/A

Remarks

N/A

Return Value

Int32


IconValueItems

Summary

This property gets the collection of IconValueItems for matching.

Remarks

You should create your IconValueItems and place them in this collection for consideration.

Return Value

Collection<IconValueItem>


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


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


MaskType

Summary

N/A

Remarks

N/A

Return Value

MaskType


MaxNudgingInPixel

Summary

N/A

Remarks

N/A

Return Value

Int32


Name

Summary

N/A

Remarks

N/A

Return Value

String


NudgingIntervalInPixel

Summary

N/A

Remarks

N/A

Return Value

Single


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>


SuppressPartialLabels

Summary

N/A

Remarks

N/A

Return Value

Boolean


TextLineSegmentRatio

Summary

N/A

Remarks

N/A

Return Value

Double


TextPlacement

Summary

N/A

Remarks

N/A

Return Value

TextPlacement


Protected Properties

Alignment

Summary

N/A

Remarks

N/A

Return Value

DrawingTextAlignment


AllowOverlapping

Summary

N/A

Remarks

N/A

Return Value

Boolean


AllowSpline

Summary

N/A

Remarks

N/A

Return Value

Boolean


BasePoint

Summary

N/A

Remarks

N/A

Return Value

PointStyle


CustomTextStyles

Summary

N/A

Remarks

N/A

Return Value

Collection<TextStyle>


DateFormat

Summary

N/A

Remarks

N/A

Return Value

String


DrawBasePointWithoutText

Summary

N/A

Remarks

N/A

Return Value

Boolean


DrawingLevel

Summary

N/A

Remarks

N/A

Return Value

DrawingLevel


FiltersCore

Summary

N/A

Remarks

N/A

Return Value

Collection<String>


FittingLineInScreen

Summary

N/A

Remarks

N/A

Return Value

Boolean


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


HaloPen

Summary

N/A

Remarks

N/A

Return Value

GeoPen


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>


LabelPositions

Summary

N/A

Remarks

N/A

Return Value

Dictionary<String,WorldLabelingCandidate>


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


MaxCharAngleDelta

Summary

N/A

Remarks

N/A

Return Value

Double


MinDistance

Summary

N/A

Remarks

N/A

Return Value

Double


NumericFormat

Summary

N/A

Remarks

N/A

Return Value

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


TextBaseline

Summary

N/A

Remarks

N/A

Return Value

DrawingTextBaseline


TextBrush

Summary

N/A

Remarks

N/A

Return Value

GeoBrush


TextColumnName

Summary

N/A

Remarks

N/A

Return Value

String


TextContent

Summary

N/A

Remarks

N/A

Return Value

String


TextFormat

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


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


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 whether the specified feature is a good candidate to be labeled, based on the labeling properties set.

Remarks

This overridden method is called from the concrete public method Draw. In this method, we take the feature you passed in and determine if it is a candidate for labeling. If it is, then we will add it to the return collection. The algorithm to determine whether the label will draw is complex and determined by a number of properties and factors.

Return Value

Type Description
Collection<LabelingCandidate> N/A

Parameters

Name Type Description
feature Feature This parameter is the feature that will be considered as a labeling candidate.
canvas GeoCanvas This parameter is the view that will be used to draw the feature. This method will not draw on this view, but rather will use it to determine font size, etc.
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

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

Type Description
Collection<String> This method returns a collection of the column names that it needs.

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