This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
thinkgeo.mapsuite.core.shapevalidationresult [2015/09/17 10:39] admin |
thinkgeo.mapsuite.core.shapevalidationresult [2017/03/16 21:59] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== ThinkGeo.MapSuite.Core.ShapeValidationResult ====== | ====== ThinkGeo.MapSuite.Core.ShapeValidationResult ====== | ||
+ | |||
+ | {{section>upgrade_map_suite_to_10.0}} | ||
+ | |||
This structure represents the result of the validation method performed on a shape. | This structure represents the result of the validation method performed on a shape. | ||
===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
Line 6: | Line 9: | ||
***ThinkGeo.MapSuite.Core.ShapeValidationResult** | ***ThinkGeo.MapSuite.Core.ShapeValidationResult** | ||
===== Members Summary ===== | ===== Members Summary ===== | ||
- | === Public Constructors === | + | ==== Public Constructors ==== |
- | <div class_table> | + | ** {{wiki:PublicMethod.gif|}} ShapeValidationResult(Boolean,String) ** |
- | **{{wiki:PublicMethod.gif|}}[[#ShapeValidationResult(Boolean,String)|ShapeValidationResult]]** | + | |
- | * **Parameters**:Boolean,String | + | |
- | * **DeclaringType**:N/A | + | |
- | * **Summary**:This constructor allows you to set the IsValid and ValidationErrors properties. | + | |
- | </div> | + | |
- | === Protected Constructors === | + | * //This constructor allows you to set the IsValid and ValidationErrors properties.// |
- | === Public Methods === | + | == Remarks == |
- | <div class_table> | + | * //None// |
- | **{{wiki:PublicMethod.gif|}}[[#Equals(Object)|Equals]]** | + | == Parameters == |
- | * **Parameters**:Object | + | * //isValid// |
- | * **DeclaringType**:N/A | + | * Type:Boolean |
- | * **Summary**:This method is an override of the Equals functionality. | + | * Description:This parameter describes whether the object has passed its validation method. |
- | </div> | + | |
- | <div class_table> | + | * //validationErrors// |
- | **{{wiki:PublicMethod.gif|}}[[#GetHashCode()|GetHashCode]]** | + | * Type:String |
- | * **Parameters**:N/A | + | * Description:This parameter describes the list of errors if the object did not pass its validation method. The errors are separated by semicolons. |
- | * **DeclaringType**:N/A | + | |
- | * **Summary**:This method is an override of the GetHashCode functionality. | + | |
- | </div> | + | |
- | <div class_table> | + | <div newline></div> |
- | **{{wiki:PublicMethod.gif|}}[[#GetType()|GetType]]** | + | ==== Protected Constructors ==== |
- | * **Parameters**:N/A | + | ==== Public Methods ==== |
- | * **DeclaringType**:Object | + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | <div class_table> | + | * //This method is an override of the Equals functionality.// |
- | **{{wiki:PublicMethod.gif|}}[[#ToString()|ToString]]** | + | == Remarks == |
- | * **Parameters**:N/A | + | * //None// |
- | * **DeclaringType**:ValueType | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | === Protected Methods === | + | == Return Value == |
- | <div class_table> | + | * Type:Boolean |
- | **{{wiki:ProtectedMethod.gif|}}[[#Finalize()|Finalize]]** | + | * Description:N/A |
- | * **Parameters**:N/A | + | |
- | * **DeclaringType**:Object | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | <div class_table> | + | == Parameters == |
- | **{{wiki:ProtectedMethod.gif|}}[[#MemberwiseClone()|MemberwiseClone]]** | + | * //obj// |
- | * **Parameters**:N/A | + | * Type:Object |
- | * **DeclaringType**:Object | + | * Description:N/A |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | === Public Properties === | + | <div newline></div> |
- | **{{wiki:PublicProperty.gif|}}[[#IsValid|IsValid]]** | + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** |
- | * **Return**:Boolean | + | |
- | * **Summary**:This property describes whether the object has passed its validation method. | + | |
- | **{{wiki:PublicProperty.gif|}}[[#ValidationErrors|ValidationErrors]]** | + | * //This method is an override of the GetHashCode functionality.// |
- | * **Return**:String | + | == Remarks == |
- | * **Summary**:This property describes the list of errors if the object did not pass its validation method. | + | * //None// |
- | === Protected Properties === | + | == Return Value == |
- | === Public Events === | + | * Type:Int32 |
- | ===== Public Constructors ===== | + | * Description:N/A |
- | === ShapeValidationResult(Boolean,String) === | + | |
- | This constructor allows you to set the IsValid and ValidationErrors properties. | + | |
- | ==== Remarks ==== | + | |
- | None | + | |
- | ==== Parameters ==== | + | |
- | **isValid** | + | |
- | * **Type**:Boolean | + | |
- | * **Description:This parameter describes whether the object has passed its validation method. | + | |
- | **validationErrors** | + | == Parameters == |
- | * **Type**:String | + | <div newline></div> |
- | * **Description:This parameter describes the list of errors if the object did not pass its validation method. The errors are separated by semicolons. | + | ** {{wiki:PublicMethod.gif|}} ToString() ** |
- | [[#Public Constructors|Go Back]] | + | * //N/A// |
- | ===== Protected Constructors ===== | + | == Remarks == |
- | ===== Public Methods ===== | + | * //N/A// |
- | === Equals(Object) === | + | |
- | This method is an override of the Equals functionality. | + | |
- | ==== Remarks ==== | + | |
- | None | + | |
- | **Return Value** | + | == Return Value == |
- | * **Return Type**:Boolean | + | * Type:String |
- | * **Description**:N/A | + | * Description:N/A |
- | ==== Parameters ==== | + | == Parameters == |
- | **obj** | + | <div newline></div> |
- | * **Type**:Object | + | ** {{wiki:PublicMethod.gif|}} GetType() ** |
- | * **Description**:N/A | + | |
- | [[#Public Methods|Go Back]] | + | * //N/A// |
- | === GetHashCode() === | + | == Remarks == |
- | This method is an override of the GetHashCode functionality. | + | * //N/A// |
- | ==== Remarks ==== | + | |
- | None | + | |
- | **Return Value** | + | == Return Value == |
- | * **Return Type**:Int32 | + | * Type:Type |
- | * **Description**:N/A | + | * Description:N/A |
- | ==== Parameters ==== | + | == Parameters == |
- | [[#Public Methods|Go Back]] | + | <div newline></div> |
- | === GetType() === | + | ==== Protected Methods ==== |
- | N/A | + | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | * //N/A// |
- | * **Return Type**:Type | + | == Remarks == |
- | * **Description**:N/A | + | * //N/A// |
- | ==== Parameters ==== | + | == Return Value == |
- | [[#Public Methods|Go Back]] | + | * Type:Void |
- | === ToString() === | + | * Description:N/A |
- | N/A | + | |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | == Parameters == |
- | * **Return Type**:String | + | <div newline></div> |
- | * **Description**:N/A | + | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** |
- | ==== Parameters ==== | + | * //N/A// |
- | [[#Public Methods|Go Back]] | + | == Remarks == |
- | ===== Protected Methods ===== | + | * //N/A// |
- | === Finalize() === | + | |
- | N/A | + | |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | == Return Value == |
- | * **Return Type**:Void | + | * Type:Object |
- | * **Description**:N/A | + | * Description:N/A |
- | ==== Parameters ==== | + | == Parameters == |
- | [[#Protected Methods|Go Back]] | + | <div newline></div> |
- | === MemberwiseClone() === | + | ==== Public Properties ==== |
- | N/A | + | ** {{wiki:PublicProperty.gif|}} IsValid ** |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | ||
- | * **Return Type**:Object | ||
- | * **Description**:N/A | ||
- | |||
- | ==== Parameters ==== | ||
- | [[#Protected Methods|Go Back]] | ||
- | ===== Public Properties ===== | ||
- | === IsValid === | ||
This property describes whether the object has passed its validation method. | This property describes whether the object has passed its validation method. | ||
- | ==== Remarks ==== | + | == Remarks == |
None | None | ||
- | ==== Return Value ==== | + | == Return Value == |
- | **Return Type**:Boolean | + | * Type:Boolean |
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} ValidationErrors ** | ||
- | [[#Public Properties|Go Back]] | ||
- | === ValidationErrors === | ||
This property describes the list of errors if the object did not pass its validation method. | This property describes the list of errors if the object did not pass its validation method. | ||
- | ==== Remarks ==== | + | == Remarks == |
If there are multiple errors, they will be separated by semicolons. If the object passed its validations, then this string will be empty. | If there are multiple errors, they will be separated by semicolons. If the object passed its validations, then this string will be empty. | ||
- | ==== Return Value ==== | + | == Return Value == |
- | **Return Type**:String | + | * Type:String |
- | [[#Public Properties|Go Back]] | + | ==== Protected Properties ==== |
- | ===== Protected Properties ===== | + | ==== Public Events ==== |
- | ===== Public Events ===== | + | |