====== ThinkGeo.MapSuite.Core.GeoPen ======
{{section>upgrade_map_suite_to_10.0}}
This class represents a GeoPen, which is used to draw lines on a GeoCanvas.
===== Inheritance Hierarchy =====
*System.Object
***ThinkGeo.MapSuite.Core.GeoPen**
===== Members Summary =====
==== Public Constructors ====
** {{wiki:PublicMethod.gif|}} GeoPen() **
* //This constructor creates a GeoPen.//
== Remarks ==
* //N/A//
== Parameters ==
** {{wiki:PublicMethod.gif|}} GeoPen(GeoBrush) **
* //This constructor creates a GeoPen.//
== Remarks ==
* //None//
== Parameters ==
* //brush//
* Type:[[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]]
* Description:This parameter represents the brush that will be used to draw the line.
** {{wiki:PublicMethod.gif|}} GeoPen(GeoColor) **
* //This constructor creates a GeoPen.//
== Remarks ==
* //None//
== Parameters ==
* //color//
* Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
* Description:This parameter represents the color that will be used to draw the line.
** {{wiki:PublicMethod.gif|}} GeoPen(GeoColor,Single) **
* //This constructor creates a GeoPen.//
== Remarks ==
* //None//
== Parameters ==
* //color//
* Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
* Description:This parameter represents the color that will be used to draw the line.
* //width//
* Type:Single
* Description:This parameter represents the width of the line.
** {{wiki:PublicMethod.gif|}} GeoPen(GeoBrush,Single) **
* //This constructor creates a GeoPen.//
== Remarks ==
* //None//
== Parameters ==
* //brush//
* Type:[[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]]
* Description:This parameter represents the brush that will be used to draw the line.
* //width//
* Type:Single
* Description:This parameter represents the width of the line.
==== Protected Constructors ====
==== Public Methods ====
** {{wiki:PublicMethod.gif|}} SetLineCap(DrawingLineCap,DrawingLineCap,GeoDashCap) **
* //This method allows you to set the start, end and dash caps at one time.//
== Remarks ==
* //None//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
* //startCap//
* Type:[[ThinkGeo.MapSuite.Core.DrawingLineCap|DrawingLineCap]]
* Description:This parameter specifies the start cap to be used.
* //endCap//
* Type:[[ThinkGeo.MapSuite.Core.DrawingLineCap|DrawingLineCap]]
* Description:This parameter specifies the end cap to be used.
* //dashCap//
* Type:[[ThinkGeo.MapSuite.Core.GeoDashCap|GeoDashCap]]
* Description:This parameter specifies the dash cap to be used.
** {{wiki:PublicMethod.gif|}} CloneDeep() **
* //Create a copy of GeoPen using the deep clone process.//
== Remarks ==
* //The difference between deep clone and shallow clone is as follows: In shallow cloning, only the object is copied; the objects within it are not. By contrast, deep cloning copies the cloned object as well as all the objects within.//
== Return Value ==
* Type:[[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]]
* Description:A cloned GeoPen.
== Parameters ==
** {{wiki:PublicMethod.gif|}} ToString() **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:String
* Description:N/A
== Parameters ==
** {{wiki:PublicMethod.gif|}} Equals(Object) **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Boolean
* Description:N/A
== Parameters ==
* //obj//
* Type:Object
* Description:N/A
** {{wiki:PublicMethod.gif|}} GetHashCode() **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Int32
* Description:N/A
== Parameters ==
** {{wiki:PublicMethod.gif|}} GetType() **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Type
* Description:N/A
== Parameters ==
==== Protected Methods ====
** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() **
* //Create a copy of GeoPen using the deep clone process. The default implementation uses serialization.//
== Remarks ==
* //The difference between deep clone and shallow clone is as follows: In shallow cloning, only the object is copied; the objects within it are not. By contrast, deep cloning copies the cloned object as well as all the objects within.//
== Return Value ==
* Type:[[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]]
* Description:A cloned GeoPen.
== Parameters ==
** {{wiki:ProtectedMethod.gif|}} Finalize() **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Void
* Description:N/A
== Parameters ==
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **
* //N/A//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Object
* Description:N/A
== Parameters ==
==== Public Properties ====
** {{wiki:PublicProperty.gif|}} Brush **
* //This property gets and sets the brush for this GeoPen.//
== Remarks ==
* //None//
== Return Value ==
* Type:[[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]]
** {{wiki:PublicProperty.gif|}} Color **
* //This property gets and sets the GeoColor for this GeoPen.//
== Remarks ==
* //N/A//
== Return Value ==
* Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]
** {{wiki:PublicProperty.gif|}} DashCap **
* //This property gets and sets the dash cap for this GeoPen.//
== Remarks ==
* //None//
== Return Value ==
* Type:[[ThinkGeo.MapSuite.Core.GeoDashCap|GeoDashCap]]
** {{wiki:PublicProperty.gif|}} DashPattern **
* //This property gets the dash pattern for this GeoPen.//
== Remarks ==
* //Assigning a value other than null (Nothing in Visual Basic) to this property will set the DashStyle property for this GeoPen to Custom. The elements in the dashArray array set the length of each dash and space in the dash pattern. The first element sets the length of a dash, the second element sets the length of a space, the third element sets the length of a dash, and so on. The length of each dash and space in the dash pattern is the product of the element value in the array and the width of the GeoPen.//
== Return Value ==
* Type:Collection
** {{wiki:PublicProperty.gif|}} DashStyle **
* //This property gets and sets the dash style for this GeoPen.//
== Remarks ==
* //None//
== Return Value ==
* Type:[[ThinkGeo.MapSuite.Core.LineDashStyle|LineDashStyle]]
** {{wiki:PublicProperty.gif|}} EndCap **
* //This property gets and sets the end cap for this GeoPen.//
== Remarks ==
* //None//
== Return Value ==
* Type:[[ThinkGeo.MapSuite.Core.DrawingLineCap|DrawingLineCap]]
** {{wiki:PublicProperty.gif|}} LineJoin **
* //This property gets and sets the line join for this GeoPen.//
== Remarks ==
* //None//
== Return Value ==
* Type:[[ThinkGeo.MapSuite.Core.DrawingLineJoin|DrawingLineJoin]]
** {{wiki:PublicProperty.gif|}} MiterLimit **
* //This property gets and sets the miter limit for this GeoPen.//
== Remarks ==
* //None//
== Return Value ==
* Type:Single
** {{wiki:PublicProperty.gif|}} StartCap **
* //This property gets and sets the start cap for this GeoPen.//
== Remarks ==
* //None//
== Return Value ==
* Type:[[ThinkGeo.MapSuite.Core.DrawingLineCap|DrawingLineCap]]
** {{wiki:PublicProperty.gif|}} Width **
* //This property gets and sets the width for this GeoPen.//
== Remarks ==
* //None//
== Return Value ==
* Type:Single
** {{wiki:PublicProperty.gif|}} Id **
* //The id of the GeoBrush. This is always used as a key when in the cached brushes.//
== Remarks ==
* //N/A//
== Return Value ==
* Type:Int64
==== Protected Properties ====
==== Public Events ====