User Tools

Site Tools


api:thinkgeo.mapsuite.styles.textstyle

ThinkGeo.MapSuite.Styles.TextStyle

Inheritance Hierarchy

  • System.Object
    • ThinkGeo.MapSuite.Styles.Style
      • ThinkGeo.MapSuite.Styles.PositionStyle
        • ThinkGeo.MapSuite.Styles.TextStyle

Members Summary

Public Constructors

TextStyle()

  • This is a constructor for the class.
Remarks
  • If you use this constructor, you should set the required properties manually.
Parameters

TextStyle(String,GeoFont,GeoSolidBrush)

  • This is a constructor for the class.
Remarks
  • 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.
Parameters
  • 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
    • Description:This parameter is the TextSolidBrush used to draw the text.

Protected Constructors

Public Methods

CloneDeep()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Style
  • Description:N/A
Parameters

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

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • features
    • Type:IEnumerable<Feature>
    • Description:N/A

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

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • shapes
    • Type:IEnumerable<BaseShape>
    • Description:N/A

GetRequiredColumnNames()

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

DrawSample(GeoCanvas,DrawingRectangleF)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

DrawSample(GeoCanvas)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

SaveStyle(String)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • filePathName
    • Type:String
    • Description:N/A

SaveStyle(Stream)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • stream
    • Type:Stream
    • Description:N/A

ToString()

  • N/A
Remarks
  • N/A
Return Value
  • Type:String
  • Description:N/A
Parameters

Equals(Object)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters
  • obj
    • Type:Object
    • Description:N/A

GetHashCode()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Int32
  • Description:N/A
Parameters

GetType()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Type
  • Description:N/A
Parameters

Protected Methods

DrawSampleCore(GeoCanvas,DrawingRectangleF)

  • N/A
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
  • Type:Void
  • Description:None
Parameters
  • canvas
    • Type:GeoCanvas
    • Description:This parameter represents the canvas you want to draw the features on.

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

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

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

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • features
    • Type:IEnumerable<Feature>
    • Description:N/A

GetRequiredColumnNamesCore()

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

FilterFeatures(IEnumerable<Feature>,GeoCanvas)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • features
    • Type:IEnumerable<Feature>
    • Description:N/A

FilterFeaturesCore(IEnumerable<Feature>,GeoCanvas)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Feature>
  • Description:N/A
Parameters
  • features
    • Type:IEnumerable<Feature>
    • Description:N/A

AbbreviateText(Feature,GeoCanvas)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • feature

AbbreviateTextCore(Feature,GeoCanvas)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • feature

GetLabelingCandidates(Feature,GeoCanvas)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • feature

GetLabelingCandidateCore(Feature,GeoCanvas)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • feature

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

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters

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

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters

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

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters

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

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters

GetLabelingCandidateForOnePolygon(PolygonShape,String,GeoCanvas)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • text
    • Type:String
    • Description:N/A

Format(String,BaseShape)

  • N/A
Remarks
  • N/A
Return Value
  • Type:String
  • Description:N/A
Parameters
  • text
    • Type:String
    • Description:N/A
  • labeledShape

FormatCore(String,BaseShape)

  • N/A
Remarks
  • N/A
Return Value
  • Type:String
  • Description:N/A
Parameters
  • text
    • Type:String
    • Description:N/A
  • labeledShape

OnFormatting(FormattingPositionStyleEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnFormatted(FormattedPositionStyleEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

CloneDeepCore()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Style
  • Description:N/A
Parameters

Finalize()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

MemberwiseClone()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Object
  • Description:N/A
Parameters

Public Properties

XOffsetInPixel

  • N/A
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
  • Type:Single

YOffsetInPixel

  • N/A
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
  • Type:Single

FittingLineInScreen

  • N/A
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
  • Type:Boolean

FittingPolygonInScreen

  • N/A
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
  • Type:Boolean

CustomTextStyles

  • N/A
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

RotationAngle

  • N/A
Remarks
  • None
Return Value
  • Type:Double

TextFormat

  • N/A
Remarks
  • With this property, you can apply formats to the text that is retrieved from the feature.
Return Value
  • Type:String

NumericFormat

  • N/A
Remarks
  • With this property, you can apply formats to the text that is retrieved from the feature.
Return Value
  • Type:String

DateFormat

  • N/A
Remarks
  • With this property, you can apply formats to the text that is retrieved from the feature.
Return Value
  • Type:String

TextSolidBrush

  • N/A
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

Font

  • N/A
Remarks
  • None
Return Value

HaloPen

  • N/A
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

TextColumnName

  • N/A
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
  • Type:String

Mask

  • N/A
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

MaskMargin

  • N/A
Remarks
  • This determines how much larger the mask is than the text, in pixels.
Return Value
  • Type:Int32

Advanced

  • N/A
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

ForceHorizontalLabelForLine

  • N/A
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
  • Type:Boolean

SplineType

  • N/A
Remarks
  • N/A
Return Value

DrawingLevel

  • N/A
Remarks
  • N/A
Return Value

LabelPositions

  • N/A
Remarks
  • N/A
Return Value

PolygonLabelingLocationMode

  • N/A
Remarks
  • N/A
Return Value

MaxNudgingInPixel

  • N/A
Remarks
  • N/A
Return Value
  • Type:Int32

NudgingIntervalInPixel

  • N/A
Remarks
  • N/A
Return Value
  • Type:Single

BestPlacementSymbolWidth

  • N/A
Remarks
  • N/A
Return Value
  • Type:Single

BestPlacementSymbolHeight

  • N/A
Remarks
  • N/A
Return Value
  • Type:Single

AbbreviationDictionary

  • N/A
Remarks
  • N/A
Return Value
  • Type:Dictionary<String,String>

LeaderLineStyle

  • N/A
Remarks
  • N/A
Return Value

LeaderLineRule

  • N/A
Remarks
  • N/A
Return Value

LeaderLineMinimumLengthInPixels

  • N/A
Remarks
  • N/A
Return Value
  • Type:Single

GridSize

  • N/A
Remarks
  • N/A
Return Value
  • Type:Int32

DuplicateRule

  • N/A
Remarks
  • N/A
Return Value

OverlappingRule

  • N/A
Remarks
  • N/A
Return Value

AllowLineCarriage

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

SuppressPartialLabels

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

ForceLineCarriage

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

FittingPolygon

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

LabelAllPolygonParts

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

LabelAllLineParts

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

FittingPolygonFactor

  • N/A
Remarks
  • N/A
Return Value
  • Type:Double

TextLineSegmentRatio

  • N/A
Remarks
  • N/A
Return Value
  • Type:Double

BestPlacement

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

PointPlacement

  • N/A
Remarks
  • N/A
Return Value

IsDefault

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

MaskType

  • N/A
Remarks
  • N/A
Return Value

Name

  • N/A
Remarks
  • N/A
Return Value
  • Type:String

StyleClass

  • N/A
Remarks
  • N/A
Return Value
  • Type:String

IsActive

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

RequiredColumnNames

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<String>

Filters

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<String>

Protected Properties

AllowSpline

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

FiltersCore

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<String>

Public Events

Formatting

  • N/A
Remarks
  • N/A

Event Arguments:FormattingPositionStyleEventArgs

Formatted

  • N/A
Remarks
  • N/A

Event Arguments:FormattedPositionStyleEventArgs

api/thinkgeo.mapsuite.styles.textstyle.txt · Last modified: 2017/01/11 06:49 (external edit)