This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
thinkgeo.mapsuite.core.geoserializer [2015/08/20 03:08] 127.0.0.1 external edit |
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}} | ||
- | |||
- | <!-- Class --> | ||
This class serializes an object. | This class serializes an object. | ||
===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
- | *System.Object | + | *System.Object |
- | **[[ThinkGeo.MapSuite.Core.GeoSerializer]] | + | ***ThinkGeo.MapSuite.Core.GeoSerializer** |
===== Members Summary ===== | ===== Members Summary ===== | ||
==== Public Constructors ==== | ==== Public Constructors ==== | ||
- | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} GeoSerializer() ** |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#GeoSerializer()|GeoSerializer]] | | | Creates an instance of GeoSerializer. | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#GeoSerializer(GeoSerializationFormatter)|GeoSerializer]] | [[ThinkGeo.MapSuite.Core.GeoSerializationFormatter|GeoSerializationFormatter]] | | | | + | |
- | ==== Protected Constructors ==== | + | * //Creates an instance of GeoSerializer.// |
- | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
+ | * //N/A// | ||
+ | == Parameters == | ||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} GeoSerializer(GeoSerializationFormatter) ** | ||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | == Parameters == | ||
+ | * //formatter// | ||
+ | * Type:[[ThinkGeo.MapSuite.Core.GeoSerializationFormatter|GeoSerializationFormatter]] | ||
+ | * Description:N/A | ||
+ | |||
+ | <div newline></div> | ||
+ | ==== Protected Constructors ==== | ||
==== Public Methods ==== | ==== Public Methods ==== | ||
- | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} Serialize(Object,String) ** |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#Deserialize(String, FileAccess)|Deserialize]] | String, FileAccess | | Recreates an object from a file. | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#Deserialize(Stream)|Deserialize]] | Stream | | Recreates an object from a stream. | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#Deserialize(String)|Deserialize]] | String | | Recreates an object from a string. | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#Deserialize(Uri)|Deserialize]] | Uri | | Recreates an object from an Url. | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]] | Object | Object | | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object | | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]] | | Object | | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#Serialize(Object, String)|Serialize]] | Object, String | | Serialize an object and save the serialized data to a file. | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#Serialize(Object, Stream)|Serialize]] | Object, Stream | | Serialize an object and save the serialized data to a stream. | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#Serialize(Object)|Serialize]] | Object | | Serialize an object and save the serialized data to a string. | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object | | | + | |
- | ==== Protected Methods ==== | + | * //Serialize an object and save the serialized data to a file.// |
- | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
- | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | + | * //N/A// |
- | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | + | |
- | ==== Public Properties ==== | + | == Return Value == |
- | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | * Type:Void |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#Formatter|Formatter]] | [[ThinkGeo.MapSuite.Core.GeoSerializationFormatter|GeoSerializationFormatter]] | | Gets or sets the Formatter. The Formatter determines what kind of serialized data will be created. | | + | * Description:N/A |
- | ==== Protected Properties ==== | + | == Parameters == |
- | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | * //objectToSerialize// |
+ | * Type:Object | ||
+ | * Description:The object to be serialized. | ||
- | ==== Public Events ==== | + | * //targetPathFileName// |
- | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | + | * Type:String |
+ | * Description:The path to save the serialized data to. | ||
- | ===== Public Constructors ===== | + | <div newline></div> |
- | ==== GeoSerializer() ==== | + | ** {{wiki:PublicMethod.gif|}} Serialize(Object,Stream) ** |
- | Creates an instance of GeoSerializer. | + | |
- | === Parameters === | + | |
- | ^ Name ^ Type ^ Description ^ | + | |
- | [[#Public Constructors|Go Back]] | + | * //Serialize an object and save the serialized data to a stream.// |
- | ==== GeoSerializer(GeoSerializationFormatter) ==== | + | == Remarks == |
- | === Parameters === | + | * //N/A// |
- | ^ Name ^ Type ^ Description ^ | + | |
- | | formatter | [[ThinkGeo.MapSuite.Core.GeoSerializationFormatter|GeoSerializationFormatter]]<!-- ThinkGeo.MapSuite.Core.GeoSerializationFormatter --> | | | + | |
- | [[#Public Constructors|Go Back]] | + | == Return Value == |
- | ===== Protected Constructors ===== | + | * Type:Void |
- | ===== Public Methods ===== | + | * Description:N/A |
- | ==== Deserialize(String, FileAccess) ==== | + | |
- | Recreates an object from a file. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Object<!-- System.Object --> | The recreated object. | | + | |
- | === Parameters === | + | == Parameters == |
- | ^ Name ^ Type ^ Description ^ | + | * //objectToSerialize// |
- | | sourcePathFileName | String<!-- System.String --> | The file path to deserialize from. | | + | * Type:Object |
- | | fileAccess | FileAccess<!-- System.IO.FileAccess --> | The FileAccess | | + | * Description:The object to be serialized. |
- | <!-- ThinkGeo.MapSuite.Core.GeoSerializer --> | + | * //targetStream// |
- | [[#Public Methods|Go Back]] | + | * Type:Stream |
- | ==== Deserialize(Stream) ==== | + | * Description:The stream to save the serialized data into. |
- | Recreates an object from a stream. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Object<!-- System.Object --> | The recreated object. | | + | |
- | === Parameters === | + | <div newline></div> |
- | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} Serialize(Object) ** |
- | | sourceStream | Stream<!-- System.IO.Stream --> | The Stream to deserialize from. | | + | |
- | <!-- ThinkGeo.MapSuite.Core.GeoSerializer --> | + | * //Serialize an object and save the serialized data to a string.// |
- | [[#Public Methods|Go Back]] | + | == Remarks == |
- | ==== Deserialize(String) ==== | + | * //N/A// |
- | Recreates an object from a string. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Object<!-- System.Object --> | The recreated object. | | + | |
- | === Parameters === | + | == Return Value == |
- | ^ Name ^ Type ^ Description ^ | + | * Type:String |
- | | sourceString | String<!-- System.String --> | The string to deserialize from. | | + | * Description:The string that contains the serialized data. |
- | <!-- ThinkGeo.MapSuite.Core.GeoSerializer --> | + | == Parameters == |
- | [[#Public Methods|Go Back]] | + | * //objectToSerialize// |
- | ==== Deserialize(Uri) ==== | + | * Type:Object |
- | Recreates an object from an Url. | + | * Description:The object to be serialized. |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Object<!-- System.Object --> | The recreated object. | | + | |
- | === Parameters === | + | <div newline></div> |
- | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} Deserialize(String,FileAccess) ** |
- | | sourceUri | Uri<!-- System.Uri --> | The Url to deserialize from. | | + | |
- | <!-- ThinkGeo.MapSuite.Core.GeoSerializer --> | + | * //Recreates an object from a file.// |
- | [[#Public Methods|Go Back]] | + | == Remarks == |
- | ==== Equals(Object) ==== | + | * //N/A// |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Boolean<!-- System.Boolean --> | | | + | |
- | === Parameters === | + | == Return Value == |
- | ^ Name ^ Type ^ Description ^ | + | * Type:Object |
- | | obj | Object<!-- System.Object --> | | | + | * Description:The recreated object. |
- | <!-- System.Object --> | + | == Parameters == |
- | [[#Public Methods|Go Back]] | + | * //sourcePathFileName// |
- | ==== GetHashCode() ==== | + | * Type:String |
- | === Return Value === | + | * Description:The file path to deserialize from. |
- | ^ Return Type ^ Description ^ | + | |
- | | Int32<!-- System.Int32 --> | | | + | |
- | === Parameters === | + | * //fileAccess// |
- | ^ Name ^ Type ^ Description ^ | + | * Type:FileAccess |
+ | * Description:The FileAccess | ||
- | <!-- System.Object --> | + | <div newline></div> |
- | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} Deserialize(Stream) ** |
- | ==== GetType() ==== | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Type<!-- System.Type --> | | | + | |
- | === Parameters === | + | * //Recreates an object from a stream.// |
- | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
+ | * //N/A// | ||
- | <!-- System.Object --> | + | == Return Value == |
- | [[#Public Methods|Go Back]] | + | * Type:Object |
- | ==== Serialize(Object, String) ==== | + | * Description:The recreated object. |
- | Serialize an object and save the serialized data to a file. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | == Parameters == |
- | ^ Name ^ Type ^ Description ^ | + | * //sourceStream// |
- | | objectToSerialize | Object<!-- System.Object --> | The object to be serialized. | | + | * Type:Stream |
- | | targetPathFileName | String<!-- System.String --> | The path to save the serialized data to. | | + | * Description:The Stream to deserialize from. |
- | <!-- ThinkGeo.MapSuite.Core.GeoSerializer --> | + | <div newline></div> |
- | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} Deserialize(String) ** |
- | ==== Serialize(Object, Stream) ==== | + | |
- | Serialize an object and save the serialized data to a stream. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | * //Recreates an object from a string.// |
- | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
- | | objectToSerialize | Object<!-- System.Object --> | The object to be serialized. | | + | * //N/A// |
- | | targetStream | Stream<!-- System.IO.Stream --> | The stream to save the serialized data into. | | + | |
- | <!-- ThinkGeo.MapSuite.Core.GeoSerializer --> | + | == Return Value == |
- | [[#Public Methods|Go Back]] | + | * Type:Object |
- | ==== Serialize(Object) ==== | + | * Description:The recreated object. |
- | Serialize an object and save the serialized data to a string. | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | String<!-- System.String --> | The string that contains the serialized data. | | + | |
- | === Parameters === | + | == Parameters == |
- | ^ Name ^ Type ^ Description ^ | + | * //sourceString// |
- | | objectToSerialize | Object<!-- System.Object --> | The object to be serialized. | | + | * Type:String |
+ | * Description:The string to deserialize from. | ||
- | <!-- ThinkGeo.MapSuite.Core.GeoSerializer --> | + | <div newline></div> |
- | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} Deserialize(Uri) ** |
- | ==== ToString() ==== | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | String<!-- System.String --> | | | + | |
- | === Parameters === | + | * //Recreates an object from an Url.// |
- | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
+ | * //N/A// | ||
- | <!-- System.Object --> | + | == Return Value == |
- | [[#Public Methods|Go Back]] | + | * Type:Object |
- | ===== Protected Methods ===== | + | * Description:The recreated object. |
- | ==== Finalize() ==== | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Void<!-- System.Void --> | | | + | |
- | === Parameters === | + | == Parameters == |
- | ^ Name ^ Type ^ Description ^ | + | * //sourceUri// |
+ | * Type:Uri | ||
+ | * Description:The Url to deserialize from. | ||
- | <!-- System.Object --> | + | <div newline></div> |
- | [[#Protected Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} ToString() ** |
- | ==== MemberwiseClone() ==== | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ Description ^ | + | |
- | | Object<!-- System.Object --> | | | + | |
- | === Parameters === | + | * //N/A// |
- | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:String | ||
+ | * Description:N/A | ||
+ | |||
+ | == Parameters == | ||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Boolean | ||
+ | * Description:N/A | ||
+ | |||
+ | == Parameters == | ||
+ | * //obj// | ||
+ | * Type:Object | ||
+ | * Description:N/A | ||
+ | |||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Int32 | ||
+ | * Description:N/A | ||
+ | |||
+ | == Parameters == | ||
+ | <div newline></div> | ||
+ | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Type | ||
+ | * Description:N/A | ||
+ | |||
+ | == Parameters == | ||
+ | <div newline></div> | ||
+ | ==== Protected Methods ==== | ||
+ | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Void | ||
+ | * Description:N/A | ||
+ | |||
+ | == Parameters == | ||
+ | <div newline></div> | ||
+ | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
+ | |||
+ | * //N/A// | ||
+ | == Remarks == | ||
+ | * //N/A// | ||
+ | |||
+ | == Return Value == | ||
+ | * Type:Object | ||
+ | * Description:N/A | ||
+ | |||
+ | == Parameters == | ||
+ | <div newline></div> | ||
+ | ==== Public Properties ==== | ||
+ | ** {{wiki:PublicProperty.gif|}} Formatter ** | ||
- | <!-- System.Object --> | ||
- | [[#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. | ||
- | === Return Value === | + | == Remarks == |
- | ^ Return Type ^ | + | N/A |
- | | [[ThinkGeo.MapSuite.Core.GeoSerializationFormatter|GeoSerializationFormatter]]<!-- ThinkGeo.MapSuite.Core.GeoSerializationFormatter --> | | + | == Return Value == |
+ | * Type:[[ThinkGeo.MapSuite.Core.GeoSerializationFormatter|GeoSerializationFormatter]] | ||
- | <!-- ThinkGeo.MapSuite.Core.GeoSerializer --> | + | ==== Protected Properties ==== |
- | [[#Public Properties|Go Back]] | + | ==== Public Events ==== |
- | ===== Protected Properties ===== | + | |
- | ===== Public Events ===== | + | |
- | __NOTOC__ | + | |
- | [[Category:MapSuiteCore]] | + | |
- | [[Category:ThinkGeo.MapSuite.Core]] | + | |
- | [[Category:UpdateDocumentation]] | + | |