thinkgeo.mapsuite.portablecore.shapevalidationresult
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.portablecore.shapevalidationresult [2015/08/20 03:08] 127.0.0.1 external edit |
thinkgeo.mapsuite.portablecore.shapevalidationresult [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.PortableCore.ShapeValidationResult ====== | + | ====== ThinkGeo.MapSuite.Core.ShapeValidationResult ====== |
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| - | |||
| - | <!-- Structure --> | ||
| 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. | ||
| - | === Remarks === | ||
| - | This is used to determine if an validation rule was broken for a shape. This structure also returns the description of the violation. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| - | *System.ValueType | + | *System.Object |
| - | **[[ThinkGeo.MapSuite.PortableCore.ShapeValidationResult]] | + | *System.ValueType |
| + | ***ThinkGeo.MapSuite.Core.ShapeValidationResult** | ||
| ===== Members Summary ===== | ===== Members Summary ===== | ||
| ==== Public Constructors ==== | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} ShapeValidationResult(Boolean,String) ** |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ShapeValidationResult(Boolean, String)|ShapeValidationResult]] | Boolean, String | | This constructor allows you to set the IsValid and ValidationErrors properties. | | + | |
| - | ==== Protected Constructors ==== | + | * //This constructor allows you to set the IsValid and ValidationErrors properties.// |
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| + | * //None// | ||
| + | == Parameters == | ||
| + | * //isValid// | ||
| + | * Type:Boolean | ||
| + | * Description:This parameter describes whether the object has passed its validation method. | ||
| + | * //validationErrors// | ||
| + | * Type:String | ||
| + | * Description:This parameter describes the list of errors if the object did not pass its validation method. The errors are separated by semicolons. | ||
| + | |||
| + | <div newline></div> | ||
| + | ==== Protected Constructors ==== | ||
| ==== Public Methods ==== | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]] | Object | Object(overriden) | This method is an override of the Equals functionality. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object(overriden) | This method is an override of the GetHashCode functionality. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]] | | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object(overriden) | | | + | |
| - | ==== Protected Methods ==== | + | * //This method is an override of the Equals functionality.// |
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | + | * //None// |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | + | |
| - | ==== Public Properties ==== | + | == Return Value == |
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | * Type:Boolean |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#IsValid|IsValid]] | Boolean | | This property describes whether the object has passed its validation method. | | + | * Description:N/A |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#ValidationErrors|ValidationErrors]] | String | | This property describes the list of errors if the object did not pass its validation method. | | + | |
| - | ==== Protected Properties ==== | + | == Parameters == |
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | * //obj// |
| + | * Type:Object | ||
| + | * Description:N/A | ||
| - | ==== Public Events ==== | + | <div newline></div> |
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** |
| - | ===== Public Constructors ===== | + | * //This method is an override of the GetHashCode functionality.// |
| - | ==== ShapeValidationResult(Boolean, String) ==== | + | == Remarks == |
| - | This constructor allows you to set the IsValid and ValidationErrors properties. | + | * //None// |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | isValid | Boolean<!-- System.Boolean --> | This parameter describes whether the object has passed its validation method. | | + | |
| - | | validationErrors | String<!-- System.String --> | This parameter describes the list of errors if the object did not pass its validation method. The errors are separated by semicolons. | | + | |
| - | [[#Public Constructors|Go Back]] | + | == Return Value == |
| - | ===== Protected Constructors ===== | + | * Type:Int32 |
| - | ===== Public Methods ===== | + | * Description:N/A |
| - | ==== Equals(Object) ==== | + | |
| - | This method is an override of the Equals functionality. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
| - | | obj | Object<!-- System.Object --> | | | + | ** {{wiki:PublicMethod.gif|}} ToString() ** |
| - | <!-- System.Object(overriden) --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== GetHashCode() ==== | + | * //N/A// |
| - | This method is an override of the GetHashCode functionality. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Int32<!-- System.Int32 --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:String |
| + | * Description:N/A | ||
| - | <!-- System.Object(overriden) --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | ==== GetType() ==== | + | ** {{wiki:PublicMethod.gif|}} GetType() ** |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Type<!-- System.Type --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| + | * //N/A// | ||
| - | <!-- System.Object --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Type |
| - | ==== ToString() ==== | + | * Description:N/A |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | String<!-- System.String --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
| + | ==== Protected Methods ==== | ||
| + | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| - | <!-- System.Object(overriden) --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ===== Protected Methods ===== | + | * //N/A// |
| - | ==== Finalize() ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Void |
| + | * Description:N/A | ||
| - | <!-- System.Object --> | + | == Parameters == |
| - | [[#Protected Methods|Go Back]] | + | <div newline></div> |
| - | ==== MemberwiseClone() ==== | + | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Object<!-- System.Object --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| + | * //N/A// | ||
| - | <!-- System.Object --> | + | == Return Value == |
| - | [[#Protected Methods|Go Back]] | + | * Type:Object |
| - | ===== Public Properties ===== | + | * Description:N/A |
| - | ==== IsValid ==== | + | |
| - | This property describes whether the object has passed its validation method. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.ShapeValidationResult --> | + | == Parameters == |
| - | [[#Public Properties|Go Back]] | + | <div newline></div> |
| - | ==== ValidationErrors ==== | + | ==== Public Properties ==== |
| - | This property describes the list of errors if the object did not pass its validation method. | + | ** {{wiki:PublicProperty.gif|}} IsValid ** |
| - | === Remarks === | + | |
| - | 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 Type ^ | + | |
| - | | String<!-- System.String --> | | + | |
| - | <!-- ThinkGeo.MapSuite.PortableCore.ShapeValidationResult --> | + | * //This property describes whether the object has passed its validation method.// |
| - | [[#Public Properties|Go Back]] | + | == Remarks == |
| - | ===== Protected Properties ===== | + | * //None// |
| - | ===== Public Events ===== | + | == Return Value == |
| - | __NOTOC__ | + | * Type:Boolean |
| - | [[Category:MapSuitePortableCore]] | + | |
| - | [[Category:ThinkGeo.MapSuite.PortableCore]] | + | ** {{wiki:PublicProperty.gif|}} ValidationErrors ** |
| - | [[Category:UpdateDocumentation]] | + | |
| + | * //This property describes the list of errors if the object did not pass its validation method.// | ||
| + | == Remarks == | ||
| + | * //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 == | ||
| + | * Type:String | ||
| + | |||
| + | ==== Protected Properties ==== | ||
| + | ==== Public Events ==== | ||
thinkgeo.mapsuite.portablecore.shapevalidationresult.1440040133.txt.gz · Last modified: 2015/09/21 08:18 (external edit)