User Tools

Site Tools


thinkgeo.mapsuite.portablecore.textstyle

Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
thinkgeo.mapsuite.portablecore.textstyle [2015/09/21 08:19]
admin
thinkgeo.mapsuite.portablecore.textstyle [2017/03/16 21:59] (current)
Line 1: Line 1:
 ====== ThinkGeo.MapSuite.Core.TextStyle ====== ====== ThinkGeo.MapSuite.Core.TextStyle ======
 +
 +{{section>​upgrade_map_suite_to_10.0}}
 +
 This class is used to label features on the map. This class is used to label features on the map.
 ===== Inheritance Hierarchy ===== ===== Inheritance Hierarchy =====
Line 11: Line 14:
 ** {{wiki:​PublicMethod.gif|}} TextStyle() ** ** {{wiki:​PublicMethod.gif|}} TextStyle() **
  
-This is a constructor for the class.+  * //This is a constructor for the class.//
 == Remarks == == Remarks ==
-If you use this constructor,​ you should set the required properties manually.+  * //If you use this constructor,​ you should set the required properties manually.//
 == Parameters == == Parameters ==
 <div newline></​div>​ <div newline></​div>​
 ** {{wiki:​PublicMethod.gif|}} TextStyle(String,​GeoFont,​GeoSolidBrush) ** ** {{wiki:​PublicMethod.gif|}} TextStyle(String,​GeoFont,​GeoSolidBrush) **
  
-This is a constructor for the class.+  * //This is a constructor for the class.//
 == Remarks == == 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.+  * //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 == == Parameters ==
   * //​textColumnName//​   * //​textColumnName//​
Line 39: Line 42:
 ** {{wiki:​PublicMethod.gif|}} CloneDeep() ** ** {{wiki:​PublicMethod.gif|}} CloneDeep() **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
  
 == Return Value == == Return Value ==
Line 51: Line 54:
 ** {{wiki:​PublicMethod.gif|}} Draw(IEnumerable<​Feature>,​GeoCanvas,​Collection<​SimpleCandidate>,​Collection<​SimpleCandidate>​) ** ** {{wiki:​PublicMethod.gif|}} Draw(IEnumerable<​Feature>,​GeoCanvas,​Collection<​SimpleCandidate>,​Collection<​SimpleCandidate>​) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
  
 == Return Value == == Return Value ==
Line 79: Line 82:
 ** {{wiki:​PublicMethod.gif|}} Draw(IEnumerable<​BaseShape>,​GeoCanvas,​Collection<​SimpleCandidate>,​Collection<​SimpleCandidate>​) ** ** {{wiki:​PublicMethod.gif|}} Draw(IEnumerable<​BaseShape>,​GeoCanvas,​Collection<​SimpleCandidate>,​Collection<​SimpleCandidate>​) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
  
 == Return Value == == Return Value ==
Line 107: Line 110:
 ** {{wiki:​PublicMethod.gif|}} GetRequiredColumnNames() ** ** {{wiki:​PublicMethod.gif|}} GetRequiredColumnNames() **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
  
 == Return Value == == Return Value ==
Line 119: Line 122:
 ** {{wiki:​PublicMethod.gif|}} DrawSample(GeoCanvas,​DrawingRectangleF) ** ** {{wiki:​PublicMethod.gif|}} DrawSample(GeoCanvas,​DrawingRectangleF) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
  
 == Return Value == == Return Value ==
Line 139: Line 142:
 ** {{wiki:​PublicMethod.gif|}} DrawSample(GeoCanvas) ** ** {{wiki:​PublicMethod.gif|}} DrawSample(GeoCanvas) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
  
 == Return Value == == Return Value ==
Line 150: Line 153:
   * //canvas//   * //canvas//
     * Type:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]     * 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     * Description:​N/​A
  
Line 187: Line 158:
 ** {{wiki:​PublicMethod.gif|}} ToString() ** ** {{wiki:​PublicMethod.gif|}} ToString() **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
  
 == Return Value == == Return Value ==
Line 199: Line 170:
 ** {{wiki:​PublicMethod.gif|}} Equals(Object) ** ** {{wiki:​PublicMethod.gif|}} Equals(Object) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
  
 == Return Value == == Return Value ==
Line 215: Line 186:
 ** {{wiki:​PublicMethod.gif|}} GetHashCode() ** ** {{wiki:​PublicMethod.gif|}} GetHashCode() **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
  
 == Return Value == == Return Value ==
Line 227: Line 198:
 ** {{wiki:​PublicMethod.gif|}} GetType() ** ** {{wiki:​PublicMethod.gif|}} GetType() **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
  
 == Return Value == == Return Value ==
Line 240: Line 211:
 ** {{wiki:​ProtectedMethod.gif|}} DrawSampleCore(GeoCanvas,​DrawingRectangleF) ** ** {{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 == == 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 == == Return Value ==
Line 258: Line 229:
  
 <div newline></​div>​ <div newline></​div>​
-** {{wiki:​ProtectedMethod.gif|}} ​DrawCore(IEnumerable<​Feature>​,GeoCanvas,​Collection<​SimpleCandidate>,​Collection<​SimpleCandidate>​) **+** {{wiki:​ProtectedMethod.gif|}} ​Format(String,BaseShape) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
  
 == Return Value == == Return Value ==
-  * Type:Void+  * Type:String
   * Description:​N/​A   * Description:​N/​A
  
 == Parameters == == Parameters ==
-  * //features// +  * //text// 
-    * Type:IEnumerable<​[[ThinkGeo.MapSuite.Core.Feature|Feature]]>​+    * Type:String
     * Description:​N/​A     * Description:​N/​A
  
-  * //canvas// +  * //labeledShape// 
-    * Type:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]+    * Type:​[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]
     * Description:​N/​A     * Description:​N/​A
  
-  ​* //labelsInThisLayer// +<div newline></​div>​ 
-    * Type:Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>​+** {{wiki:​ProtectedMethod.gif|}} FormatCore(String,​BaseShape) ** 
 + 
 +  ​* //N/A// 
 +== Remarks == 
 +  * //N/A// 
 + 
 +== Return Value == 
 +  * Type:​String 
 +  * Description:​N/​A 
 + 
 +== Parameters == 
 +  * //text// 
 +    * Type:String
     * Description:​N/​A     * Description:​N/​A
  
-  * //labelsInAllLayers// +  * //labeledShape// 
-    * Type:Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>+    * Type:​[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]
     * Description:​N/​A     * Description:​N/​A
  
 <div newline></​div>​ <div newline></​div>​
-** {{wiki:​ProtectedMethod.gif|}} ​GetRequiredColumnNamesCore() **+** {{wiki:​ProtectedMethod.gif|}} ​OnFormatting(FormattingPositionStyleEventArgs) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
  
 == Return Value == == Return Value ==
-  * Type:Collection<​String>​+  * Type:Void
   * Description:​N/​A   * Description:​N/​A
  
 == Parameters == == Parameters ==
 +  * //e//
 +    * Type:​[[ThinkGeo.MapSuite.Core.FormattingPositionStyleEventArgs|FormattingPositionStyleEventArgs]]
 +    * Description:​N/​A
 +
 <div newline></​div>​ <div newline></​div>​
-** {{wiki:​ProtectedMethod.gif|}} ​FilterFeatures(IEnumerable<​Feature>,​GeoCanvas) **+** {{wiki:​ProtectedMethod.gif|}} ​OnFormatted(FormattedPositionStyleEventArgs) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
  
 == Return Value == == Return Value ==
-  * Type:Collection<​[[ThinkGeo.MapSuite.Core.Feature|Feature]]>​+  * Type:Void
   * Description:​N/​A   * Description:​N/​A
  
 == Parameters == == Parameters ==
-  * //features// +  * //e// 
-    * Type:IEnumerable<​[[ThinkGeo.MapSuite.Core.Feature|Feature]]>​ +    * Type:​[[ThinkGeo.MapSuite.Core.FormattedPositionStyleEventArgs|FormattedPositionStyleEventArgs]]
-    * Description:​N/​A +
- +
-  * //​canvas//​ +
-    * Type:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]+
     * Description:​N/​A     * Description:​N/​A
  
 <div newline></​div>​ <div newline></​div>​
-** {{wiki:​ProtectedMethod.gif|}} ​FilterFeaturesCore(IEnumerable<​Feature>,​GeoCanvas) **+** {{wiki:​ProtectedMethod.gif|}} ​DrawCore(IEnumerable<​Feature>,​GeoCanvas,​Collection<​SimpleCandidate>,​Collection<​SimpleCandidate>​) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
  
 == Return Value == == Return Value ==
-  * Type:Collection<​[[ThinkGeo.MapSuite.Core.Feature|Feature]]>​+  * Type:Void
   * Description:​N/​A   * Description:​N/​A
  
Line 335: Line 318:
   * //canvas//   * //canvas//
     * Type:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]     * Type:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
 +    * Description:​N/​A
 +
 +  * //​labelsInThisLayer//​
 +    * Type:​Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>​
 +    * Description:​N/​A
 +
 +  * //​labelsInAllLayers//​
 +    * Type:​Collection<​[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>​
     * Description:​N/​A     * Description:​N/​A
  
 <div newline></​div>​ <div newline></​div>​
-** {{wiki:​ProtectedMethod.gif|}} ​AbbreviateText(Feature,​GeoCanvas) **+** {{wiki:​ProtectedMethod.gif|}} ​GetRequiredColumnNamesCore() **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
  
 == Return Value == == Return Value ==
-  * Type:Void+  * Type:Collection<​String>​
   * Description:​N/​A   * Description:​N/​A
  
 == Parameters == == Parameters ==
-  ​* //feature// +<div newline></​div>​ 
-    * Type:​[[ThinkGeo.MapSuite.Core.Feature|Feature]]+** {{wiki:​ProtectedMethod.gif|}} FilterFeatures(IEnumerable<​Feature>,​GeoCanvas) ** 
 + 
 +  * //N/A// 
 +== Remarks == 
 +  * //N/A// 
 + 
 +== Return Value == 
 +  * Type:​Collection<​[[ThinkGeo.MapSuite.Core.Feature|Feature]]>​ 
 +  * Description:​N/​A 
 + 
 +== Parameters == 
 +  ​* //features// 
 +    * Type:IEnumerable<​[[ThinkGeo.MapSuite.Core.Feature|Feature]]>
     * Description:​N/​A     * Description:​N/​A
  
Line 358: Line 361:
  
 <div newline></​div>​ <div newline></​div>​
-** {{wiki:​ProtectedMethod.gif|}} ​AbbreviateTextCore(Feature,​GeoCanvas) **+** {{wiki:​ProtectedMethod.gif|}} ​FilterFeaturesCore(IEnumerable<​Feature>,GeoCanvas) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
  
 == Return Value == == Return Value ==
-  * Type:Void+  * Type:Collection<​[[ThinkGeo.MapSuite.Core.Feature|Feature]]>​
   * Description:​N/​A   * Description:​N/​A
  
 == Parameters == == Parameters ==
-  * //feature// +  * //features// 
-    * Type:​[[ThinkGeo.MapSuite.Core.Feature|Feature]]+    * Type:IEnumerable<​[[ThinkGeo.MapSuite.Core.Feature|Feature]]>
     * Description:​N/​A     * Description:​N/​A
  
Line 380: Line 383:
 ** {{wiki:​ProtectedMethod.gif|}} GetLabelingCandidates(Feature,​GeoCanvas) ** ** {{wiki:​ProtectedMethod.gif|}} GetLabelingCandidates(Feature,​GeoCanvas) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
  
 == Return Value == == Return Value ==
Line 400: Line 403:
 ** {{wiki:​ProtectedMethod.gif|}} GetLabelingCandidateCore(Feature,​GeoCanvas) ** ** {{wiki:​ProtectedMethod.gif|}} GetLabelingCandidateCore(Feature,​GeoCanvas) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
  
 == Return Value == == Return Value ==
Line 420: Line 423:
 ** {{wiki:​ProtectedMethod.gif|}} CheckDuplicate(LabelingCandidate,​GeoCanvas,​Collection<​SimpleCandidate>,​Collection<​SimpleCandidate>​) ** ** {{wiki:​ProtectedMethod.gif|}} CheckDuplicate(LabelingCandidate,​GeoCanvas,​Collection<​SimpleCandidate>,​Collection<​SimpleCandidate>​) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
  
 == Return Value == == Return Value ==
Line 448: Line 451:
 ** {{wiki:​ProtectedMethod.gif|}} CheckDuplicateCore(LabelingCandidate,​GeoCanvas,​Collection<​SimpleCandidate>,​Collection<​SimpleCandidate>​) ** ** {{wiki:​ProtectedMethod.gif|}} CheckDuplicateCore(LabelingCandidate,​GeoCanvas,​Collection<​SimpleCandidate>,​Collection<​SimpleCandidate>​) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
  
 == Return Value == == Return Value ==
Line 476: Line 479:
 ** {{wiki:​ProtectedMethod.gif|}} CheckOverlapping(LabelingCandidate,​GeoCanvas,​Collection<​SimpleCandidate>,​Collection<​SimpleCandidate>​) ** ** {{wiki:​ProtectedMethod.gif|}} CheckOverlapping(LabelingCandidate,​GeoCanvas,​Collection<​SimpleCandidate>,​Collection<​SimpleCandidate>​) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
  
 == Return Value == == Return Value ==
Line 504: Line 507:
 ** {{wiki:​ProtectedMethod.gif|}} CheckOverlappingCore(LabelingCandidate,​GeoCanvas,​Collection<​SimpleCandidate>,​Collection<​SimpleCandidate>​) ** ** {{wiki:​ProtectedMethod.gif|}} CheckOverlappingCore(LabelingCandidate,​GeoCanvas,​Collection<​SimpleCandidate>,​Collection<​SimpleCandidate>​) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
  
 == Return Value == == Return Value ==
Line 530: Line 533:
  
 <div newline></​div>​ <div newline></​div>​
-** {{wiki:​ProtectedMethod.gif|}} ​lD8=(PolygonShape,​String,​GeoCanvas) **+** {{wiki:​ProtectedMethod.gif|}} ​GetLabelingCandidateForOnePolygon(PolygonShape,​String,​GeoCanvas) **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
  
 == Return Value == == Return Value ==
Line 551: Line 554:
   * //canvas//   * //canvas//
     * Type:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]     * Type:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
-    * Description:​N/​A 
- 
-<div newline></​div>​ 
-** {{wiki:​ProtectedMethod.gif|}} Format(String,​BaseShape) ** 
- 
-N/A 
-== Remarks == 
-N/A 
- 
-== Return Value == 
-  * Type:String 
-  * Description:​N/​A 
- 
-== Parameters == 
-  * //text// 
-    * Type:String 
-    * Description:​N/​A 
- 
-  * //​labeledShape//​ 
-    * Type:​[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] 
-    * Description:​N/​A 
- 
-<div newline></​div>​ 
-** {{wiki:​ProtectedMethod.gif|}} FormatCore(String,​BaseShape) ** 
- 
-N/A 
-== Remarks == 
-N/A 
- 
-== Return Value == 
-  * Type:String 
-  * Description:​N/​A 
- 
-== Parameters == 
-  * //text// 
-    * Type:String 
-    * Description:​N/​A 
- 
-  * //​labeledShape//​ 
-    * Type:​[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]] 
-    * Description:​N/​A 
- 
-<div newline></​div>​ 
-** {{wiki:​ProtectedMethod.gif|}} OnFormatting(FormattingPositionStyleEventArgs) ** 
- 
-N/A 
-== Remarks == 
-N/A 
- 
-== Return Value == 
-  * Type:Void 
-  * Description:​N/​A 
- 
-== Parameters == 
-  * //e// 
-    * Type:​[[ThinkGeo.MapSuite.Core.FormattingPositionStyleEventArgs|FormattingPositionStyleEventArgs]] 
-    * Description:​N/​A 
- 
-<div newline></​div>​ 
-** {{wiki:​ProtectedMethod.gif|}} OnFormatted(FormattedPositionStyleEventArgs) ** 
- 
-N/A 
-== Remarks == 
-N/A 
- 
-== Return Value == 
-  * Type:Void 
-  * Description:​N/​A 
- 
-== Parameters == 
-  * //e// 
-    * Type:​[[ThinkGeo.MapSuite.Core.FormattedPositionStyleEventArgs|FormattedPositionStyleEventArgs]] 
     * Description:​N/​A     * Description:​N/​A
  
Line 628: Line 559:
 ** {{wiki:​ProtectedMethod.gif|}} CloneDeepCore() ** ** {{wiki:​ProtectedMethod.gif|}} CloneDeepCore() **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
  
 == Return Value == == Return Value ==
Line 640: Line 571:
 ** {{wiki:​ProtectedMethod.gif|}} Finalize() ** ** {{wiki:​ProtectedMethod.gif|}} Finalize() **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
  
 == Return Value == == Return Value ==
Line 652: Line 583:
 ** {{wiki:​ProtectedMethod.gif|}} MemberwiseClone() ** ** {{wiki:​ProtectedMethod.gif|}} MemberwiseClone() **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
  
 == Return Value == == Return Value ==
Line 665: Line 596:
 ** {{wiki:​PublicProperty.gif|}} XOffsetInPixel ** ** {{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 == == 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 == == Return Value ==
   * Type:Single   * Type:Single
Line 673: Line 604:
 ** {{wiki:​PublicProperty.gif|}} YOffsetInPixel ** ** {{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 == == 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.+  * //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 == == Return Value ==
   * Type:Single   * Type:Single
Line 681: Line 612:
 ** {{wiki:​PublicProperty.gif|}} FittingLineInScreen ** ** {{wiki:​PublicProperty.gif|}} FittingLineInScreen **
  
-This property gets and sets whether the labeler will try to fit the label as best as it can on the visible part of a line on the screen.+  * //This property gets and sets whether the labeler will try to fit the label as best as it can on the visible part of a line on the screen.//
 == Remarks == == 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.+  * //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 == == Return Value ==
   * Type:​Boolean   * Type:​Boolean
Line 689: Line 620:
 ** {{wiki:​PublicProperty.gif|}} FittingPolygonInScreen ** ** {{wiki:​PublicProperty.gif|}} FittingPolygonInScreen **
  
-This property gets and sets whether the labeler will try to fit the label as best as it can on the visible part of a polygon on the screen.+  * //This property gets and sets whether the labeler will try to fit the label as best as it can on the visible part of a polygon on the screen.//
 == Remarks == == 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.+  * //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 == == Return Value ==
   * Type:​Boolean   * Type:​Boolean
Line 697: Line 628:
 ** {{wiki:​PublicProperty.gif|}} CustomTextStyles ** ** {{wiki:​PublicProperty.gif|}} CustomTextStyles **
  
-This property returns a collection of area styles allowing you to stack multiple area styles on top of each other.+  * //This property returns a collection of area styles allowing you to stack multiple area styles on top of each other.//
 == Remarks == == 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.+  * //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 == == Return Value ==
   * Type:​Collection<​[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]>​   * Type:​Collection<​[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]>​
Line 705: Line 636:
 ** {{wiki:​PublicProperty.gif|}} RotationAngle ** ** {{wiki:​PublicProperty.gif|}} RotationAngle **
  
-This property gets and sets the rotation angle of the item being positioned.+  * //This property gets and sets the rotation angle of the item being positioned.//
 == Remarks == == Remarks ==
-None+  * //None//
 == Return Value == == Return Value ==
   * Type:Double   * Type:Double
Line 713: Line 644:
 ** {{wiki:​PublicProperty.gif|}} TextFormat ** ** {{wiki:​PublicProperty.gif|}} TextFormat **
  
-This property gets and sets the format that will be applied to the text.+  * //This property gets and sets the format that will be applied to the text.//
 == Remarks == == Remarks ==
-With this property, you can apply formats to the text that is retrieved from the feature.+  * //With this property, you can apply formats to the text that is retrieved from the feature.//
 == Return Value == == Return Value ==
   * Type:String   * Type:String
Line 721: Line 652:
 ** {{wiki:​PublicProperty.gif|}} NumericFormat ** ** {{wiki:​PublicProperty.gif|}} NumericFormat **
  
-This property gets and sets the format that will be applied to the text which can be parsed to double type.+  * //This property gets and sets the format that will be applied to the text which can be parsed to double type.//
 == Remarks == == Remarks ==
-With this property, you can apply formats to the text that is retrieved from the feature.+  * //With this property, you can apply formats to the text that is retrieved from the feature.//
 == Return Value == == Return Value ==
   * Type:String   * Type:String
Line 729: Line 660:
 ** {{wiki:​PublicProperty.gif|}} DateFormat ** ** {{wiki:​PublicProperty.gif|}} DateFormat **
  
-This property gets and sets the format that will be applied to the text which can be parsed to DateTime type.+  * //This property gets and sets the format that will be applied to the text which can be parsed to DateTime type.//
 == Remarks == == Remarks ==
-With this property, you can apply formats to the text that is retrieved from the feature.+  * //With this property, you can apply formats to the text that is retrieved from the feature.//
 == Return Value == == Return Value ==
   * Type:String   * Type:String
Line 737: Line 668:
 ** {{wiki:​PublicProperty.gif|}} TextSolidBrush ** ** {{wiki:​PublicProperty.gif|}} TextSolidBrush **
  
-This property gets and sets the SolidBrush that will be used to draw the text.+  * //This property gets and sets the SolidBrush that will be used to draw the text.//
 == Remarks == == 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.+  * //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 == == Return Value ==
   * Type:​[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]]   * Type:​[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]]
Line 745: Line 676:
 ** {{wiki:​PublicProperty.gif|}} Font ** ** {{wiki:​PublicProperty.gif|}} Font **
  
-This property gets and sets the font that will be used to draw the text.+  * //This property gets and sets the font that will be used to draw the text.//
 == Remarks == == Remarks ==
-None+  * //None//
 == Return Value == == Return Value ==
   * Type:​[[ThinkGeo.MapSuite.Core.GeoFont|GeoFont]]   * Type:​[[ThinkGeo.MapSuite.Core.GeoFont|GeoFont]]
Line 753: Line 684:
 ** {{wiki:​PublicProperty.gif|}} HaloPen ** ** {{wiki:​PublicProperty.gif|}} HaloPen **
  
-This property gets and sets the halo pen you may use to draw a halo around the text.+  * //This property gets and sets the halo pen you may use to draw a halo around the text.//
 == Remarks == == Remarks ==
-The halo pen allows you to draw a halo effect around the text, making it stand out more on a busy background.+  * //The halo pen allows you to draw a halo effect around the text, making it stand out more on a busy background.//
 == Return Value == == Return Value ==
   * Type:​[[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]]   * Type:​[[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]]
Line 761: Line 692:
 ** {{wiki:​PublicProperty.gif|}} TextColumnName ** ** {{wiki:​PublicProperty.gif|}} TextColumnName **
  
-This property gets and sets the column name in the data that you want to get the text from.+  * //This property gets and sets the column name in the data that you want to get the text from.//
 == Remarks == == 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.+  * //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 == == Return Value ==
   * Type:String   * Type:String
Line 769: Line 700:
 ** {{wiki:​PublicProperty.gif|}} Mask ** ** {{wiki:​PublicProperty.gif|}} Mask **
  
-This property gets and sets the AreaStyle used to draw a mask behind the text.+  * //This property gets and sets the AreaStyle used to draw a mask behind the text.//
 == Remarks == == 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.+  * //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 == == Return Value ==
   * Type:​[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]   * Type:​[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]
Line 777: Line 708:
 ** {{wiki:​PublicProperty.gif|}} MaskMargin ** ** {{wiki:​PublicProperty.gif|}} MaskMargin **
  
-This property gets and sets the margin around the text that will be used for the mask.+  * //This property gets and sets the margin around the text that will be used for the mask.//
 == Remarks == == Remarks ==
-This determines how much larger the mask is than the text, in pixels.+  * //This determines how much larger the mask is than the text, in pixels.//
 == Return Value == == Return Value ==
   * Type:Int32   * Type:Int32
Line 785: Line 716:
 ** {{wiki:​PublicProperty.gif|}} Advanced ** ** {{wiki:​PublicProperty.gif|}} Advanced **
  
-This property gets the advanced properties of the class.+  * //This property gets the advanced properties of the class.//
 == Remarks == == 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.+  * //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 == == Return Value ==
   * Type:​[[ThinkGeo.MapSuite.Core.TextStyleAdvanced|TextStyleAdvanced]]   * Type:​[[ThinkGeo.MapSuite.Core.TextStyleAdvanced|TextStyleAdvanced]]
Line 793: Line 724:
 ** {{wiki:​PublicProperty.gif|}} ForceHorizontalLabelForLine ** ** {{wiki:​PublicProperty.gif|}} ForceHorizontalLabelForLine **
  
-This property gets and sets whether we should force horizontal labeling for lines.+  * //This property gets and sets whether we should force horizontal labeling for lines.//
 == Remarks == == 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.+  * //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 == == Return Value ==
   * Type:​Boolean   * Type:​Boolean
Line 801: Line 732:
 ** {{wiki:​PublicProperty.gif|}} SplineType ** ** {{wiki:​PublicProperty.gif|}} SplineType **
  
-Gets or sets the SplineType for labeling.+  * //Gets or sets the SplineType for labeling.//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
 == Return Value == == Return Value ==
   * Type:​[[ThinkGeo.MapSuite.Core.SplineType|SplineType]]   * Type:​[[ThinkGeo.MapSuite.Core.SplineType|SplineType]]
Line 809: Line 740:
 ** {{wiki:​PublicProperty.gif|}} DrawingLevel ** ** {{wiki:​PublicProperty.gif|}} DrawingLevel **
  
-Gets or sets the DrawingLavel for this style.+  * //Gets or sets the DrawingLavel for this style.//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
 == Return Value == == Return Value ==
   * Type:​[[ThinkGeo.MapSuite.Core.DrawingLevel|DrawingLevel]]   * Type:​[[ThinkGeo.MapSuite.Core.DrawingLevel|DrawingLevel]]
Line 817: Line 748:
 ** {{wiki:​PublicProperty.gif|}} LabelPositions ** ** {{wiki:​PublicProperty.gif|}} LabelPositions **
  
-Gets a value represents a keyValuepair which is a feature id and label position of the feature+  * //Gets a value represents a keyValuepair which is a feature id and label position of the feature//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
 == Return Value == == Return Value ==
   * Type:​Dictionary<​String,​[[ThinkGeo.MapSuite.Core.WorldLabelingCandidate|WorldLabelingCandidate]]>​   * Type:​Dictionary<​String,​[[ThinkGeo.MapSuite.Core.WorldLabelingCandidate|WorldLabelingCandidate]]>​
Line 825: Line 756:
 ** {{wiki:​PublicProperty.gif|}} PolygonLabelingLocationMode ** ** {{wiki:​PublicProperty.gif|}} PolygonLabelingLocationMode **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
 == Return Value == == Return Value ==
   * Type:​[[ThinkGeo.MapSuite.Core.PolygonLabelingLocationMode|PolygonLabelingLocationMode]]   * Type:​[[ThinkGeo.MapSuite.Core.PolygonLabelingLocationMode|PolygonLabelingLocationMode]]
- 
-** {{wiki:​PublicProperty.gif|}} MaxNudgingInPixel ** 
- 
-N/A 
-== Remarks == 
-N/A 
-== Return Value == 
-  * Type:Int32 
- 
-** {{wiki:​PublicProperty.gif|}} NudgingIntervalInPixel ** 
- 
-N/A 
-== Remarks == 
-N/A 
-== Return Value == 
-  * Type:Single 
- 
-** {{wiki:​PublicProperty.gif|}} BestPlacementSymbolWidth ** 
- 
-N/A 
-== Remarks == 
-N/A 
-== Return Value == 
-  * Type:Single 
- 
-** {{wiki:​PublicProperty.gif|}} BestPlacementSymbolHeight ** 
- 
-N/A 
-== Remarks == 
-N/A 
-== Return Value == 
-  * Type:Single 
- 
-** {{wiki:​PublicProperty.gif|}} AbbreviationDictionary ** 
- 
-N/A 
-== Remarks == 
-N/A 
-== Return Value == 
-  * Type:​Dictionary<​String,​String>​ 
- 
-** {{wiki:​PublicProperty.gif|}} LeaderLineStyle ** 
- 
-N/A 
-== Remarks == 
-N/A 
-== Return Value == 
-  * Type:​[[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]] 
- 
-** {{wiki:​PublicProperty.gif|}} LeaderLineRule ** 
- 
-N/A 
-== Remarks == 
-N/A 
-== Return Value == 
-  * Type:​[[ThinkGeo.MapSuite.Core.LabelLeaderLinesRule|LabelLeaderLinesRule]] 
- 
-** {{wiki:​PublicProperty.gif|}} LeaderLineMinimumLengthInPixels ** 
- 
-N/A 
-== Remarks == 
-N/A 
-== Return Value == 
-  * Type:Single 
  
 ** {{wiki:​PublicProperty.gif|}} GridSize ** ** {{wiki:​PublicProperty.gif|}} GridSize **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
 == Return Value == == Return Value ==
   * Type:Int32   * Type:Int32
Line 905: Line 772:
 ** {{wiki:​PublicProperty.gif|}} DuplicateRule ** ** {{wiki:​PublicProperty.gif|}} DuplicateRule **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
 == Return Value == == Return Value ==
   * Type:​[[ThinkGeo.MapSuite.Core.LabelDuplicateRule|LabelDuplicateRule]]   * Type:​[[ThinkGeo.MapSuite.Core.LabelDuplicateRule|LabelDuplicateRule]]
Line 913: Line 780:
 ** {{wiki:​PublicProperty.gif|}} OverlappingRule ** ** {{wiki:​PublicProperty.gif|}} OverlappingRule **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
 == Return Value == == Return Value ==
   * Type:​[[ThinkGeo.MapSuite.Core.LabelOverlappingRule|LabelOverlappingRule]]   * Type:​[[ThinkGeo.MapSuite.Core.LabelOverlappingRule|LabelOverlappingRule]]
Line 921: Line 788:
 ** {{wiki:​PublicProperty.gif|}} AllowLineCarriage ** ** {{wiki:​PublicProperty.gif|}} AllowLineCarriage **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
 == Return Value == == Return Value ==
   * Type:​Boolean   * Type:​Boolean
Line 929: Line 796:
 ** {{wiki:​PublicProperty.gif|}} SuppressPartialLabels ** ** {{wiki:​PublicProperty.gif|}} SuppressPartialLabels **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
 == Return Value == == Return Value ==
   * Type:​Boolean   * Type:​Boolean
Line 937: Line 804:
 ** {{wiki:​PublicProperty.gif|}} ForceLineCarriage ** ** {{wiki:​PublicProperty.gif|}} ForceLineCarriage **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
 == Return Value == == Return Value ==
   * Type:​Boolean   * Type:​Boolean
Line 945: Line 812:
 ** {{wiki:​PublicProperty.gif|}} FittingPolygon ** ** {{wiki:​PublicProperty.gif|}} FittingPolygon **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
 == Return Value == == Return Value ==
   * Type:​Boolean   * Type:​Boolean
Line 953: Line 820:
 ** {{wiki:​PublicProperty.gif|}} LabelAllPolygonParts ** ** {{wiki:​PublicProperty.gif|}} LabelAllPolygonParts **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
 == Return Value == == Return Value ==
   * Type:​Boolean   * Type:​Boolean
Line 961: Line 828:
 ** {{wiki:​PublicProperty.gif|}} LabelAllLineParts ** ** {{wiki:​PublicProperty.gif|}} LabelAllLineParts **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
 == Return Value == == Return Value ==
   * Type:​Boolean   * Type:​Boolean
Line 969: Line 836:
 ** {{wiki:​PublicProperty.gif|}} FittingPolygonFactor ** ** {{wiki:​PublicProperty.gif|}} FittingPolygonFactor **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
 == Return Value == == Return Value ==
   * Type:Double   * Type:Double
Line 977: Line 844:
 ** {{wiki:​PublicProperty.gif|}} TextLineSegmentRatio ** ** {{wiki:​PublicProperty.gif|}} TextLineSegmentRatio **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
 == Return Value == == Return Value ==
   * Type:Double   * Type:Double
Line 985: Line 852:
 ** {{wiki:​PublicProperty.gif|}} BestPlacement ** ** {{wiki:​PublicProperty.gif|}} BestPlacement **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
 == Return Value == == Return Value ==
   * Type:​Boolean   * Type:​Boolean
Line 993: Line 860:
 ** {{wiki:​PublicProperty.gif|}} PointPlacement ** ** {{wiki:​PublicProperty.gif|}} PointPlacement **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
 == Return Value == == Return Value ==
   * Type:​[[ThinkGeo.MapSuite.Core.PointPlacement|PointPlacement]]   * Type:​[[ThinkGeo.MapSuite.Core.PointPlacement|PointPlacement]]
Line 1001: Line 868:
 ** {{wiki:​PublicProperty.gif|}} MaskType ** ** {{wiki:​PublicProperty.gif|}} MaskType **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
 == Return Value == == Return Value ==
   * Type:​[[ThinkGeo.MapSuite.Core.MaskType|MaskType]]   * Type:​[[ThinkGeo.MapSuite.Core.MaskType|MaskType]]
Line 1009: Line 876:
 ** {{wiki:​PublicProperty.gif|}} Name ** ** {{wiki:​PublicProperty.gif|}} Name **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
 == Return Value == == Return Value ==
   * Type:String   * Type:String
Line 1017: Line 884:
 ** {{wiki:​PublicProperty.gif|}} IsActive ** ** {{wiki:​PublicProperty.gif|}} IsActive **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
 == Return Value == == Return Value ==
   * Type:​Boolean   * Type:​Boolean
Line 1025: Line 892:
 ** {{wiki:​PublicProperty.gif|}} RequiredColumnNames ** ** {{wiki:​PublicProperty.gif|}} RequiredColumnNames **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
 == Return Value == == Return Value ==
   * Type:​Collection<​String>​   * Type:​Collection<​String>​
Line 1033: Line 900:
 ** {{wiki:​PublicProperty.gif|}} Filters ** ** {{wiki:​PublicProperty.gif|}} Filters **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
 == Return Value == == Return Value ==
   * Type:​Collection<​String>​   * Type:​Collection<​String>​
Line 1042: Line 909:
 ** {{wiki:​ProtectedProperty.gif|}} AllowSpline ** ** {{wiki:​ProtectedProperty.gif|}} AllowSpline **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
 == Return Value == == Return Value ==
   * Type:​Boolean   * Type:​Boolean
  
-** {{wiki:​ProtectedProperty.gif|}} ​uBs= **+** {{wiki:​ProtectedProperty.gif|}} ​IsDefault ​**
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
 == Return Value == == Return Value ==
   * Type:​Boolean   * Type:​Boolean
Line 1058: Line 925:
 ** {{wiki:​ProtectedProperty.gif|}} FiltersCore ** ** {{wiki:​ProtectedProperty.gif|}} FiltersCore **
  
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
 == Return Value == == Return Value ==
   * Type:​Collection<​String>​   * Type:​Collection<​String>​
Line 1066: Line 933:
 ==== Public Events ==== ==== Public Events ====
 ** {{wiki:​PublicEvent.gif|}} Formatting ** ** {{wiki:​PublicEvent.gif|}} Formatting **
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
  
 Event Arguments:​[[ThinkGeo.MapSuite.Core.FormattingPositionStyleEventArgs|FormattingPositionStyleEventArgs]] Event Arguments:​[[ThinkGeo.MapSuite.Core.FormattingPositionStyleEventArgs|FormattingPositionStyleEventArgs]]
  
 ** {{wiki:​PublicEvent.gif|}} Formatted ** ** {{wiki:​PublicEvent.gif|}} Formatted **
-N/A+  * //N/A//
 == Remarks == == Remarks ==
-N/A+  * //N/A//
  
 Event Arguments:​[[ThinkGeo.MapSuite.Core.FormattedPositionStyleEventArgs|FormattedPositionStyleEventArgs]] Event Arguments:​[[ThinkGeo.MapSuite.Core.FormattedPositionStyleEventArgs|FormattedPositionStyleEventArgs]]
  
  
thinkgeo.mapsuite.portablecore.textstyle.1442823585.txt.gz · Last modified: 2015/09/21 08:19 by admin