This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
thinkgeo.mapsuite.core.geoserializer [2015/09/17 10:30] admin |
thinkgeo.mapsuite.core.geoserializer [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.Core.GeoSerializer ====== | ====== ThinkGeo.MapSuite.Core.GeoSerializer ====== | ||
| + | |||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| + | |||
| This class serializes an object. | This class serializes an object. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| Line 5: | Line 8: | ||
| ***ThinkGeo.MapSuite.Core.GeoSerializer** | ***ThinkGeo.MapSuite.Core.GeoSerializer** | ||
| ===== Members Summary ===== | ===== Members Summary ===== | ||
| - | === Public Constructors === | + | ==== Public Constructors ==== |
| - | <div class_table> | + | ** {{wiki:PublicMethod.gif|}} GeoSerializer() ** |
| - | **{{wiki:PublicMethod.gif|}}[[#GeoSerializer()|GeoSerializer]]** | + | |
| - | * **Parameters**:N/A | + | |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:Creates an instance of GeoSerializer. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //Creates an instance of GeoSerializer.// |
| - | **{{wiki:PublicMethod.gif|}}[[#GeoSerializer(GeoSerializationFormatter)|GeoSerializer]]** | + | == Remarks == |
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.GeoSerializationFormatter|GeoSerializationFormatter]] | + | * //N/A// |
| - | * **DeclaringType**:N/A | + | == Parameters == |
| - | * **Summary**:N/A | + | <div newline></div> |
| - | </div> | + | ** {{wiki:PublicMethod.gif|}} GeoSerializer(GeoSerializationFormatter) ** |
| - | === Protected Constructors === | + | * //N/A// |
| - | === Public Methods === | + | == Remarks == |
| - | <div class_table> | + | * //N/A// |
| - | **{{wiki:PublicMethod.gif|}}[[#Deserialize(String,FileAccess)|Deserialize]]** | + | == Parameters == |
| - | * **Parameters**:String,FileAccess | + | * //formatter// |
| - | * **DeclaringType**:N/A | + | * Type:[[ThinkGeo.MapSuite.Core.GeoSerializationFormatter|GeoSerializationFormatter]] |
| - | * **Summary**:Recreates an object from a file. | + | * Description:N/A |
| - | </div> | + | |
| - | <div class_table> | + | <div newline></div> |
| - | **{{wiki:PublicMethod.gif|}}[[#Deserialize(Stream)|Deserialize]]** | + | ==== Protected Constructors ==== |
| - | * **Parameters**:Stream | + | ==== Public Methods ==== |
| - | * **DeclaringType**:N/A | + | ** {{wiki:PublicMethod.gif|}} Serialize(Object,String) ** |
| - | * **Summary**:Recreates an object from a stream. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //Serialize an object and save the serialized data to a file.// |
| - | **{{wiki:PublicMethod.gif|}}[[#Deserialize(String)|Deserialize]]** | + | == Remarks == |
| - | * **Parameters**:String | + | * //N/A// |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:Recreates an object from a string. | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Return Value == |
| - | **{{wiki:PublicMethod.gif|}}[[#Deserialize(Uri)|Deserialize]]** | + | * Type:Void |
| - | * **Parameters**:Uri | + | * Description:N/A |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:Recreates an object from an Url. | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Parameters == |
| - | **{{wiki:PublicMethod.gif|}}[[#Equals(Object)|Equals]]** | + | * //objectToSerialize// |
| - | * **Parameters**:Object | + | * Type:Object |
| - | * **DeclaringType**:Object | + | * Description:The object to be serialized. |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //targetPathFileName// |
| - | **{{wiki:PublicMethod.gif|}}[[#GetHashCode()|GetHashCode]]** | + | * Type:String |
| - | * **Parameters**:N/A | + | * Description:The path to save the serialized data to. |
| - | * **DeclaringType**:Object | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | <div newline></div> |
| - | **{{wiki:PublicMethod.gif|}}[[#GetType()|GetType]]** | + | ** {{wiki:PublicMethod.gif|}} Serialize(Object,Stream) ** |
| - | * **Parameters**:N/A | + | |
| - | * **DeclaringType**:Object | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //Serialize an object and save the serialized data to a stream.// |
| - | **{{wiki:PublicMethod.gif|}}[[#Serialize(Object,String)|Serialize]]** | + | == Remarks == |
| - | * **Parameters**:Object,String | + | * //N/A// |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:Serialize an object and save the serialized data to a file. | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Return Value == |
| - | **{{wiki:PublicMethod.gif|}}[[#Serialize(Object,Stream)|Serialize]]** | + | * Type:Void |
| - | * **Parameters**:Object,Stream | + | * Description:N/A |
| - | * **DeclaringType**:N/A | + | |
| - | * **Summary**:Serialize an object and save the serialized data to a stream. | + | |
| - | </div> | + | |
| - | <div class_table> | + | == Parameters == |
| - | **{{wiki:PublicMethod.gif|}}[[#Serialize(Object)|Serialize]]** | + | * //objectToSerialize// |
| - | * **Parameters**:Object | + | * Type:Object |
| - | * **DeclaringType**:N/A | + | * Description:The object to be serialized. |
| - | * **Summary**:Serialize an object and save the serialized data to a string. | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //targetStream// |
| - | **{{wiki:PublicMethod.gif|}}[[#ToString()|ToString]]** | + | * Type:Stream |
| - | * **Parameters**:N/A | + | * Description:The stream to save the serialized data into. |
| - | * **DeclaringType**:Object | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | === Protected Methods === | + | <div newline></div> |
| - | <div class_table> | + | ** {{wiki:PublicMethod.gif|}} Serialize(Object) ** |
| - | **{{wiki:ProtectedMethod.gif|}}[[#Finalize()|Finalize]]** | + | |
| - | * **Parameters**:N/A | + | |
| - | * **DeclaringType**:Object | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | <div class_table> | + | * //Serialize an object and save the serialized data to a string.// |
| - | **{{wiki:ProtectedMethod.gif|}}[[#MemberwiseClone()|MemberwiseClone]]** | + | == Remarks == |
| - | * **Parameters**:N/A | + | * //N/A// |
| - | * **DeclaringType**:Object | + | |
| - | * **Summary**:N/A | + | |
| - | </div> | + | |
| - | === Public Properties === | + | == Return Value == |
| - | **{{wiki:PublicProperty.gif|}}[[#Formatter|Formatter]]** | + | * Type:String |
| - | * **Return**:[[ThinkGeo.MapSuite.Core.GeoSerializationFormatter|GeoSerializationFormatter]] | + | * Description:The string that contains the serialized data. |
| - | * **Summary**:Gets or sets the Formatter. The Formatter determines what kind of serialized data will be created. | + | |
| - | === Protected Properties === | + | == Parameters == |
| - | === Public Events === | + | * //objectToSerialize// |
| - | ===== Public Constructors ===== | + | * Type:Object |
| - | === GeoSerializer() === | + | * Description:The object to be serialized. |
| - | Creates an instance of GeoSerializer. | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | ==== Parameters ==== | + | |
| - | [[#Public Constructors|Go Back]] | + | |
| - | === GeoSerializer(GeoSerializationFormatter) === | + | |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | ==== Parameters ==== | + | |
| - | **formatter** | + | |
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeoSerializationFormatter|GeoSerializationFormatter]] | + | |
| - | * **Description:N/A | + | |
| - | [[#Public Constructors|Go Back]] | + | <div newline></div> |
| - | ===== Protected Constructors ===== | + | ** {{wiki:PublicMethod.gif|}} Deserialize(String,FileAccess) ** |
| - | ===== Public Methods ===== | + | |
| - | === Deserialize(String,FileAccess) === | + | |
| - | Recreates an object from a file. | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //Recreates an object from a file.// |
| - | * **Return Type**:Object | + | == Remarks == |
| - | * **Description**:The recreated object. | + | * //N/A// |
| - | ==== Parameters ==== | + | == Return Value == |
| - | **sourcePathFileName** | + | * Type:Object |
| - | * **Type**:String | + | * Description:The recreated object. |
| - | * **Description**:The file path to deserialize from. | + | |
| - | **fileAccess** | + | == Parameters == |
| - | * **Type**:FileAccess | + | * //sourcePathFileName// |
| - | * **Description**:The FileAccess | + | * Type:String |
| + | * Description:The file path to deserialize from. | ||
| - | [[#Public Methods|Go Back]] | + | * //fileAccess// |
| - | === Deserialize(Stream) === | + | * Type:FileAccess |
| - | Recreates an object from a stream. | + | * Description:The FileAccess |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | <div newline></div> |
| - | * **Return Type**:Object | + | ** {{wiki:PublicMethod.gif|}} Deserialize(Stream) ** |
| - | * **Description**:The recreated object. | + | |
| - | ==== Parameters ==== | + | * //Recreates an object from a stream.// |
| - | **sourceStream** | + | == Remarks == |
| - | * **Type**:Stream | + | * //N/A// |
| - | * **Description**:The Stream to deserialize from. | + | |
| - | [[#Public Methods|Go Back]] | + | == Return Value == |
| - | === Deserialize(String) === | + | * Type:Object |
| - | Recreates an object from a string. | + | * Description:The recreated object. |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Parameters == |
| - | * **Return Type**:Object | + | * //sourceStream// |
| - | * **Description**:The recreated object. | + | * Type:Stream |
| + | * Description:The Stream to deserialize from. | ||
| - | ==== Parameters ==== | + | <div newline></div> |
| - | **sourceString** | + | ** {{wiki:PublicMethod.gif|}} Deserialize(String) ** |
| - | * **Type**:String | + | |
| - | * **Description**:The string to deserialize from. | + | |
| - | [[#Public Methods|Go Back]] | + | * //Recreates an object from a string.// |
| - | === Deserialize(Uri) === | + | == Remarks == |
| - | Recreates an object from an Url. | + | * //N/A// |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:Object | + | * Type:Object |
| - | * **Description**:The recreated object. | + | * Description:The recreated object. |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **sourceUri** | + | * //sourceString// |
| - | * **Type**:Uri | + | * Type:String |
| - | * **Description**:The Url to deserialize from. | + | * Description:The string to deserialize from. |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | === Equals(Object) === | + | ** {{wiki:PublicMethod.gif|}} Deserialize(Uri) ** |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //Recreates an object from an Url.// |
| - | * **Return Type**:Boolean | + | == Remarks == |
| - | * **Description**:N/A | + | * //N/A// |
| - | ==== Parameters ==== | + | == Return Value == |
| - | **obj** | + | * Type:Object |
| - | * **Type**:Object | + | * Description:The recreated object. |
| - | * **Description**:N/A | + | |
| - | [[#Public Methods|Go Back]] | + | == Parameters == |
| - | === GetHashCode() === | + | * //sourceUri// |
| - | N/A | + | * Type:Uri |
| - | ==== Remarks ==== | + | * Description:The Url to deserialize from. |
| - | N/A | + | |
| - | **Return Value** | + | <div newline></div> |
| - | * **Return Type**:Int32 | + | ** {{wiki:PublicMethod.gif|}} ToString() ** |
| - | * **Description**:N/A | + | |
| - | ==== Parameters ==== | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | === GetType() === | + | * //N/A// |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:Type | + | * Type:String |
| - | * **Description**:N/A | + | * Description:N/A |
| - | ==== Parameters ==== | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | === Serialize(Object,String) === | + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** |
| - | Serialize an object and save the serialized data to a file. | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //N/A// |
| - | * **Return Type**:Void | + | == Remarks == |
| - | * **Description**:N/A | + | * //N/A// |
| - | ==== Parameters ==== | + | == Return Value == |
| - | **objectToSerialize** | + | * Type:Boolean |
| - | * **Type**:Object | + | * Description:N/A |
| - | * **Description**:The object to be serialized. | + | |
| - | **targetPathFileName** | + | == Parameters == |
| - | * **Type**:String | + | * //obj// |
| - | * **Description**:The path to save the serialized data to. | + | * Type:Object |
| + | * Description:N/A | ||
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | === Serialize(Object,Stream) === | + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** |
| - | Serialize an object and save the serialized data to a stream. | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //N/A// |
| - | * **Return Type**:Void | + | == Remarks == |
| - | * **Description**:N/A | + | * //N/A// |
| - | ==== Parameters ==== | + | == Return Value == |
| - | **objectToSerialize** | + | * Type:Int32 |
| - | * **Type**:Object | + | * Description:N/A |
| - | * **Description**:The object to be serialized. | + | |
| - | **targetStream** | + | == Parameters == |
| - | * **Type**:Stream | + | <div newline></div> |
| - | * **Description**:The stream to save the serialized data into. | + | ** {{wiki:PublicMethod.gif|}} GetType() ** |
| - | [[#Public Methods|Go Back]] | + | * //N/A// |
| - | === Serialize(Object) === | + | == Remarks == |
| - | Serialize an object and save the serialized data to a string. | + | * //N/A// |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:String | + | * Type:Type |
| - | * **Description**:The string that contains the serialized data. | + | * Description:N/A |
| - | ==== Parameters ==== | + | == Parameters == |
| - | **objectToSerialize** | + | <div newline></div> |
| - | * **Type**:Object | + | ==== Protected Methods ==== |
| - | * **Description**:The object to be serialized. | + | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** |
| - | [[#Public Methods|Go Back]] | + | * //N/A// |
| - | === ToString() === | + | == Remarks == |
| - | N/A | + | * //N/A// |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Return Value == |
| - | * **Return Type**:String | + | * Type:Void |
| - | * **Description**:N/A | + | * Description:N/A |
| - | ==== Parameters ==== | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | ===== Protected Methods ===== | + | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** |
| - | === Finalize() === | + | |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | * //N/A// |
| - | * **Return Type**:Void | + | == Remarks == |
| - | * **Description**:N/A | + | * //N/A// |
| - | ==== Parameters ==== | + | == Return Value == |
| - | [[#Protected Methods|Go Back]] | + | * Type:Object |
| - | === MemberwiseClone() === | + | * Description:N/A |
| - | N/A | + | |
| - | ==== Remarks ==== | + | |
| - | N/A | + | |
| - | **Return Value** | + | == Parameters == |
| - | * **Return Type**:Object | + | <div newline></div> |
| - | * **Description**:N/A | + | ==== Public Properties ==== |
| + | ** {{wiki:PublicProperty.gif|}} Formatter ** | ||
| - | ==== Parameters ==== | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ===== Public Properties ===== | ||
| - | === Formatter === | ||
| Gets or sets the Formatter. The Formatter determines what kind of serialized data will be created. | Gets or sets the Formatter. The Formatter determines what kind of serialized data will be created. | ||
| - | ==== Remarks ==== | + | == Remarks == |
| N/A | N/A | ||
| - | ==== Return Value ==== | + | == Return Value == |
| - | **Return Type**:[[ThinkGeo.MapSuite.Core.GeoSerializationFormatter|GeoSerializationFormatter]] | + | * Type:[[ThinkGeo.MapSuite.Core.GeoSerializationFormatter|GeoSerializationFormatter]] |
| - | [[#Public Properties|Go Back]] | + | ==== Protected Properties ==== |
| - | ===== Protected Properties ===== | + | ==== Public Events ==== |
| - | ===== Public Events ===== | + | |