User Tools

Site Tools


thinkgeo.mapsuite.core.iconstyle

This is an old revision of the document!


Table of Contents

ThinkGeo.MapSuite.Core.IconStyle

This class displays an icon with text from the data of the feature.

Inheritance Hierarchy

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

Members Summary

Public Constructors

IconStyle

  • Parameters:N/A
  • DeclaringType:N/A
  • Summary:This is the constructor for the class.

IconStyle

  • Parameters:String,String,GeoFont,GeoSolidBrush
  • DeclaringType:N/A
  • Summary:This is the constructor for the class.

IconStyle

Protected Constructors

Public Methods

CloneDeep

  • Parameters:N/A
  • DeclaringType:Style
  • Summary:N/A

Draw

Draw

DrawSample

DrawSample

Equals

  • Parameters:Object
  • DeclaringType:Object
  • Summary:N/A

GetHashCode

  • Parameters:N/A
  • DeclaringType:Object
  • Summary:N/A

GetRequiredColumnNames

  • Parameters:N/A
  • DeclaringType:Style
  • Summary:N/A

GetType

  • Parameters:N/A
  • DeclaringType:Object
  • Summary:N/A

SaveStyle

  • Parameters:String
  • DeclaringType:Style
  • Summary:N/A

SaveStyle

  • Parameters:Stream
  • DeclaringType:Style
  • Summary:N/A

ToString

  • Parameters:N/A
  • DeclaringType:Object
  • Summary:N/A

Protected Methods

AbbreviateText

AbbreviateTextCore

CheckDuplicate

CheckDuplicateCore

CheckOverlapping

CheckOverlappingCore

CloneDeepCore

  • Parameters:N/A
  • DeclaringType:Style
  • Summary:N/A

DrawCore

DrawSampleCore

FilterFeatures

FilterFeaturesCore

Finalize

  • Parameters:N/A
  • DeclaringType:Object
  • Summary:N/A

Format

FormatCore

GetLabelingCandidateCore

  • Parameters:Feature,GeoCanvas
  • DeclaringType:N/A
  • Summary:This method determines which labels will be candidates for drawing.

GetLabelingCandidates

GetRequiredColumnNamesCore

MemberwiseClone

  • Parameters:N/A
  • DeclaringType:Object
  • Summary:N/A

OnFormatted

OnFormatting

lD8=

Public Properties

AbbreviationDictionary

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

Advanced

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

DateFormat

  • Return:String
  • Summary:N/A

DrawingLevel

DuplicateRule

Filters

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

FittingLineInScreen

  • Return:Boolean
  • Summary:N/A

FittingPolygon

  • Return:Boolean
  • Summary:N/A

FittingPolygonFactor

  • Return:Double
  • Summary:N/A

FittingPolygonInScreen

  • Return:Boolean
  • Summary:N/A

Font

ForceHorizontalLabelForLine

  • Return:Boolean
  • Summary:N/A

ForceLineCarriage

  • Return:Boolean
  • Summary:N/A

GridSize

  • Return:Int32
  • Summary:N/A

HaloPen

IconFilePathName

  • Return:String
  • Summary:This property gets and sets the filename and path for the image you want to use in the style.

IconImage

  • Return:GeoImage
  • Summary:This property gets and sets the GeoImage you want to use for the image.

IconImageScale

  • Return:Double
  • Summary:This property gets and sets the scale of the image you want to draw.

IsActive

  • Return:Boolean
  • Summary:N/A

LabelAllLineParts

  • Return:Boolean
  • Summary:N/A

LabelAllPolygonParts

  • Return:Boolean
  • Summary:N/A

LabelPositions

LeaderLineMinimumLengthInPixels

  • Return:Single
  • Summary:N/A

LeaderLineRule

LeaderLineStyle

Mask

MaskMargin

  • Return:Int32
  • Summary:N/A

MaskType

MaxNudgingInPixel

  • Return:Int32
  • Summary:N/A

Name

  • Return:String
  • Summary:N/A

NudgingIntervalInPixel

  • Return:Single
  • Summary:N/A

NumericFormat

  • Return:String
  • Summary:N/A

OverlappingRule

PointPlacement

PolygonLabelingLocationMode

RequiredColumnNames

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

RotationAngle

  • Return:Double
  • Summary:N/A

SplineType

SuppressPartialLabels

  • Return:Boolean
  • Summary:This property gets and sets whether a partial label in the current extent will be drawn or not.

TextColumnName

  • Return:String
  • Summary:N/A

TextFormat

  • Return:String
  • Summary:N/A

TextLineSegmentRatio

  • Return:Double
  • Summary:N/A

TextSolidBrush

XOffsetInPixel

  • Return:Single
  • Summary:N/A

YOffsetInPixel

  • Return:Single
  • Summary:N/A

Protected Properties

AllowSpline

  • Return:Boolean
  • Summary:N/A

FiltersCore

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

uBs=

  • Return:Boolean
  • Summary:N/A

xT8=

  • Return:Boolean
  • Summary:N/A

Public Events

Formatted

Formatting

Public Constructors

IconStyle()

This is the constructor for the class.

Remarks

If you use this, then you should set the properties manually – such as the column name, font, solid brush and the image.

Parameters

IconStyle(String,String,GeoFont,GeoSolidBrush)

This is the constructor for the class.

Remarks

This constructor allows you to pass in the path to the icon, along with the column name, font and solid brush to use. This is the most commonly used constructor. If you need to use an image from a stream, then you should use the constructor that takes a GeoImage.

Parameters

iconPathFilename

  • Type:String
  • Description:This parameter is the path and filename of the icon you want to use. textColumnName * Type:String * Description:This parameter is the column name from which to get the data for the text.

textFont

  • Type:GeoFont
  • Description:This parameter is the font used to draw the text on the icon. textSolidBrush * Type:GeoSolidBrush * Description:This parameter is the solid brush that is used to draw the text on the icon.

Go Back

IconStyle(GeoImage,String,GeoFont,GeoSolidBrush)

This is the constructor for the class.

Remarks

This constructor allows you to use a GeoImage instead of specifying a path and filename of the icon. This is commonly used if the image comes from a stream.

Parameters

iconImage

  • Type:GeoImage
  • Description:This parameter is the image to use in this style. textColumnName * Type:String * Description:This parameter is the column name from which to get the data for the text.

textFont

  • Type:GeoFont
  • Description:This parameter is the font used to draw the text on the icon. textSolidBrush * Type:GeoSolidBrush * Description:This parameter is the solid brush that is used to draw the text on the icon.

Go Back

Protected Constructors

Public Methods

CloneDeep()

N/A

Remarks

N/A

Return Value

  • Return Type:Style
  • Description:N/A

Parameters

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

labelsInThisLayer

labelsInAllLayers

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

labelsInThisLayer

labelsInAllLayers

Go Back

DrawSample(GeoCanvas,DrawingRectangleF)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

canvas

drawingExtent

Go Back

DrawSample(GeoCanvas)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

canvas

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

GetRequiredColumnNames()

N/A

Remarks

N/A

Return Value

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

Parameters

GetType()

N/A

Remarks

N/A

Return Value

  • Return Type:Type
  • Description:N/A

Parameters

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

Protected Methods

AbbreviateText(Feature,GeoCanvas)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

feature

canvas

Go Back

AbbreviateTextCore(Feature,GeoCanvas)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

feature

canvas

Go Back

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

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

labelingCandidate

canvas

labelsInThisLayer

labelsInAllLayers

Go Back

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

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

labelingCandidate

canvas

labelsInThisLayer

labelsInAllLayers

Go Back

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

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

labelingCandidate

canvas

labelsInThisLayer

labelsInAllLayers

Go Back

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

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

labelingCandidate

canvas

labelsInThisLayer

labelsInAllLayers

Go Back

CloneDeepCore()

N/A

Remarks

N/A

Return Value

  • Return Type:Style
  • Description:N/A

Parameters

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

This method draws the features on the canvas 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 canvas 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

  • Return Type:Void
  • Description:None

Parameters

features

  • Type:IEnumerable<Feature>
  • Description:This parameter represents the features you want to draw on the canvas.

canvas

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

labelsInThisLayer

  • Type:Collection<SimpleCandidate>
  • Description:The labels will be drawn in the current layer only.

labelsInAllLayers

  • Type:Collection<SimpleCandidate>
  • Description:The labels will be drawn in all layers.

Go Back

DrawSampleCore(GeoCanvas,DrawingRectangleF)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

canvas

drawingExtent

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

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

Go Back

Finalize()

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

Format(String,BaseShape)

N/A

Remarks

N/A

Return Value

  • Return Type:String
  • Description:N/A

Parameters

text

  • Type:String
  • Description:N/A

labeledShape

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

Go Back

GetLabelingCandidateCore(Feature,GeoCanvas)

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

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

Parameters

feature

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

canvas

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

Go Back

GetLabelingCandidates(Feature,GeoCanvas)

N/A

Remarks

N/A

Return Value

Parameters

feature

canvas

Go Back

GetRequiredColumnNamesCore()

N/A

Remarks

N/A

Return Value

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

Parameters

MemberwiseClone()

N/A

Remarks

N/A

Return Value

  • Return Type:Object
  • Description:N/A

Parameters

OnFormatted(FormattedPositionStyleEventArgs)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

e

Go Back

OnFormatting(FormattingPositionStyleEventArgs)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

e

Go Back

lD8=(PolygonShape,String,GeoCanvas)

N/A

Remarks

N/A

Return Value

Parameters

polygon

text

  • Type:String
  • Description:N/A

canvas

Go Back

Public Properties

AbbreviationDictionary

N/A

Remarks

N/A

Return Value

Return Type:Dictionary<String,String>

Go Back

Advanced

N/A

Remarks

N/A

Return Value

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

N/A

Remarks

N/A

Return Value

Return Type:Collection<TextStyle>

Go Back

DateFormat

N/A

Remarks

N/A

Return Value

Return Type:String

Go Back

DrawingLevel

N/A

Remarks

N/A

Return Value

Return Type:DrawingLevel

Go Back

DuplicateRule

N/A

Remarks

N/A

Return Value

Filters

N/A

Remarks

N/A

Return Value

Return Type:Collection<String>

Go Back

FittingLineInScreen

N/A

Remarks

N/A

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

N/A

Remarks

N/A

Return Value

Return Type:Boolean

Go Back

Font

N/A

Remarks

N/A

Return Value

Return Type:GeoFont

Go Back

ForceHorizontalLabelForLine

N/A

Remarks

N/A

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

N/A

Remarks

N/A

Return Value

Return Type:GeoPen

Go Back

IconFilePathName

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

Return Type:String

Go Back

IconImage

This property gets and sets the GeoImage 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

Return Type:GeoImage

Go Back

IconImageScale

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

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

N/A

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

LeaderLineStyle

N/A

Remarks

N/A

Return Value

Return Type:LineStyle

Go Back

Mask

N/A

Remarks

N/A

Return Value

Return Type:AreaStyle

Go Back

MaskMargin

N/A

Remarks

N/A

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

N/A

Remarks

N/A

Return Value

Return Type:String

Go Back

OverlappingRule

N/A

Remarks

N/A

Return Value

PointPlacement

N/A

Remarks

N/A

Return Value

Return Type:PointPlacement

Go Back

PolygonLabelingLocationMode

N/A

Remarks

N/A

Return Value

RequiredColumnNames

N/A

Remarks

N/A

Return Value

Return Type:Collection<String>

Go Back

RotationAngle

N/A

Remarks

N/A

Return Value

Return Type:Double

Go Back

SplineType

N/A

Remarks

N/A

Return Value

Return Type:SplineType

Go Back

SuppressPartialLabels

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

Return Type:Boolean

Go Back

TextColumnName

N/A

Remarks

N/A

Return Value

Return Type:String

Go Back

TextFormat

N/A

Remarks

N/A

Return Value

Return Type:String

Go Back

TextLineSegmentRatio

N/A

Remarks

N/A

Return Value

Return Type:Double

Go Back

TextSolidBrush

N/A

Remarks

N/A

Return Value

Return Type:GeoSolidBrush

Go Back

XOffsetInPixel

N/A

Remarks

N/A

Return Value

Return Type:Single

Go Back

YOffsetInPixel

N/A

Remarks

N/A

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

xT8=

N/A

Remarks

N/A

Return Value

Return Type:Boolean

Go Back

Public Events

Formatted

N/A

Remarks

Formatting

N/A

Remarks

thinkgeo.mapsuite.core.iconstyle.1442485902.txt.gz · Last modified: 2015/09/17 10:31 by admin