This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.core.geoserializationformatter [2015/08/20 03:08] 127.0.0.1 external edit |
thinkgeo.mapsuite.core.geoserializationformatter [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.Core.GeoSerializationFormatter ====== | ====== ThinkGeo.MapSuite.Core.GeoSerializationFormatter ====== | ||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| - | |||
| - | <!-- Class --> | ||
| This class formats a GeoObjectModel into serialized data. | This class formats a GeoObjectModel into serialized data. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | + | *System.Object |
| - | **[[ThinkGeo.MapSuite.Core.GeoSerializationFormatter]] | + | ***ThinkGeo.MapSuite.Core.GeoSerializationFormatter** |
| - | ***[[ThinkGeo.MapSuite.Core.XmlGeoSerializationFormatter]] | + | *[[ThinkGeo.MapSuite.Core.XmlGeoSerializationFormatter]] |
| ===== Members Summary ===== | ===== Members Summary ===== | ||
| ==== Public Constructors ==== | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | |||
| ==== Protected Constructors ==== | ==== Protected Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:ProtectedMethod.gif|}} GeoSerializationFormatter() ** |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GeoSerializationFormatter()|GeoSerializationFormatter]] | | | Creates an instance of GeoSerializationFormatter. | | + | |
| + | * //Creates an instance of GeoSerializationFormatter.// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| ==== Public Methods ==== | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} Save(GeoObjectModel,Stream) ** |
| - | | {{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}}[[#Load(Stream)|Load]] | Stream | | Load a stream into a GeoObjectModel. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Save(GeoObjectModel, Stream)|Save]] | [[ThinkGeo.MapSuite.Core.GeoObjectModel|GeoObjectModel]], Stream | | Save serialized data into a stream. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object | | | + | |
| - | ==== Protected Methods ==== | + | * //Save serialized data into a stream.// |
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | + | * //N/A// |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#LoadCore(Stream)|LoadCore]] | Stream | | Load a stream into a GeoObjectModel. | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#SaveCore(GeoObjectModel, Stream)|SaveCore]] | [[ThinkGeo.MapSuite.Core.GeoObjectModel|GeoObjectModel]], Stream | | Format a GeoObjectModel into serialized data, and save the data into a stream. | | + | |
| - | ==== Public Properties ==== | + | == Return Value == |
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | * Type:Void |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Encoding|Encoding]] | Encoding | | set or get the readEncoding. | | + | * Description:N/A |
| - | ==== Protected Properties ==== | + | == Parameters == |
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | * //model// |
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoObjectModel|GeoObjectModel]] | ||
| + | * Description:The GeoObjectModel to create serialized data for. | ||
| - | ==== Public Events ==== | + | * //stream// |
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | + | * Type:Stream |
| + | * Description:The Stream to save serialized data into. | ||
| - | ===== Public Constructors ===== | + | <div newline></div> |
| - | ===== Protected Constructors ===== | + | ** {{wiki:PublicMethod.gif|}} Load(Stream) ** |
| - | ==== GeoSerializationFormatter() ==== | + | |
| - | Creates an instance of GeoSerializationFormatter. | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | [[#Protected Constructors|Go Back]] | + | * //Load a stream into a GeoObjectModel.// |
| - | ===== Public Methods ===== | + | == Remarks == |
| - | ==== Equals(Object) ==== | + | * //N/A// |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:[[ThinkGeo.MapSuite.Core.GeoObjectModel|GeoObjectModel]] |
| - | | obj | Object<!-- System.Object --> | | | + | * Description:The GeoObjectModel recreated from the stream. |
| - | <!-- System.Object --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | * //stream// |
| - | ==== GetHashCode() ==== | + | * Type:Stream |
| - | === Return Value === | + | * Description:The Stream to load from. |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Int32<!-- System.Int32 --> | | | + | |
| - | === Parameters === | + | <div newline></div> |
| - | ^ Name ^ Type ^ Description ^ | + | ** {{wiki:PublicMethod.gif|}} ToString() ** |
| - | <!-- System.Object --> | + | * //N/A// |
| - | [[#Public Methods|Go Back]] | + | == Remarks == |
| - | ==== GetType() ==== | + | * //N/A// |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Type<!-- System.Type --> | | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:String |
| + | * Description:N/A | ||
| - | <!-- System.Object --> | + | == Parameters == |
| - | [[#Public Methods|Go Back]] | + | <div newline></div> |
| - | ==== Load(Stream) ==== | + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** |
| - | Load a stream into a GeoObjectModel. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.GeoObjectModel|GeoObjectModel]]<!-- ThinkGeo.MapSuite.Core.GeoObjectModel --> | The GeoObjectModel recreated from the stream. | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | stream | Stream<!-- System.IO.Stream --> | The Stream to load from. | | + | * //N/A// |
| - | <!-- ThinkGeo.MapSuite.Core.GeoSerializationFormatter --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Boolean |
| - | ==== Save(GeoObjectModel, Stream) ==== | + | * Description:N/A |
| - | Save serialized data into a stream. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //obj// |
| - | | model | [[ThinkGeo.MapSuite.Core.GeoObjectModel|GeoObjectModel]]<!-- ThinkGeo.MapSuite.Core.GeoObjectModel --> | The GeoObjectModel to create serialized data for. | | + | * Type:Object |
| - | | stream | Stream<!-- System.IO.Stream --> | The Stream to save serialized data into. | | + | * Description:N/A |
| - | <!-- ThinkGeo.MapSuite.Core.GeoSerializationFormatter --> | + | <div newline></div> |
| - | [[#Public Methods|Go Back]] | + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** |
| - | ==== ToString() ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | String<!-- System.String --> | | | + | |
| - | === Parameters === | + | * //N/A// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| + | * //N/A// | ||
| - | <!-- System.Object --> | + | == Return Value == |
| - | [[#Public Methods|Go Back]] | + | * Type:Int32 |
| - | ===== Protected Methods ===== | + | * Description:N/A |
| - | ==== Finalize() ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | <!-- System.Object --> | + | * //N/A// |
| - | [[#Protected Methods|Go Back]] | + | == Remarks == |
| - | ==== LoadCore(Stream) ==== | + | * //N/A// |
| - | Load a stream into a GeoObjectModel. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | [[ThinkGeo.MapSuite.Core.GeoObjectModel|GeoObjectModel]]<!-- ThinkGeo.MapSuite.Core.GeoObjectModel --> | The GeoObjectModel recreated from the stream. | | + | |
| - | === Parameters === | + | == Return Value == |
| - | ^ Name ^ Type ^ Description ^ | + | * Type:Type |
| - | | stream | Stream<!-- System.IO.Stream --> | The Stream to load from. | | + | * Description:N/A |
| - | <!-- ThinkGeo.MapSuite.Core.GeoSerializationFormatter --> | + | == Parameters == |
| - | [[#Protected Methods|Go Back]] | + | <div newline></div> |
| - | ==== MemberwiseClone() ==== | + | ==== Protected Methods ==== |
| - | === Return Value === | + | ** {{wiki:ProtectedMethod.gif|}} SaveCore(GeoObjectModel,Stream) ** |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Object<!-- System.Object --> | | | + | |
| - | === Parameters === | + | * //Format a GeoObjectModel into serialized data, and save the data into a stream.// |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| + | * //N/A// | ||
| - | <!-- System.Object --> | + | == Return Value == |
| - | [[#Protected Methods|Go Back]] | + | * Type:Void |
| - | ==== SaveCore(GeoObjectModel, Stream) ==== | + | * Description:N/A |
| - | Format a GeoObjectModel into serialized data, and save the data into a stream. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Void<!-- System.Void --> | | | + | |
| - | === Parameters === | + | == Parameters == |
| - | ^ Name ^ Type ^ Description ^ | + | * //model// |
| - | | model | [[ThinkGeo.MapSuite.Core.GeoObjectModel|GeoObjectModel]]<!-- ThinkGeo.MapSuite.Core.GeoObjectModel --> | The GeoObjectModel to create serialized data for. | | + | * Type:[[ThinkGeo.MapSuite.Core.GeoObjectModel|GeoObjectModel]] |
| - | | stream | Stream<!-- System.IO.Stream --> | The Stream to save serialized data into. | | + | * Description:The GeoObjectModel to create serialized data for. |
| + | |||
| + | * //stream// | ||
| + | * Type:Stream | ||
| + | * Description:The Stream to save serialized data into. | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} LoadCore(Stream) ** | ||
| + | |||
| + | * //Load a stream into a GeoObjectModel.// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoObjectModel|GeoObjectModel]] | ||
| + | * Description:The GeoObjectModel recreated from the stream. | ||
| + | |||
| + | == Parameters == | ||
| + | * //stream// | ||
| + | * Type:Stream | ||
| + | * Description:The Stream to load from. | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{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|}} Encoding ** | ||
| - | <!-- ThinkGeo.MapSuite.Core.GeoSerializationFormatter --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ===== Public Properties ===== | ||
| - | ==== Encoding ==== | ||
| set or get the readEncoding. | set or get the readEncoding. | ||
| - | === Return Value === | + | == Remarks == |
| - | ^ Return Type ^ | + | N/A |
| - | | Encoding<!-- System.Text.Encoding --> | | + | == Return Value == |
| + | * Type:Encoding | ||
| - | <!-- ThinkGeo.MapSuite.Core.GeoSerializationFormatter --> | + | ==== Protected Properties ==== |
| - | [[#Public Properties|Go Back]] | + | ==== Public Events ==== |
| - | ===== Protected Properties ===== | + | |
| - | ===== Public Events ===== | + | |
| - | __NOTOC__ | + | |
| - | [[Category:MapSuiteCore]] | + | |
| - | [[Category:ThinkGeo.MapSuite.Core]] | + | |
| - | [[Category:UpdateDocumentation]] | + | |