====== ThinkGeo.MapSuite.WmsServerEdition.WmsHandler ====== {{section>upgrade_map_suite_to_10.0}} This is an asynchronous HTTP handler which is used to handle web map services. ===== Inheritance Hierarchy ===== *System.Object ***ThinkGeo.MapSuite.WmsServerEdition.WmsHandler** ===== Members Summary ===== ==== Public Constructors ==== ** {{wiki:PublicMethod.gif|}} WmsHandler() ** * //This is the default constructor for the WmsHandler class.// == Remarks == * //This is the default constructor for the WmsHandler class.// == Parameters ==
==== Protected Constructors ==== ==== Public Methods ==== ** {{wiki:PublicMethod.gif|}} BeginProcessRequest(HttpContext,AsyncCallback,Object) ** * //Initiates an asynchronous call to the HTTP handler.// == Remarks == * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsHandler#BeginProcessRequest.28HttpContext.2C_AsyncCallback.2C_Object.29// == Return Value == * Type:IAsyncResult * Description:A System.IAsyncResult that contains information about the status of the process. == Parameters == * //context// * Type:HttpContext * Description:A System.Web.HttpContext object that provides references to intrinsic server objects (for example: Request, Response, Session, and Server) used to service HTTP requests. * //cb// * Type:AsyncCallback * Description:The System.AsyncCallback to call when the asynchronous method call is complete. If cb is null, the delegate is not called. * //extraData// * Type:Object * Description:Any extra data needed to process the request. ** {{wiki:PublicMethod.gif|}} EndProcessRequest(IAsyncResult) ** * //Provides an asynchronous process End method when the process ends.// == Remarks == * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsHandler#EndProcessRequest.28IAsyncResult.29// == Return Value == * Type:Void * Description:N/A == Parameters == * //result// * Type:IAsyncResult * Description:A System.IAsyncResult that contains information about the status of the process. ** {{wiki:PublicMethod.gif|}} ProcessRequest(HttpContext) ** * //Enables processing of HTTP Web requests by a custom HttpHandler that implements the System.Web.IHttpHandler interface.// == Remarks == * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsHandler#ProcessRequest.28HttpContext.29// == Return Value == * Type:Void * Description:N/A == Parameters == * //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. ** {{wiki:PublicMethod.gif|}} ToString() ** * //N/A// == Remarks == * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsHandler#ToString.28.29// == Return Value == * Type:String * Description:N/A == Parameters == ** {{wiki:PublicMethod.gif|}} Equals(Object) ** * //N/A// == Remarks == * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsHandler#Equals.28Object.29// == Return Value == * Type:Boolean * Description:N/A == Parameters == * //obj// * Type:Object * Description:N/A ** {{wiki:PublicMethod.gif|}} GetHashCode() ** * //N/A// == Remarks == * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsHandler#GetHashCode.28.29// == Return Value == * Type:Int32 * Description:N/A == Parameters == ** {{wiki:PublicMethod.gif|}} GetType() ** * //N/A// == Remarks == * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsHandler#GetType.28.29// == Return Value == * Type:Type * Description:N/A == Parameters == ==== Protected Methods ==== ** {{wiki:ProtectedMethod.gif|}} ProcessRequestCore(HttpContext) ** * //This abstract method is called from the concrete public method ProcessRequest. This method processes the request from client.// == Remarks == * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsHandler#ProcessRequestCore.28HttpContext.29// == Return Value == * Type:Void * Description:N/A == Parameters == * //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. ** {{wiki:ProtectedMethod.gif|}} GetCapabilities(GetCapabilitiesRequest,HttpContext) ** * //The purpose of the GetCapabilities WMS operation is to retrieve general information about the service itself and specific information about the available layers.// == Remarks == * //For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsHandler#GetCapabilities.28GetCapabilitiesRequest.2C_HttpContext.29// == Return Value == * Type:String * Description:This method returns general information about the service itself and specific information about the available layers. == Parameters == * //getCapabilitiesRequest// * Type:[[ThinkGeo.MapSuite.WmsServerEdition.GetCapabilitiesRequest|GetCapabilitiesRequest]] * Description:The RequestInfo object corresponding to the QueryString from the client's request. * //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. ** {{wiki:ProtectedMethod.gif|}} GetCapabilitiesCore(GetCapabilitiesRequest,HttpContext) ** * //The purpose of the GetCapabilities WMS operation is to retrieve general information about the service itself and specific information about the available layers.// == Remarks == * //This abstract method is called from the concrete public method GetCapabilities.// == Return Value == * Type:String * Description:This method returns general information about the service itself and specific information about the available layers. == Parameters == * //getCapabilitiesRequest// * Type:[[ThinkGeo.MapSuite.WmsServerEdition.GetCapabilitiesRequest|GetCapabilitiesRequest]] * Description:The RequestInfo object corresponding to the QueryString from the client's request. * //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. ** {{wiki:ProtectedMethod.gif|}} GetMap(GetMapRequest,HttpContext) ** * //The GetMap WMS operation is designed to 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.WmsHandler#GetMap.28GetMapRequest.2C_HttpContext.29// == Return Value == * Type:Bitmap * Description:This method returns a pictorial image or a set of graphical elements. == Parameters == * //getMapRequest// * Type:[[ThinkGeo.MapSuite.WmsServerEdition.GetMapRequest|GetMapRequest]] * Description:The RequestInfo object corresponding to the QueryString from the client's request. * //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. ** {{wiki:ProtectedMethod.gif|}} GetMapCore(GetMapRequest,HttpContext) ** * //The GetMap WMS operation is designed to produce a map, which is defined as either a pictorial image or a set of graphical elements.// == Remarks == * //This abstract method is called from the concrete public method GetMap.// == Return Value == * Type:Bitmap * Description:This method returns a pictorial image or a set of graphical elements. == Parameters == * //getMapRequest// * Type:[[ThinkGeo.MapSuite.WmsServerEdition.GetMapRequest|GetMapRequest]] * Description:The RequestInfo object corresponding to the QueryString from the client's request. * //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. ** {{wiki:ProtectedMethod.gif|}} GetFeatureInfo(GetFeatureInfoRequest,HttpContext) ** * //This method implements the WMS GetFeatureInfo operation and returns feature information depending on the request from the client.// == Remarks == * //This method is the concrete wrapper for the abstract 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. * //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. ** {{wiki:ProtectedMethod.gif|}} GetFeatureInfoCore(GetFeatureInfoRequest,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. * //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. ** {{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.WmsHandler#Finalize.28.29// == Return Value == * Type:Void * Description:N/A == Parameters == ** {{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.WmsHandler#MemberwiseClone.28.29// == Return Value == * Type:Object * Description:N/A == Parameters == ==== Public Properties ==== ** {{wiki:PublicProperty.gif|}} IsReusable ** Gets a value indicating whether another request can use the System.Web.IHttpHandler instance. == Remarks == For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsHandler#IsReusable == Return Value == * Type:Boolean ==== Protected Properties ==== ** {{wiki:ProtectedProperty.gif|}} CapabilitiesFilePathName ** The file path for your capabilites xml document == Remarks == For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.WmsServerEdition.WmsHandler#CapabilitiesFilePathName == Return Value == * Type:String ** {{wiki:ProtectedProperty.gif|}} OhQ= ** N/A == Remarks == N/A == Return Value == * Type:Collection<[[ThinkGeo.MapSuite.WmsServerEdition.WmsLayerPlugin|WmsLayerPlugin]]> ==== Public Events ====