Differences

This shows you the differences between two versions of the page.

--- thinkgeo.mapsuite.portablecore.linestyle [2015/09/21 08:12]
admin
+++ thinkgeo.mapsuite.portablecore.linestyle [2017/03/16 21:59] (current)
@@ Line 1: / Line 1: @@
 ====== ThinkGeo.MapSuite.Core.LineStyle ======
+{{section>upgrade_map_suite_to_10.0}}
 This class is the style used to draw lines.
 ===== Inheritance Hierarchy =====
@@ Line 9: / Line 12: @@
 ** {{wiki:PublicMethod.gif|}} LineStyle() **
-This is a constructor for the class.
+  * //This is a constructor for the class.//
 == Remarks ==
-N/A
+  * //N/A//
 == Parameters ==
 <div newline></div>
 ** {{wiki:PublicMethod.gif|}} LineStyle(GeoPen) **
-This is a constructor for the class.
+  * //This is a constructor for the class.//
 == Remarks ==
-Use this when you do not need any additional pens to draw the feature.
+  * //Use this when you do not need any additional pens to draw the feature.//
 == Parameters ==
   * //outerPen//
@@ Line 27: / Line 30: @@
 ** {{wiki:PublicMethod.gif|}} LineStyle(GeoPen,GeoPen) **
-This is a constructor for the class.
+  * //This is a constructor for the class.//
 == Remarks ==
-This is a common constructor for drawing roads.
+  * //This is a common constructor for drawing roads.//
 == Parameters ==
   * //outerPen//
@@ Line 42: / Line 45: @@
 ** {{wiki:PublicMethod.gif|}} LineStyle(GeoPen,GeoPen,GeoPen) **
-This is a constructor for the class.
+  * //This is a constructor for the class.//
 == Remarks ==
-This is common for drawing low level highways with center lines.
+  * //This is common for drawing low level highways with center lines.//
 == Parameters ==
   * //outerPen//
@@ Line 63: / Line 66: @@
 ** {{wiki:PublicMethod.gif|}} CloneDeep() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 75: / Line 78: @@
 ** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 103: / Line 106: @@
 ** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<BaseShape>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 131: / Line 134: @@
 ** {{wiki:PublicMethod.gif|}} GetRequiredColumnNames() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 143: / Line 146: @@
 ** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas,DrawingRectangleF) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 163: / Line 166: @@
 ** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 174: / Line 177: @@
   * //canvas//
     * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
-    * Description:N/A
-<div newline></div>
-** {{wiki:PublicMethod.gif|}} SaveStyle(String) **
-N/A
-== Remarks ==
-N/A
-== Return Value ==
-  * Type:Void
-  * Description:N/A
-== Parameters ==
-  * //filePathName//
-    * Type:String
-    * Description:N/A
-<div newline></div>
-** {{wiki:PublicMethod.gif|}} SaveStyle(Stream) **
-N/A
-== Remarks ==
-N/A
-== Return Value ==
-  * Type:Void
-  * Description:N/A
-== Parameters ==
-  * //stream//
-    * Type:Stream
     * Description:N/A
@@ Line 211: / Line 182: @@
 ** {{wiki:PublicMethod.gif|}} ToString() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 223: / Line 194: @@
 ** {{wiki:PublicMethod.gif|}} Equals(Object) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 239: / Line 210: @@
 ** {{wiki:PublicMethod.gif|}} GetHashCode() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 251: / Line 222: @@
 ** {{wiki:PublicMethod.gif|}} GetType() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 264: / Line 235: @@
 ** {{wiki:ProtectedMethod.gif|}} DrawCore(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) **
-This method draws the features on the canvas you provided.
+  * //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.
+  * //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 ==
@@ Line 292: / Line 263: @@
 ** {{wiki:ProtectedMethod.gif|}} DrawSampleCore(GeoCanvas,DrawingRectangleF) **
-This method draws a sample feature on the canvas you provided.
+  * //This method draws a sample feature on the canvas you provided.//
 == 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.
+  * //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 ==
@@ Line 312: / Line 283: @@
 ** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 324: / Line 295: @@
 ** {{wiki:ProtectedMethod.gif|}} GetRequiredColumnNamesCore() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 336: / Line 307: @@
 ** {{wiki:ProtectedMethod.gif|}} Finalize() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 348: / Line 319: @@
 ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 361: / Line 332: @@
 ** {{wiki:PublicProperty.gif|}} XOffsetInPixel **
-This property gets and sets the X pixel offset for drawing each feature.
+  * //This property gets and sets the X pixel offset for drawing each feature.//
 == 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.
+  * //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
@@ Line 369: / Line 340: @@
 ** {{wiki:PublicProperty.gif|}} YOffsetInPixel **
-This property gets and sets the Y pixel offset for drawing each feature.
+  * //This property gets and sets the Y pixel offset for drawing each feature.//
 == Remarks ==
-This property allows you to specify an 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.
+  * //This property allows you to specify an 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
@@ Line 377: / Line 348: @@
 ** {{wiki:PublicProperty.gif|}} CustomLineStyles **
-This property returns a collection of line styles, allowing you to stack multiple line styles on top of each other.
+  * //This property returns a collection of line styles, allowing you to stack multiple line styles on top of each other.//
 == Remarks ==
-Using this collection, you can stack multiple styles on top of each other. When we draw the feature, 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.
+  * //Using this collection, you can stack multiple styles on top of each other. When we draw the feature, 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 ==
   * Type:Collection<[[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]]>
@@ Line 385: / Line 356: @@
 ** {{wiki:PublicProperty.gif|}} OuterPen **
-This property gets and sets the outer pen for the line.
+  * //This property gets and sets the outer pen for the line.//
 == Remarks ==
-You can set an inner, outer and center pen to give you a nice effect. The outer pen draws first, and should typically be black and larger then the inner pen. The inner pen draws next, and should be set as the color of the road you want. It should be thinner than the outer pen. The center pen draws last, and is used to represent a centerline in the road. We suggest that you only use the center pen for highways at low zoom level, as the dashed pen has some performance penalties.
+  * //You can set an inner, outer and center pen to give you a nice effect. The outer pen draws first, and should typically be black and larger then the inner pen. The inner pen draws next, and should be set as the color of the road you want. It should be thinner than the outer pen. The center pen draws last, and is used to represent a centerline in the road. We suggest that you only use the center pen for highways at low zoom level, as the dashed pen has some performance penalties.//
 == Return Value ==
   * Type:[[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]]
@@ Line 393: / Line 364: @@
 ** {{wiki:PublicProperty.gif|}} InnerPen **
-This property gets and sets the inner pen for the line.
+  * //This property gets and sets the inner pen for the line.//
 == Remarks ==
-You can set an inner, outer and center pen to give you a nice effect. The outer pen draws first, and should typically be black and larger then the inner pen. The inner pen draws next, and should be set as the color of the road you want. It should be thinner than the outer pen. The center pen draws last, and is used to represent a centerline in the road. We suggest that you only use the center pen for highways at low zoom level, as the dashed pen has some performance penalties.
+  * //You can set an inner, outer and center pen to give you a nice effect. The outer pen draws first, and should typically be black and larger then the inner pen. The inner pen draws next, and should be set as the color of the road you want. It should be thinner than the outer pen. The center pen draws last, and is used to represent a centerline in the road. We suggest that you only use the center pen for highways at low zoom level, as the dashed pen has some performance penalties.//
 == Return Value ==
   * Type:[[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]]
@@ Line 401: / Line 372: @@
 ** {{wiki:PublicProperty.gif|}} CenterPen **
-This property gets and sets the center pen for the line.
+  * //This property gets and sets the center pen for the line.//
 == Remarks ==
-You can set an inner, outer and center pen to give you a nice effect. The outer pen draws first, and should typically be black and larger then the inner pen. The inner pen draws next, and should be set as the color of the road you want. It should be thinner than the outer pen. The center pen draws last, and is used to represent a centerline in the road. We suggest that you only use the center pen for highways at low zoom level, as the dashed pen has some performance penalties.
+  * //You can set an inner, outer and center pen to give you a nice effect. The outer pen draws first, and should typically be black and larger then the inner pen. The inner pen draws next, and should be set as the color of the road you want. It should be thinner than the outer pen. The center pen draws last, and is used to represent a centerline in the road. We suggest that you only use the center pen for highways at low zoom level, as the dashed pen has some performance penalties.//
 == Return Value ==
   * Type:[[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]]
@@ Line 409: / Line 380: @@
 ** {{wiki:PublicProperty.gif|}} OuterPenDrawingLevel **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
   * Type:[[ThinkGeo.MapSuite.Core.DrawingLevel|DrawingLevel]]
@@ Line 417: / Line 388: @@
 ** {{wiki:PublicProperty.gif|}} InnerPenDrawingLevel **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
   * Type:[[ThinkGeo.MapSuite.Core.DrawingLevel|DrawingLevel]]
@@ Line 425: / Line 396: @@
 ** {{wiki:PublicProperty.gif|}} CenterPenDrawingLevel **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
   * Type:[[ThinkGeo.MapSuite.Core.DrawingLevel|DrawingLevel]]
@@ Line 433: / Line 404: @@
 ** {{wiki:PublicProperty.gif|}} Name **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
   * Type:String
@@ Line 441: / Line 412: @@
 ** {{wiki:PublicProperty.gif|}} IsActive **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
   * Type:Boolean
@@ Line 449: / Line 420: @@
 ** {{wiki:PublicProperty.gif|}} RequiredColumnNames **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
   * Type:Collection<String>
@@ Line 457: / Line 428: @@
 ** {{wiki:PublicProperty.gif|}} Filters **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
   * Type:Collection<String>
 ==== Protected Properties ====
-** {{wiki:ProtectedProperty.gif|}} uBs= **
+** {{wiki:ProtectedProperty.gif|}} IsDefault **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
   * Type:Boolean
@@ Line 474: / Line 445: @@
 ** {{wiki:ProtectedProperty.gif|}} FiltersCore **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
   * Type:Collection<String>

User Tools

Site Tools

Differences

Page Tools