Differences

This shows you the differences between two versions of the page.

--- thinkgeo.mapsuite.wmsserveredition.wmslayerplugin [2015/08/20 03:08]
127.0.0.1 external edit
+++ thinkgeo.mapsuite.wmsserveredition.wmslayerplugin [2017/03/16 21:59] (current)
@@ Line 1: / Line 1: @@
 ====== ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin ======
+{{section>upgrade_map_suite_to_10.0}}
-<!-- Class -->
 This class is the base class for all types of WMS Plug-ins. The WmsLayerPlugin class is where all other types of WMS Plug-ins are inherited from. It provides the base set of functionality. As it is abstract, there are a number of methods you need to implement. The first one is GetMapConfigurationCore. In this method, you are responsible for generating a MapConfiguration which includes layers collection and TileCache object you will use. The other two required methods are GetProjectionCore and GetBoundingBoxCore. These get projection string and the BoundingBox for your WMS Plug-in. Another required method is GetNameCore which returns the layer name which will used in the GetMap WMS operation.
 ===== Inheritance Hierarchy =====
-*System.Object
+  *System.Object
-**[[ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin]]
+    ***ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin**
 ===== Members Summary =====
 ==== Public Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
 ==== Protected Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+** {{wiki:ProtectedMethod.gif|}} WmsLayerPlugin() **
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#WmsLayerPlugin()|WmsLayerPlugin]]   |    |    | This is the default constructor for the WmsLayerPlugin class.   |
+  * //This is the default constructor for the WmsLayerPlugin class.//
+== Remarks ==
+  * //This is the default constructor for the WmsLayerPlugin class.//
+== Parameters ==
+<div newline></div>
 ==== Public Methods ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+** {{wiki:PublicMethod.gif|}} GetTitle() **
-| {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]]   | Object   | Object   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#GetBoundingBox(String)|GetBoundingBox]]   | String   |    | This method returns the bounding box of the Layer.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#GetCapabilities()|GetCapabilities]]   |    |    | This method gets the general information about the plug-in itself.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#GetFeatureInfo(GetFeatureInfoRequest, MapConfiguration, HttpContext)|GetFeatureInfo]]   | [[ThinkGeo.MapSuite.WmsServerEdition.GetFeatureInfoRequest|GetFeatureInfoRequest]], [[ThinkGeo.MapSuite.WmsServerEdition.MapConfiguration|MapConfiguration]], HttpContext   |    | This method implements the WMS GetFeatureInfo operation and returns feature information depending on the request from client.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#GetGeographyUnit(String)|GetGeographyUnit]]   | String   |    | This method returns the exact map unit (dependent on the crs) in order to support multiple projections.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]]   |    | Object   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#GetMap(GetMapRequest, MapConfiguration, HttpContext)|GetMap]]   | [[ThinkGeo.MapSuite.WmsServerEdition.GetMapRequest|GetMapRequest]], [[ThinkGeo.MapSuite.WmsServerEdition.MapConfiguration|MapConfiguration]], HttpContext   |    | Produce a map, which is defined as either a pictorial image or a set of graphical elements.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#GetMapConfiguration(String, String)|GetMapConfiguration]]   | String, String   |    | This method returns the MapConfiguration object which includes TileCache and Layers collection backed by a group of layers depend on the style, projection. This method is only called once per style and crs. In it you should create your layers and add them to the MapConfiguration. If you want to use tile caching you can also specify that in the MapConfiguration under the TileCache property. If you have setup multiple styles or projections this method will get called for each unique combination   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#GetName()|GetName]]   |    |    | This method returns a single word used for machine-to-machine communication.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#GetProjections()|GetProjections]]   |    |    | This method returns the projection string collection that are supported.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#GetStyles()|GetStyles]]   |    |    | This method you need to return the styels that are supported.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#GetTitle()|GetTitle]]   |    |    | This method returns the human-readable name of the WmsLayerPlugin.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]]   |    | Object   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]]   |    | Object   |    |
-==== Protected Methods ====
+  * //This method returns the human-readable name of the WmsLayerPlugin.//
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+== Remarks ==
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]]   |    | Object   |    |
+  * //This method is the concrete wrapper for the virtual method GetTitleCore. It returns the human-readable name of the WmsLayerPlugin.//
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetBoundingBoxCore(String)|GetBoundingBoxCore]]   | String   |    | This method returns the bounding box of the Layer.   |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetCapabilitiesCore()|GetCapabilitiesCore]]   |    |    | This method gets the general information about the plug-in itself.   |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetFeatureInfoCore(GetFeatureInfoRequest, MapConfiguration, HttpContext)|GetFeatureInfoCore]]   | [[ThinkGeo.MapSuite.WmsServerEdition.GetFeatureInfoRequest|GetFeatureInfoRequest]], [[ThinkGeo.MapSuite.WmsServerEdition.MapConfiguration|MapConfiguration]], HttpContext   |    | This method implements the WMS GetFeatureInfo operation and returns feature information depending on the request from client.   |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetGeographyUnitCore(String)|GetGeographyUnitCore]]   | String   |    | This method returns the exact map unit (dependent on the crs) in order to support multiple projections.   |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetMapConfigurationCore(String, String)|GetMapConfigurationCore]]   | String, String   |    | This method returns the MapConfiguration object which includes TileCache and Layers collection backed by a group of layers depend on the style, projection. This method is only called once per style and crs. In it you should create your layers and add them to the MapConfiguration. If you want to use tile caching you can also specify that in the MapConfiguration under the TileCache property. If you have setup multiple styles or projections this method will get called for each unique combination   |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetMapCore(GetMapRequest, MapConfiguration, HttpContext)|GetMapCore]]   | [[ThinkGeo.MapSuite.WmsServerEdition.GetMapRequest|GetMapRequest]], [[ThinkGeo.MapSuite.WmsServerEdition.MapConfiguration|MapConfiguration]], HttpContext   |    | Produce a map, which is defined as either a pictorial image or a set of graphical elements.   |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetNameCore()|GetNameCore]]   |    |    | This method returns a single word used for machine-to-machine communication.   |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetProjectionsCore()|GetProjectionsCore]]   |    |    | This method returns the projection string collection that are supported.   |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetStylesCore()|GetStylesCore]]   |    |    | This method you need to return the styels that are supported.   |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetTitleCore()|GetTitleCore]]   |    |    | This method returns the human-readable name of the WmsLayerPlugin.   |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]]   |    | Object   |    |
-==== Public Properties ====
+== Return Value ==
-^ Name ^ Return ^ DeclaringType ^ Summary ^
+  * Type:String
-| {{wiki:PublicProperty.gif|Public Property}}[[#BrowerCacheExpiration|BrowerCacheExpiration]]   | TimeSpan   |    | Represents the number of hours before the browser cache expires.   |
+  * Description:This method returns the human-readable name of the WmsLayerPlugin.
-| {{wiki:PublicProperty.gif|Public Property}}[[#JpegQuality|JpegQuality]]   | Int16   |    | Gets or sets the Jpeg quality , this property only take effects when setting the ImageFormat to Jpeg.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#WmsQueryMode|WmsQueryMode]]   | [[ThinkGeo.MapSuite.WmsServerEdition.WmsQueryMode|WmsQueryMode]]   |    | This enumeration specifies whether a WmsLayerPlugin support GetFeatureInfo WMS operation or not. If it doesn't support GetFeatureInfo operation, and it will throw an Service Exception XML.   |
-==== Protected Properties ====
+== Parameters ==
-^ Name ^ Return ^ DeclaringType ^ Summary ^
+<div newline></div>
+** {{wiki:PublicMethod.gif|}} GetName() **
-==== Public Events ====
+  * //This method returns a single word used for machine-to-machine communication.//
-^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^
+== Remarks ==
+  * //This method is the concrete wrapper for the abstract method GetNameCore. It returns returns a single word used for machine-to-machine communication.//
-===== Public Constructors =====
+== Return Value ==
-===== Protected Constructors =====
+  * Type:String
-==== WmsLayerPlugin() ====
+  * Description:This method returns a single word used for machine-to-machine communication.
-This is the default constructor for the WmsLayerPlugin class.
-=== Remarks ===
-This is the default constructor for the WmsLayerPlugin class.
-=== Parameters ===
-^  Name ^  Type ^  Description ^
-[[#Protected Constructors|Go Back]]
+== Parameters ==
-===== Public Methods =====
+<div newline></div>
-==== Equals(Object) ====
+** {{wiki:PublicMethod.gif|}} GetProjections() **
-=== Return Value ===
-^ Return Type ^ Description ^
-| Boolean<!-- System.Boolean -->   |    |
-=== Parameters ===
+  * //This method returns the projection string collection that are supported.//
-^  Name ^  Type ^  Description ^
+== Remarks ==
-| obj   | Object<!-- System.Object -->   |    |
+  * //This method returns the projection string collection that are supported.//
-<!-- System.Object -->
+== Return Value ==
-[[#Public Methods|Go Back]]
+  * Type:Collection<String>
-==== GetBoundingBox(String) ====
+  * Description:This method returns the projection string collection that are supported.
-This method returns the bounding box of the Layer.
-=== Remarks ===
-This method returns the bounding box of the Layer.
-=== Return Value ===
-^ Return Type ^ Description ^
-| [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape -->   | This method returns the bounding box of the Layer.   |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+<div newline></div>
-| crs   | String<!-- System.String -->   | User gets the exact bounding box depend on crs in order to support multiple projections.   |
+** {{wiki:PublicMethod.gif|}} GetStyles() **
-<!-- ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin -->
+  * //This method you need to return the styels that are supported.//
-[[#Public Methods|Go Back]]
+== Remarks ==
-==== GetCapabilities() ====
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#GetStyles.28.29//
-This method gets the general information about the plug-in itself.
-=== Return Value ===
-^ Return Type ^ Description ^
-| String<!-- System.String -->   | This method gets the general information about the plug-in itself.   |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:Collection<[[ThinkGeo.MapSuite.WmsServerEdition.WmsLayerStyle|WmsLayerStyle]]>
+  * Description:This method you need to return the styels that are supported.
-<!-- ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin -->
+== Parameters ==
-[[#Public Methods|Go Back]]
+<div newline></div>
-==== GetFeatureInfo(GetFeatureInfoRequest, MapConfiguration, HttpContext) ====
+** {{wiki:PublicMethod.gif|}} GetGeographyUnit(String) **
-This method implements the WMS GetFeatureInfo operation and returns feature information depending on the request from client.
-=== Remarks ===
-This abstract method is called from the concrete public method GetFeatureInfo. The canonical use case for GetFeatureInfo is that a user sees the response of a GetMap request and chooses a point on that map for which to obtain more information. The basic operation provides the ability for a client to specify which pixel is being asked about, which layer(s) should be investigated, and what format the information should be returned in.
-=== Return Value ===
-^ Return Type ^ Description ^
-| String<!-- System.String -->   | This method returns feature information depending on the request from the client.   |
-=== Parameters ===
+  * //This method returns the exact map unit (dependent on the crs) in order to support multiple projections.//
-^  Name ^  Type ^  Description ^
+== Remarks ==
-| getFeatureInfoRequest   | [[ThinkGeo.MapSuite.WmsServerEdition.GetFeatureInfoRequest|GetFeatureInfoRequest]]<!-- ThinkGeo.MapSuite.WmsServerEdition.GetFeatureInfoRequest -->   | The RequestInfo object corresponding to the QueryString from the client's request.   |
+  * //This method returns the exact map unit (dependent on the crs) in order to support multiple projections.//
-| cachedMapConfiguration   | [[ThinkGeo.MapSuite.WmsServerEdition.MapConfiguration|MapConfiguration]]<!-- ThinkGeo.MapSuite.WmsServerEdition.MapConfiguration -->   | MapConfiguration object from HttpContext.Application.   |
-| context   | HttpContext<!-- System.Web.HttpContext -->   | A System.Web.HttpContext object that provides references to the intrinsic server objects (for example: Request, Response, Session, and Server) used to service HTTP requests.   |
-<!-- ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin -->
+== Return Value ==
-[[#Public Methods|Go Back]]
+  * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]
-==== GetGeographyUnit(String) ====
+  * Description:This method returns the exact map unit (dependent on the crs) in order to support multiple projections.
-This method returns the exact map unit (dependent on the crs) in order to support multiple projections.
-=== Remarks ===
-This method returns the exact map unit (dependent on the crs) in order to support multiple projections.
-=== Return Value ===
-^ Return Type ^ Description ^
-| [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit -->   | This method returns the exact map unit (dependent on the crs) in order to support multiple projections.   |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+  * //crs//
-| crs   | String<!-- System.String -->   | The user gets the exact map unit (dependent on the crs) in order to support multiple projections.   |
+    * Type:String
+    * Description:The user gets the exact map unit (dependent on the crs) in order to support multiple projections.
-<!-- ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin -->
+<div newline></div>
-[[#Public Methods|Go Back]]
+** {{wiki:PublicMethod.gif|}} GetMapConfiguration(String,String) **
-==== GetHashCode() ====
-=== Return Value ===
-^ Return Type ^ Description ^
-| Int32<!-- System.Int32 -->   |    |
-=== Parameters ===
+  * //This method returns the MapConfiguration object which includes TileCache and Layers collection backed by a group of layers depend on the style, projection. This method is only called once per style and crs. In it you should create your layers and add them to the MapConfiguration. If you want to use tile caching you can also specify that in the MapConfiguration under the TileCache property. If you have setup multiple styles or projections this method will get called for each unique combination//
-^  Name ^  Type ^  Description ^
+== Remarks ==
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#GetMapConfiguration.28String.2C_String.29//
-<!-- System.Object -->
+== Return Value ==
-[[#Public Methods|Go Back]]
+  * Type:[[ThinkGeo.MapSuite.WmsServerEdition.MapConfiguration|MapConfiguration]]
-==== GetMap(GetMapRequest, MapConfiguration, HttpContext) ====
+  * Description:Return the MapConfiguration object which represents a layer backed by a group of layers depend on the style.
-Produce a map, which is defined as either a pictorial image or a set of graphical elements.
-=== Return Value ===
-^ Return Type ^ Description ^
-| Bitmap<!-- System.Drawing.Bitmap -->   |    |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+  * //style//
-| getMapRequest   | [[ThinkGeo.MapSuite.WmsServerEdition.GetMapRequest|GetMapRequest]]<!-- ThinkGeo.MapSuite.WmsServerEdition.GetMapRequest -->   | The RequestInfo object corresponding to the QueryString from the client's request.   |
+    * Type:String
-| cachedMapConfiguration   | [[ThinkGeo.MapSuite.WmsServerEdition.MapConfiguration|MapConfiguration]]<!-- ThinkGeo.MapSuite.WmsServerEdition.MapConfiguration -->   | MapConfiguration object from HttpContext.Application.   |
+    * Description:The style parameter string.
-| context   | HttpContext<!-- System.Web.HttpContext -->   | A System.Web.HttpContext object that provides references to the intrinsic server objects (for example: Request, Response, Session, and Server) used to service HTTP requests.   |
-<!-- ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin -->
+  * //crs//
-[[#Public Methods|Go Back]]
+    * Type:String
-==== GetMapConfiguration(String, String) ====
+    * Description:The projectin parameter string.
-This method returns the MapConfiguration object which includes TileCache and Layers collection backed by a group of layers depend on the style, projection. This method is only called once per style and crs. In it you should create your layers and add them to the MapConfiguration. If you want to use tile caching you can also specify that in the MapConfiguration under the TileCache property. If you have setup multiple styles or projections this method will get called for each unique combination
-=== Return Value ===
-^ Return Type ^ Description ^
-| [[ThinkGeo.MapSuite.WmsServerEdition.MapConfiguration|MapConfiguration]]<!-- ThinkGeo.MapSuite.WmsServerEdition.MapConfiguration -->   | Return the MapConfiguration object which represents a layer backed by a group of layers depend on the style.   |
-=== Parameters ===
+<div newline></div>
-^  Name ^  Type ^  Description ^
+** {{wiki:PublicMethod.gif|}} GetBoundingBox(String) **
-| style   | String<!-- System.String -->   | The style parameter string.   |
-| crs   | String<!-- System.String -->   | The projectin parameter string.   |
-<!-- ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin -->
+  * //This method returns the bounding box of the Layer.//
-[[#Public Methods|Go Back]]
+== Remarks ==
-==== GetName() ====
+  * //This method returns the bounding box of the Layer.//
-This method returns a single word used for machine-to-machine communication.
-=== Remarks ===
-This method is the concrete wrapper for the abstract method GetNameCore. It returns returns a single word used for machine-to-machine communication.
-=== Return Value ===
-^ Return Type ^ Description ^
-| String<!-- System.String -->   | This method returns a single word used for machine-to-machine communication.   |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
+  * Description:This method returns the bounding box of the Layer.
-<!-- ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin -->
+== Parameters ==
-[[#Public Methods|Go Back]]
+  * //crs//
-==== GetProjections() ====
+    * Type:String
-This method returns the projection string collection that are supported.
+    * Description:User gets the exact bounding box depend on crs in order to support multiple projections.
-=== Remarks ===
-This method returns the projection string collection that are supported.
-=== Return Value ===
-^ Return Type ^ Description ^
-| Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} -->   | This method returns the projection string collection that are supported.   |
-=== Parameters ===
+<div newline></div>
-^  Name ^  Type ^  Description ^
+** {{wiki:PublicMethod.gif|}} GetCapabilities() **
-<!-- ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin -->
+  * //This method gets the general information about the plug-in itself.//
-[[#Public Methods|Go Back]]
+== Remarks ==
-==== GetStyles() ====
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#GetCapabilities.28.29//
-This method you need to return the styels that are supported.
-=== Return Value ===
-^ Return Type ^ Description ^
-| Collection<[[ThinkGeo.MapSuite.WmsServerEdition.WmsLayerStyle|WmsLayerStyle]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.WmsServerEdition.WmsLayerStyle} -->   | This method you need to return the styels that are supported.   |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:String
+  * Description:This method gets the general information about the plug-in itself.
-<!-- ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin -->
+== Parameters ==
-[[#Public Methods|Go Back]]
+<div newline></div>
-==== GetTitle() ====
+** {{wiki:PublicMethod.gif|}} GetMap(GetMapRequest,MapConfiguration,HttpContext) **
-This method returns the human-readable name of the WmsLayerPlugin.
-=== Remarks ===
-This method is the concrete wrapper for the virtual method GetTitleCore. It returns the human-readable name of the WmsLayerPlugin.
-=== Return Value ===
-^ Return Type ^ Description ^
-| String<!-- System.String -->   | This method returns the human-readable name of the WmsLayerPlugin.   |
-=== Parameters ===
+  * //Produce a map, which is defined as either a pictorial image or a set of graphical elements.//
-^  Name ^  Type ^  Description ^
+== Remarks ==
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#GetMap.28GetMapRequest.2C_MapConfiguration.2C_HttpContext.29//
-<!-- ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin -->
+== Return Value ==
-[[#Public Methods|Go Back]]
+  * Type:Bitmap
-==== GetType() ====
+  * Description:N/A
-=== Return Value ===
-^ Return Type ^ Description ^
-| Type<!-- System.Type -->   |    |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+  * //getMapRequest//
+    * Type:[[ThinkGeo.MapSuite.WmsServerEdition.GetMapRequest|GetMapRequest]]
+    * Description:The RequestInfo object corresponding to the QueryString from the client's request.
-<!-- System.Object -->
+  * //cachedMapConfiguration//
-[[#Public Methods|Go Back]]
+    * Type:[[ThinkGeo.MapSuite.WmsServerEdition.MapConfiguration|MapConfiguration]]
-==== ToString() ====
+    * Description:MapConfiguration object from HttpContext.Application.
-=== Return Value ===
-^ Return Type ^ Description ^
-| String<!-- System.String -->   |    |
-=== Parameters ===
+  * //context//
-^  Name ^  Type ^  Description ^
+    * Type:HttpContext
+    * Description:A System.Web.HttpContext object that provides references to the intrinsic server objects (for example: Request, Response, Session, and Server) used to service HTTP requests.
-<!-- System.Object -->
+<div newline></div>
-[[#Public Methods|Go Back]]
+** {{wiki:PublicMethod.gif|}} GetFeatureInfo(GetFeatureInfoRequest,MapConfiguration,HttpContext) **
-===== Protected Methods =====
-==== Finalize() ====
-=== Return Value ===
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+  * //This method implements the WMS GetFeatureInfo operation and returns feature information depending on the request from client.//
-^  Name ^  Type ^  Description ^
+== Remarks ==
+  * //This abstract method is called from the concrete public method GetFeatureInfo. The canonical use case for GetFeatureInfo is that a user sees the response of a GetMap request and chooses a point on that map for which to obtain more information. The basic operation provides the ability for a client to specify which pixel is being asked about, which layer(s) should be investigated, and what format the information should be returned in.//
-<!-- System.Object -->
+== Return Value ==
-[[#Protected Methods|Go Back]]
+  * Type:String
-==== GetBoundingBoxCore(String) ====
+  * Description:This method returns feature information depending on the request from the client.
-This method returns the bounding box of the Layer.
-=== Remarks ===
-This method returns the bounding box of the Layer.
-=== Return Value ===
-^ Return Type ^ Description ^
-| [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape -->   | This method returns the bounding box of the Layer.   |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+  * //getFeatureInfoRequest//
-| crs   | String<!-- System.String -->   | User gets the exact bounding box depend on crs in order to support multiple projections.   |
+    * Type:[[ThinkGeo.MapSuite.WmsServerEdition.GetFeatureInfoRequest|GetFeatureInfoRequest]]
+    * Description:The RequestInfo object corresponding to the QueryString from the client's request.
-<!-- ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin -->
+  * //cachedMapConfiguration//
-[[#Protected Methods|Go Back]]
+    * Type:[[ThinkGeo.MapSuite.WmsServerEdition.MapConfiguration|MapConfiguration]]
-==== GetCapabilitiesCore() ====
+    * Description:MapConfiguration object from HttpContext.Application.
-This method gets the general information about the plug-in itself.
-=== Return Value ===
-^ Return Type ^ Description ^
-| String<!-- System.String -->   | This method gets the general information about the plug-in itself.   |
-=== Parameters ===
+  * //context//
-^  Name ^  Type ^  Description ^
+    * Type:HttpContext
+    * Description:A System.Web.HttpContext object that provides references to the intrinsic server objects (for example: Request, Response, Session, and Server) used to service HTTP requests.
-<!-- ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin -->
+<div newline></div>
-[[#Protected Methods|Go Back]]
+** {{wiki:PublicMethod.gif|}} ToString() **
-==== GetFeatureInfoCore(GetFeatureInfoRequest, MapConfiguration, HttpContext) ====
-This method implements the WMS GetFeatureInfo operation and returns feature information depending on the request from client.
-=== Remarks ===
-This abstract method is called from the concrete public method GetFeatureInfo. The canonical use case for GetFeatureInfo is that a user sees the response of a GetMap request and chooses a point on that map for which to obtain more information. The basic operation provides the ability for a client to specify which pixel is being asked about, which layer(s) should be investigated, and what format the information should be returned in.
-=== Return Value ===
-^ Return Type ^ Description ^
-| String<!-- System.String -->   | This method returns feature information depending on the request from the client.   |
-=== Parameters ===
+  * //N/A//
-^  Name ^  Type ^  Description ^
+== Remarks ==
-| getFeatureInfoRequest   | [[ThinkGeo.MapSuite.WmsServerEdition.GetFeatureInfoRequest|GetFeatureInfoRequest]]<!-- ThinkGeo.MapSuite.WmsServerEdition.GetFeatureInfoRequest -->   | The RequestInfo object corresponding to the QueryString from the client's request.   |
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#ToString.28.29//
-| cachedMapConfiguration   | [[ThinkGeo.MapSuite.WmsServerEdition.MapConfiguration|MapConfiguration]]<!-- ThinkGeo.MapSuite.WmsServerEdition.MapConfiguration -->   | MapConfiguration object from HttpContext.Application.   |
-| context   | HttpContext<!-- System.Web.HttpContext -->   | A System.Web.HttpContext object that provides references to the intrinsic server objects (for example: Request, Response, Session, and Server) used to service HTTP requests.   |
-<!-- ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin -->
+== Return Value ==
-[[#Protected Methods|Go Back]]
+  * Type:String
-==== GetGeographyUnitCore(String) ====
+  * Description:N/A
-This method returns the exact map unit (dependent on the crs) in order to support multiple projections.
-=== Remarks ===
-This method returns the exact map unit (dependent on the crs) in order to support multiple projections.
-=== Return Value ===
-^ Return Type ^ Description ^
-| [[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]<!-- ThinkGeo.MapSuite.Core.GeographyUnit -->   | This method returns the exact map unit (dependent on the crs) in order to support multiple projections.   |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+<div newline></div>
-| crs   | String<!-- System.String -->   | The user gets the exact map unit (dependent on the crs) in order to support multiple projections.   |
+** {{wiki:PublicMethod.gif|}} Equals(Object) **
-<!-- ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin -->
+  * //N/A//
-[[#Protected Methods|Go Back]]
+== Remarks ==
-==== GetMapConfigurationCore(String, String) ====
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#Equals.28Object.29//
-This method returns the MapConfiguration object which includes TileCache and Layers collection backed by a group of layers depend on the style, projection. This method is only called once per style and crs. In it you should create your layers and add them to the MapConfiguration. If you want to use tile caching you can also specify that in the MapConfiguration under the TileCache property. If you have setup multiple styles or projections this method will get called for each unique combination
-=== Return Value ===
-^ Return Type ^ Description ^
-| [[ThinkGeo.MapSuite.WmsServerEdition.MapConfiguration|MapConfiguration]]<!-- ThinkGeo.MapSuite.WmsServerEdition.MapConfiguration -->   | Return the MapConfiguration object which represents a layer backed by a group of layers depend on the style.   |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:Boolean
-| style   | String<!-- System.String -->   | The style parameter string.   |
+  * Description:N/A
-| crs   | String<!-- System.String -->   | The projectin parameter string.   |
-<!-- ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin -->
+== Parameters ==
-[[#Protected Methods|Go Back]]
+  * //obj//
-==== GetMapCore(GetMapRequest, MapConfiguration, HttpContext) ====
+    * Type:Object
-Produce a map, which is defined as either a pictorial image or a set of graphical elements.
+    * Description:N/A
-=== Return Value ===
-^ Return Type ^ Description ^
-| Bitmap<!-- System.Drawing.Bitmap -->   |    |
-=== Parameters ===
+<div newline></div>
-^  Name ^  Type ^  Description ^
+** {{wiki:PublicMethod.gif|}} GetHashCode() **
-| getMapRequest   | [[ThinkGeo.MapSuite.WmsServerEdition.GetMapRequest|GetMapRequest]]<!-- ThinkGeo.MapSuite.WmsServerEdition.GetMapRequest -->   | The RequestInfo object corresponding to the QueryString from the client's request.   |
-| cachedMapConfiguration   | [[ThinkGeo.MapSuite.WmsServerEdition.MapConfiguration|MapConfiguration]]<!-- ThinkGeo.MapSuite.WmsServerEdition.MapConfiguration -->   | MapConfiguration object from HttpContext.Application.   |
-| context   | HttpContext<!-- System.Web.HttpContext -->   | A System.Web.HttpContext object that provides references to the intrinsic server objects (for example: Request, Response, Session, and Server) used to service HTTP requests.   |
-<!-- ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin -->
+  * //N/A//
-[[#Protected Methods|Go Back]]
+== Remarks ==
-==== GetNameCore() ====
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#GetHashCode.28.29//
-This method returns a single word used for machine-to-machine communication.
-=== Remarks ===
-This method is called from the concrete public method GetName. It returns a single word used for machine-to-machine communication.
-=== Return Value ===
-^ Return Type ^ Description ^
-| String<!-- System.String -->   | This method returns a single word used for machine-to-machine communication.   |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:Int32
+  * Description:N/A
-<!-- ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin -->
+== Parameters ==
-[[#Protected Methods|Go Back]]
+<div newline></div>
-==== GetProjectionsCore() ====
+** {{wiki:PublicMethod.gif|}} GetType() **
-This method returns the projection string collection that are supported.
-=== Remarks ===
-This method returns the projection string collection that are supported.
-=== Return Value ===
-^ Return Type ^ Description ^
-| Collection<String><!-- System.Collections.ObjectModel.Collection{System.String} -->   | This method returns the projection string collection that are supported.   |
-=== Parameters ===
+  * //N/A//
-^  Name ^  Type ^  Description ^
+== Remarks ==
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#GetType.28.29//
-<!-- ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin -->
+== Return Value ==
-[[#Protected Methods|Go Back]]
+  * Type:Type
-==== GetStylesCore() ====
+  * Description:N/A
-This method you need to return the styels that are supported.
-=== Return Value ===
-^ Return Type ^ Description ^
-| Collection<[[ThinkGeo.MapSuite.WmsServerEdition.WmsLayerStyle|WmsLayerStyle]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.WmsServerEdition.WmsLayerStyle} -->   | This method you need to return the styels that are supported.   |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+<div newline></div>
+==== Protected Methods ====
+** {{wiki:ProtectedMethod.gif|}} GetTitleCore() **
-<!-- ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin -->
+  * //This method returns the human-readable name of the WmsLayerPlugin.//
-[[#Protected Methods|Go Back]]
+== Remarks ==
-==== GetTitleCore() ====
+  * //This method is called from the concrete public method GetTitle. This method returns the human-readable name of the WmsLayerPlugin.//
-This method returns the human-readable name of the WmsLayerPlugin.
-=== Remarks ===
-This method is called from the concrete public method GetTitle. This method returns the human-readable name of the WmsLayerPlugin.
-=== Return Value ===
-^ Return Type ^ Description ^
-| String<!-- System.String -->   | This method returns the human-readable name of the WmsLayerPlugin.   |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:String
+  * Description:This method returns the human-readable name of the WmsLayerPlugin.
-<!-- ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin -->
+== Parameters ==
-[[#Protected Methods|Go Back]]
+<div newline></div>
-==== MemberwiseClone() ====
+** {{wiki:ProtectedMethod.gif|}} GetNameCore() **
-=== Return Value ===
-^ Return Type ^ Description ^
-| Object<!-- System.Object -->   |    |
-=== Parameters ===
+  * //This method returns a single word used for machine-to-machine communication.//
-^  Name ^  Type ^  Description ^
+== Remarks ==
+  * //This method is called from the concrete public method GetName. It returns a single word used for machine-to-machine communication.//
-<!-- System.Object -->
+== Return Value ==
-[[#Protected Methods|Go Back]]
+  * Type:String
-===== Public Properties =====
+  * Description:This method returns a single word used for machine-to-machine communication.
-==== BrowerCacheExpiration ====
-Represents the number of hours before the browser cache expires.
-=== Return Value ===
-^ Return Type ^
-| TimeSpan<!-- System.TimeSpan -->   |
-<!-- ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin -->
+== Parameters ==
-[[#Public Properties|Go Back]]
+<div newline></div>
-==== JpegQuality ====
+** {{wiki:ProtectedMethod.gif|}} GetProjectionsCore() **
-Gets or sets the Jpeg quality , this property only take effects when setting the ImageFormat to Jpeg.
-=== Return Value ===
+  * //This method returns the projection string collection that are supported.//
-^ Return Type ^
+== Remarks ==
-| Int16<!-- System.Int16 -->   |
+  * //This method returns the projection string collection that are supported.//
+== Return Value ==
+  * Type:Collection<String>
+  * Description:This method returns the projection string collection that are supported.
+== Parameters ==
+<div newline></div>
+** {{wiki:ProtectedMethod.gif|}} GetStylesCore() **
+  * //This method you need to return the styels that are supported.//
+== Remarks ==
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#GetStylesCore.28.29//
+== Return Value ==
+  * Type:Collection<[[ThinkGeo.MapSuite.WmsServerEdition.WmsLayerStyle|WmsLayerStyle]]>
+  * Description:This method you need to return the styels that are supported.
+== Parameters ==
+<div newline></div>
+** {{wiki:ProtectedMethod.gif|}} GetGeographyUnitCore(String) **
+  * //This method returns the exact map unit (dependent on the crs) in order to support multiple projections.//
+== Remarks ==
+  * //This method returns the exact map unit (dependent on the crs) in order to support multiple projections.//
+== Return Value ==
+  * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]
+  * Description:This method returns the exact map unit (dependent on the crs) in order to support multiple projections.
+== Parameters ==
+  * //crs//
+    * Type:String
+    * Description:The user gets the exact map unit (dependent on the crs) in order to support multiple projections.
+<div newline></div>
+** {{wiki:ProtectedMethod.gif|}} GetMapConfigurationCore(String,String) **
+  * //This method returns the MapConfiguration object which includes TileCache and Layers collection backed by a group of layers depend on the style, projection. This method is only called once per style and crs. In it you should create your layers and add them to the MapConfiguration. If you want to use tile caching you can also specify that in the MapConfiguration under the TileCache property. If you have setup multiple styles or projections this method will get called for each unique combination//
+== Remarks ==
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#GetMapConfigurationCore.28String.2C_String.29//
+== Return Value ==
+  * Type:[[ThinkGeo.MapSuite.WmsServerEdition.MapConfiguration|MapConfiguration]]
+  * Description:Return the MapConfiguration object which represents a layer backed by a group of layers depend on the style.
+== Parameters ==
+  * //style//
+    * Type:String
+    * Description:The style parameter string.
+  * //crs//
+    * Type:String
+    * Description:The projectin parameter string.
+<div newline></div>
+** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore(String) **
+  * //This method returns the bounding box of the Layer.//
+== Remarks ==
+  * //This method returns the bounding box of the Layer.//
+== Return Value ==
+  * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
+  * Description:This method returns the bounding box of the Layer.
+== Parameters ==
+  * //crs//
+    * Type:String
+    * Description:User gets the exact bounding box depend on crs in order to support multiple projections.
+<div newline></div>
+** {{wiki:ProtectedMethod.gif|}} GetCapabilitiesCore() **
+  * //This method gets the general information about the plug-in itself.//
+== Remarks ==
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#GetCapabilitiesCore.28.29//
+== Return Value ==
+  * Type:String
+  * Description:This method gets the general information about the plug-in itself.
+== Parameters ==
+<div newline></div>
+** {{wiki:ProtectedMethod.gif|}} GetMapCore(GetMapRequest,MapConfiguration,HttpContext) **
+  * //Produce a map, which is defined as either a pictorial image or a set of graphical elements.//
+== Remarks ==
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#GetMapCore.28GetMapRequest.2C_MapConfiguration.2C_HttpContext.29//
+== Return Value ==
+  * Type:Bitmap
+  * Description:N/A
+== Parameters ==
+  * //getMapRequest//
+    * Type:[[ThinkGeo.MapSuite.WmsServerEdition.GetMapRequest|GetMapRequest]]
+    * Description:The RequestInfo object corresponding to the QueryString from the client's request.
+  * //cachedMapConfiguration//
+    * Type:[[ThinkGeo.MapSuite.WmsServerEdition.MapConfiguration|MapConfiguration]]
+    * Description:MapConfiguration object from HttpContext.Application.
+  * //context//
+    * Type:HttpContext
+    * Description:A System.Web.HttpContext object that provides references to the intrinsic server objects (for example: Request, Response, Session, and Server) used to service HTTP requests.
+<div newline></div>
+** {{wiki:ProtectedMethod.gif|}} GetFeatureInfoCore(GetFeatureInfoRequest,MapConfiguration,HttpContext) **
+  * //This method implements the WMS GetFeatureInfo operation and returns feature information depending on the request from client.//
+== Remarks ==
+  * //This abstract method is called from the concrete public method GetFeatureInfo. The canonical use case for GetFeatureInfo is that a user sees the response of a GetMap request and chooses a point on that map for which to obtain more information. The basic operation provides the ability for a client to specify which pixel is being asked about, which layer(s) should be investigated, and what format the information should be returned in.//
+== Return Value ==
+  * Type:String
+  * Description:This method returns feature information depending on the request from the client.
+== Parameters ==
+  * //getFeatureInfoRequest//
+    * Type:[[ThinkGeo.MapSuite.WmsServerEdition.GetFeatureInfoRequest|GetFeatureInfoRequest]]
+    * Description:The RequestInfo object corresponding to the QueryString from the client's request.
+  * //cachedMapConfiguration//
+    * Type:[[ThinkGeo.MapSuite.WmsServerEdition.MapConfiguration|MapConfiguration]]
+    * Description:MapConfiguration object from HttpContext.Application.
+  * //context//
+    * Type:HttpContext
+    * Description:A System.Web.HttpContext object that provides references to the intrinsic server objects (for example: Request, Response, Session, and Server) used to service HTTP requests.
+<div newline></div>
+** {{wiki:ProtectedMethod.gif|}} Finalize() **
+  * //N/A//
+== Remarks ==
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#Finalize.28.29//
+== Return Value ==
+  * Type:Void
+  * Description:N/A
+== Parameters ==
+<div newline></div>
+** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **
+  * //N/A//
+== Remarks ==
+  * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#MemberwiseClone.28.29//
+== Return Value ==
+  * Type:Object
+  * Description:N/A
+== Parameters ==
+<div newline></div>
+==== Public Properties ====
+** {{wiki:PublicProperty.gif|}} WmsQueryMode **
-<!-- ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin -->
-[[#Public Properties|Go Back]]
-==== WmsQueryMode ====
 This enumeration specifies whether a WmsLayerPlugin support GetFeatureInfo WMS operation or not. If it doesn't support GetFeatureInfo operation, and it will throw an Service Exception XML.
-=== Return Value ===
+== Remarks ==
-^ Return Type ^
+For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#WmsQueryMode
-| [[ThinkGeo.MapSuite.WmsServerEdition.WmsQueryMode|WmsQueryMode]]<!-- ThinkGeo.MapSuite.WmsServerEdition.WmsQueryMode -->   |
+== Return Value ==
+  * Type:[[ThinkGeo.MapSuite.WmsServerEdition.WmsQueryMode|WmsQueryMode]]
-<!-- ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin -->
+** {{wiki:PublicProperty.gif|}} JpegQuality **
-[[#Public Properties|Go Back]]
-===== Protected Properties =====
+Gets or sets the Jpeg quality , this property only take effects when setting the ImageFormat to Jpeg.
-===== Public Events =====
+== Remarks ==
-__NOTOC__
+For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#JpegQuality
-[[Category:WmsServerEdition]]
+== Return Value ==
-[[Category:ThinkGeo.MapSuite.WmsServerEdition]]
+  * Type:Int16
-[[Category:UpdateDocumentation]]
+** {{wiki:PublicProperty.gif|}} BrowerCacheExpiration **
+Represents the number of hours before the browser cache expires.
+== Remarks ==
+For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin#BrowerCacheExpiration
+== Return Value ==
+  * Type:TimeSpan
+==== Protected Properties ====
+** {{wiki:ProtectedProperty.gif|}} RRQ= **
+N/A
+== Remarks ==
+N/A
+== Return Value ==
+  * Type:String
+==== Public Events ====

User Tools

Site Tools

Differences

Page Tools