This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
thinkgeo.mapsuite.silverlightcore.feature [2015/09/21 03:20] admin |
thinkgeo.mapsuite.silverlightcore.feature [2017/03/16 21:59] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== ThinkGeo.MapSuite.SilverlightCore.Feature ====== | ====== ThinkGeo.MapSuite.SilverlightCore.Feature ====== | ||
+ | |||
+ | {{section>upgrade_map_suite_to_10.0}} | ||
+ | |||
The class Feature is the basic unit of which a FeatureSource is composed. A FeatureSource can be taken from a collection of Features stored in a ShapeFile, SQL Server 2008, Oracle, etc.A Feature is the basic data unit structure which is comprised of IDs that mark the identification of the Feature, a shape and a collection of data. | The class Feature is the basic unit of which a FeatureSource is composed. A FeatureSource can be taken from a collection of Features stored in a ShapeFile, SQL Server 2008, Oracle, etc.A Feature is the basic data unit structure which is comprised of IDs that mark the identification of the Feature, a shape and a collection of data. | ||
===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
Line 9: | Line 12: | ||
** {{wiki:PublicMethod.gif|}} Feature(BaseShape) ** | ** {{wiki:PublicMethod.gif|}} Feature(BaseShape) ** | ||
- | This method is the constructor for the Feature. | + | * //This method is the constructor for the Feature.// |
== Remarks == | == Remarks == | ||
- | When you create the Feature, specify the ID of the BaseShape you want to use as a basis. | + | * //When you create the Feature, specify the ID of the BaseShape you want to use as a basis.// |
== Parameters == | == Parameters == | ||
* //baseShape// | * //baseShape// | ||
Line 20: | Line 23: | ||
** {{wiki:PublicMethod.gif|}} Feature(Byte[]) ** | ** {{wiki:PublicMethod.gif|}} Feature(Byte[]) ** | ||
- | This method is the constructor for the Feature. | + | * //This method is the constructor for the Feature.// |
== Remarks == | == Remarks == | ||
- | This overload allows you to create a feature using well-known binary. The Id for this Feature will be a random GUID. | + | * //This overload allows you to create a feature using well-known binary. The Id for this Feature will be a random GUID.// |
== Parameters == | == Parameters == | ||
* //wellKnownBinary// | * //wellKnownBinary// | ||
Line 31: | Line 34: | ||
** {{wiki:PublicMethod.gif|}} Feature(Byte[],String) ** | ** {{wiki:PublicMethod.gif|}} Feature(Byte[],String) ** | ||
- | This method is the constructor for the Feature. | + | * //This method is the constructor for the Feature.// |
== Remarks == | == Remarks == | ||
- | This overload allows you to create a feature using well-known binary and specify the Id. | + | * //This overload allows you to create a feature using well-known binary and specify the Id.// |
== Parameters == | == Parameters == | ||
* //wellKnownBinary// | * //wellKnownBinary// | ||
Line 46: | Line 49: | ||
** {{wiki:PublicMethod.gif|}} Feature(String) ** | ** {{wiki:PublicMethod.gif|}} Feature(String) ** | ||
- | This method is the constructor for the Feature. | + | * //This method is the constructor for the Feature.// |
== Remarks == | == Remarks == | ||
- | This overload allows you to create a feature using well-known text. The Id for the Feature will be a random GUID. | + | * //This overload allows you to create a feature using well-known text. The Id for the Feature will be a random GUID.// |
== Parameters == | == Parameters == | ||
* //wellKnownText// | * //wellKnownText// | ||
Line 57: | Line 60: | ||
** {{wiki:PublicMethod.gif|}} Feature(String,String) ** | ** {{wiki:PublicMethod.gif|}} Feature(String,String) ** | ||
- | This method is the constructor for the Feature. | + | * //This method is the constructor for the Feature.// |
== Remarks == | == Remarks == | ||
- | This overload allows you to create the Feature from well-known text and specify the Id. | + | * //This overload allows you to create the Feature from well-known text and specify the Id.// |
== Parameters == | == Parameters == | ||
* //wellKnownText// | * //wellKnownText// | ||
Line 72: | Line 75: | ||
** {{wiki:PublicMethod.gif|}} Feature(BaseShape,IDictionary<String,String>) ** | ** {{wiki:PublicMethod.gif|}} Feature(BaseShape,IDictionary<String,String>) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Parameters == | == Parameters == | ||
* //baseShape// | * //baseShape// | ||
Line 87: | Line 90: | ||
** {{wiki:PublicMethod.gif|}} Feature(String,String,IDictionary<String,String>) ** | ** {{wiki:PublicMethod.gif|}} Feature(String,String,IDictionary<String,String>) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Parameters == | == Parameters == | ||
* //wellKnownText// | * //wellKnownText// | ||
Line 106: | Line 109: | ||
** {{wiki:PublicMethod.gif|}} Feature(String,String,IEnumerable<String>) ** | ** {{wiki:PublicMethod.gif|}} Feature(String,String,IEnumerable<String>) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Parameters == | == Parameters == | ||
* //wellKnownText// | * //wellKnownText// | ||
Line 125: | Line 128: | ||
** {{wiki:PublicMethod.gif|}} Feature(Byte[],String,IEnumerable<String>) ** | ** {{wiki:PublicMethod.gif|}} Feature(Byte[],String,IEnumerable<String>) ** | ||
- | This method is the constructor for the Feature. | + | * //This method is the constructor for the Feature.// |
== Remarks == | == Remarks == | ||
- | This overload allows you to create the Feature from well-known binary and feature ID, as well as specify the column values. | + | * //This overload allows you to create the Feature from well-known binary and feature ID, as well as specify the column values.// |
== Parameters == | == Parameters == | ||
* //wellKnownBinary// | * //wellKnownBinary// | ||
Line 144: | Line 147: | ||
** {{wiki:PublicMethod.gif|}} Feature(Byte[],String,IDictionary<String,String>) ** | ** {{wiki:PublicMethod.gif|}} Feature(Byte[],String,IDictionary<String,String>) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Parameters == | == Parameters == | ||
* //wellKnownBinary// | * //wellKnownBinary// | ||
Line 163: | Line 166: | ||
** {{wiki:PublicMethod.gif|}} Feature(Vertex) ** | ** {{wiki:PublicMethod.gif|}} Feature(Vertex) ** | ||
- | This method is the constructor for the Feature. | + | * //This method is the constructor for the Feature.// |
== Remarks == | == Remarks == | ||
- | You can use this constructor to create a point Feature easily. | + | * //You can use this constructor to create a point Feature easily.// |
== Parameters == | == Parameters == | ||
* //vertex// | * //vertex// | ||
Line 174: | Line 177: | ||
** {{wiki:PublicMethod.gif|}} Feature(Vertex,String) ** | ** {{wiki:PublicMethod.gif|}} Feature(Vertex,String) ** | ||
- | This method is the constructor for the Feature. | + | * //This method is the constructor for the Feature.// |
== Remarks == | == Remarks == | ||
- | You can use this constructor to create a point Feature and specify the Id. | + | * //You can use this constructor to create a point Feature and specify the Id.// |
== Parameters == | == Parameters == | ||
* //vertex// | * //vertex// | ||
Line 189: | Line 192: | ||
** {{wiki:PublicMethod.gif|}} Feature(Vertex,String,IEnumerable<String>) ** | ** {{wiki:PublicMethod.gif|}} Feature(Vertex,String,IEnumerable<String>) ** | ||
- | This method is the constructor for the Feature. | + | * //This method is the constructor for the Feature.// |
== Remarks == | == Remarks == | ||
- | You can use this constructor to create a point Feature and specify the Id as well as the column values. | + | * //You can use this constructor to create a point Feature and specify the Id as well as the column values.// |
== Parameters == | == Parameters == | ||
* //vertex// | * //vertex// | ||
Line 208: | Line 211: | ||
** {{wiki:PublicMethod.gif|}} Feature(Double,Double) ** | ** {{wiki:PublicMethod.gif|}} Feature(Double,Double) ** | ||
- | This method is the constructor for the Feature. | + | * //This method is the constructor for the Feature.// |
== Remarks == | == Remarks == | ||
- | You can use this constructor to create a point Feature based on x and y coordinates. | + | * //You can use this constructor to create a point Feature based on x and y coordinates.// |
== Parameters == | == Parameters == | ||
* //x// | * //x// | ||
Line 223: | Line 226: | ||
** {{wiki:PublicMethod.gif|}} Feature(Double,Double,String) ** | ** {{wiki:PublicMethod.gif|}} Feature(Double,Double,String) ** | ||
- | This method is the constructor for the Feature. | + | * //This method is the constructor for the Feature.// |
== Remarks == | == Remarks == | ||
- | You can use this constructor to create a point Feature based on x and y coordinates and specify the Id. | + | * //You can use this constructor to create a point Feature based on x and y coordinates and specify the Id.// |
== Parameters == | == Parameters == | ||
* //x// | * //x// | ||
Line 242: | Line 245: | ||
** {{wiki:PublicMethod.gif|}} Feature(Double,Double,String,IEnumerable<String>) ** | ** {{wiki:PublicMethod.gif|}} Feature(Double,Double,String,IEnumerable<String>) ** | ||
- | This method is the constructor for the Feature. | + | * //This method is the constructor for the Feature.// |
== Remarks == | == Remarks == | ||
- | You can use this constructor to create a point Feature based on x and y coordinates and specify both the Id and the column values. | + | * //You can use this constructor to create a point Feature based on x and y coordinates and specify both the Id and the column values.// |
== Parameters == | == Parameters == | ||
* //x// | * //x// | ||
Line 267: | Line 270: | ||
** {{wiki:PublicMethod.gif|}} GetWellKnownBinary() ** | ** {{wiki:PublicMethod.gif|}} GetWellKnownBinary() ** | ||
- | This method returns the well-known binary that represents the Feature. | + | * //This method returns the well-known binary that represents the Feature.// |
== Remarks == | == Remarks == | ||
- | This will return a copy of the well-known binary that represents the Feature. | + | * //This will return a copy of the well-known binary that represents the Feature.// |
== Return Value == | == Return Value == | ||
Line 279: | Line 282: | ||
** {{wiki:PublicMethod.gif|}} GetWellKnownType() ** | ** {{wiki:PublicMethod.gif|}} GetWellKnownType() ** | ||
- | This method returns the well known type that represents the Feature. | + | * //This method returns the well known type that represents the Feature.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
Line 291: | Line 294: | ||
** {{wiki:PublicMethod.gif|}} GetShape() ** | ** {{wiki:PublicMethod.gif|}} GetShape() ** | ||
- | This method returns the shape class that represents the Feature. | + | * //This method returns the shape class that represents the Feature.// |
== Remarks == | == Remarks == | ||
- | This method allows you to get a shape class from a Feature. Because the Feature stores the geometry for itself in well-known binary, it may take some time to generate a shape class if the geometry is complex. | + | * //This method allows you to get a shape class from a Feature. Because the Feature stores the geometry for itself in well-known binary, it may take some time to generate a shape class if the geometry is complex.// |
== Return Value == | == Return Value == | ||
Line 303: | Line 306: | ||
** {{wiki:PublicMethod.gif|}} GetWellKnownText() ** | ** {{wiki:PublicMethod.gif|}} GetWellKnownText() ** | ||
- | This method returns the well-known text that represents the Feature. | + | * //This method returns the well-known text that represents the Feature.// |
== Remarks == | == Remarks == | ||
- | This method allows you to get the well-known text from a Feature. Because the Feature stores the geometry for itself in well-known binary, it may take some time to generate the text if the geometry is complex. | + | * //This method allows you to get the well-known text from a Feature. Because the Feature stores the geometry for itself in well-known binary, it may take some time to generate the text if the geometry is complex.// |
== Return Value == | == Return Value == | ||
Line 315: | Line 318: | ||
** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** | ** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** | ||
- | This method returns the bounding box of the Feature. | + | * //This method returns the bounding box of the Feature.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
Line 327: | Line 330: | ||
** {{wiki:PublicMethod.gif|}} CloneDeep(IEnumerable<String>) ** | ** {{wiki:PublicMethod.gif|}} CloneDeep(IEnumerable<String>) ** | ||
- | This method clones the entire structure, creating a totally separate copy. | + | * //This method clones the entire structure, creating a totally separate copy.// |
== Remarks == | == Remarks == | ||
- | This method will return a complete copy of the Feature. As this is a deep clone, there are no shared references between the source and the copy. | + | * //This method will return a complete copy of the Feature. As this is a deep clone, there are no shared references between the source and the copy.// |
== Return Value == | == Return Value == | ||
Line 343: | Line 346: | ||
** {{wiki:PublicMethod.gif|}} CloneDeep(ReturningColumnsType) ** | ** {{wiki:PublicMethod.gif|}} CloneDeep(ReturningColumnsType) ** | ||
- | This method clones the entire structure, creating a totally separate copy. | + | * //This method clones the entire structure, creating a totally separate copy.// |
== Remarks == | == Remarks == | ||
- | This method will return a complete copy of the Feature. As this is a deep clone, there are no shared references between the source and the copy. | + | * //This method will return a complete copy of the Feature. As this is a deep clone, there are no shared references between the source and the copy.// |
== Return Value == | == Return Value == | ||
Line 359: | Line 362: | ||
** {{wiki:PublicMethod.gif|}} IsValid() ** | ** {{wiki:PublicMethod.gif|}} IsValid() ** | ||
- | This method returns the results of some simple validity tests on the Feature. | + | * //This method returns the results of some simple validity tests on the Feature.// |
== Remarks == | == Remarks == | ||
- | This method is used primarily to ensure that a Feature is valid. The reason is, since this is a structure, we cannot control the main constructor that allows you to create a Feature in an invalid state -- that state being one with no well-known binary at its core. If you use the constructure set provided, then the state should always be valid. This is a property you may want to check before you work with a Feature. | + | * //This method is used primarily to ensure that a Feature is valid. The reason is, since this is a structure, we cannot control the main constructor that allows you to create a Feature in an invalid state -- that state being one with no well-known binary at its core. If you use the constructure set provided, then the state should always be valid. This is a property you may want to check before you work with a Feature.// |
== Return Value == | == Return Value == | ||
Line 371: | Line 374: | ||
** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
- | This method compares two InternalFeatures to see if they are equal. | + | * //This method compares two InternalFeatures to see if they are equal.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
Line 387: | Line 390: | ||
** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
- | This method returns a semi-unique hash code for the Feature. | + | * //This method returns a semi-unique hash code for the Feature.// |
== Remarks == | == Remarks == | ||
- | None | + | * //None// |
== Return Value == | == Return Value == | ||
Line 399: | Line 402: | ||
** {{wiki:PublicMethod.gif|}} ToString() ** | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 411: | Line 414: | ||
** {{wiki:PublicMethod.gif|}} GetType() ** | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 424: | Line 427: | ||
** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 436: | Line 439: | ||
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == |