This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.wmsserveredition.wmshandler [2015/08/20 03:08] 127.0.0.1 external edit |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.WmsServerEdition.WmsHandler ====== | ||
| - | |||
| - | |||
| - | |||
| - | <!-- Class --> | ||
| - | 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 ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#WmsHandler()|WmsHandler]] | | | This is the default constructor for the WmsHandler class. | | ||
| - | |||
| - | ==== Protected Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#BeginProcessRequest(HttpContext, AsyncCallback, Object)|BeginProcessRequest]] | HttpContext, AsyncCallback, Object | | Initiates an asynchronous call to the HTTP handler. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#EndProcessRequest(IAsyncResult)|EndProcessRequest]] | IAsyncResult | | Provides an asynchronous process End method when the process ends. | | ||
| - | | {{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}}[[#ProcessRequest(HttpContext)|ProcessRequest]] | HttpContext | | Enables processing of HTTP Web requests by a custom HttpHandler that implements the System.Web.IHttpHandler interface. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object | | | ||
| - | |||
| - | ==== Protected Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetCapabilities(GetCapabilitiesRequest, HttpContext)|GetCapabilities]] | [[ThinkGeo.MapSuite.WmsServerEdition.GetCapabilitiesRequest|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. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetCapabilitiesCore(GetCapabilitiesRequest, HttpContext)|GetCapabilitiesCore]] | [[ThinkGeo.MapSuite.WmsServerEdition.GetCapabilitiesRequest|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. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetFeatureInfo(GetFeatureInfoRequest, HttpContext)|GetFeatureInfo]] | [[ThinkGeo.MapSuite.WmsServerEdition.GetFeatureInfoRequest|GetFeatureInfoRequest]], HttpContext | | This method implements the WMS GetFeatureInfo operation and returns feature information depending on the request from the client. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetFeatureInfoCore(GetFeatureInfoRequest, HttpContext)|GetFeatureInfoCore]] | [[ThinkGeo.MapSuite.WmsServerEdition.GetFeatureInfoRequest|GetFeatureInfoRequest]], HttpContext | | This method implements the WMS GetFeatureInfo operation and returns feature information depending on the request from client. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetMap(GetMapRequest, HttpContext)|GetMap]] | [[ThinkGeo.MapSuite.WmsServerEdition.GetMapRequest|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. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetMapCore(GetMapRequest, HttpContext)|GetMapCore]] | [[ThinkGeo.MapSuite.WmsServerEdition.GetMapRequest|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. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#ProcessRequestCore(HttpContext)|ProcessRequestCore]] | HttpContext | | This abstract method is called from the concrete public method ProcessRequest. This method processes the request from client. | | ||
| - | |||
| - | ==== Public Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#IsReusable|IsReusable]] | Boolean | | Gets a value indicating whether another request can use the System.Web.IHttpHandler instance. | | ||
| - | |||
| - | ==== Protected Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:ProtectedProperty.gif|Protected Property}}[[#CapabilitiesFilePathName|CapabilitiesFilePathName]] | String | | The file path for your capabilites xml document | | ||
| - | |||
| - | ==== Public Events ==== | ||
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ===== Public Constructors ===== | ||
| - | ==== WmsHandler() ==== | ||
| - | This is the default constructor for the WmsHandler class. | ||
| - | === Remarks === | ||
| - | This is the default constructor for the WmsHandler class. | ||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ===== Protected Constructors ===== | ||
| - | ===== Public Methods ===== | ||
| - | ==== BeginProcessRequest(HttpContext, AsyncCallback, Object) ==== | ||
| - | Initiates an asynchronous call to the HTTP handler. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | IAsyncResult<!-- System.IAsyncResult --> | A System.IAsyncResult that contains information about the status of the process. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | context | HttpContext<!-- System.Web.HttpContext --> | 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 | AsyncCallback<!-- System.AsyncCallback --> | The System.AsyncCallback to call when the asynchronous method call is complete. If cb is null, the delegate is not called. | | ||
| - | | extraData | Object<!-- System.Object --> | Any extra data needed to process the request. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WmsServerEdition.WmsHandler --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== EndProcessRequest(IAsyncResult) ==== | ||
| - | Provides an asynchronous process End method when the process ends. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | result | IAsyncResult<!-- System.IAsyncResult --> | A System.IAsyncResult that contains information about the status of the process. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WmsServerEdition.WmsHandler --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== Equals(Object) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | obj | Object<!-- System.Object --> | | | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetHashCode() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Int32<!-- System.Int32 --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetType() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Type<!-- System.Type --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== ProcessRequest(HttpContext) ==== | ||
| - | Enables processing of HTTP Web requests by a custom HttpHandler that implements the System.Web.IHttpHandler interface. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | 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.WmsHandler --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== ToString() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ===== Protected Methods ===== | ||
| - | ==== Finalize() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== 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. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | This method returns general information about the service itself and specific information about the available layers. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | getCapabilitiesRequest | [[ThinkGeo.MapSuite.WmsServerEdition.GetCapabilitiesRequest|GetCapabilitiesRequest]]<!-- ThinkGeo.MapSuite.WmsServerEdition.GetCapabilitiesRequest --> | The RequestInfo object corresponding to the QueryString from the client's request. | | ||
| - | | 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.WmsHandler --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== 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 === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | This method returns general information about the service itself and specific information about the available layers. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | getCapabilitiesRequest | [[ThinkGeo.MapSuite.WmsServerEdition.GetCapabilitiesRequest|GetCapabilitiesRequest]]<!-- ThinkGeo.MapSuite.WmsServerEdition.GetCapabilitiesRequest --> | The RequestInfo object corresponding to the QueryString from the client's request. | | ||
| - | | 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.WmsHandler --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== 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 === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | This method returns feature information depending on the request from the client. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | getFeatureInfoRequest | [[ThinkGeo.MapSuite.WmsServerEdition.GetFeatureInfoRequest|GetFeatureInfoRequest]]<!-- ThinkGeo.MapSuite.WmsServerEdition.GetFeatureInfoRequest --> | The RequestInfo object corresponding to the QueryString from the client's request. | | ||
| - | | 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.WmsHandler --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== 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 === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | This method returns feature information depending on the request from the client. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | getFeatureInfoRequest | [[ThinkGeo.MapSuite.WmsServerEdition.GetFeatureInfoRequest|GetFeatureInfoRequest]]<!-- ThinkGeo.MapSuite.WmsServerEdition.GetFeatureInfoRequest --> | The RequestInfo object corresponding to the QueryString from the client's request. | | ||
| - | | 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.WmsHandler --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== 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. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Bitmap<!-- System.Drawing.Bitmap --> | This method returns a pictorial image or a set of graphical elements. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | getMapRequest | [[ThinkGeo.MapSuite.WmsServerEdition.GetMapRequest|GetMapRequest]]<!-- ThinkGeo.MapSuite.WmsServerEdition.GetMapRequest --> | The RequestInfo object corresponding to the QueryString from the client's request. | | ||
| - | | 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.WmsHandler --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== 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 === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Bitmap<!-- System.Drawing.Bitmap --> | This method returns a pictorial image or a set of graphical elements. | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | getMapRequest | [[ThinkGeo.MapSuite.WmsServerEdition.GetMapRequest|GetMapRequest]]<!-- ThinkGeo.MapSuite.WmsServerEdition.GetMapRequest --> | The RequestInfo object corresponding to the QueryString from the client's request. | | ||
| - | | 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.WmsHandler --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== MemberwiseClone() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Object<!-- System.Object --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== ProcessRequestCore(HttpContext) ==== | ||
| - | This abstract method is called from the concrete public method ProcessRequest. This method processes the request from client. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | 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.WmsHandler --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ===== Public Properties ===== | ||
| - | ==== IsReusable ==== | ||
| - | Gets a value indicating whether another request can use the System.Web.IHttpHandler instance. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Boolean<!-- System.Boolean --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WmsServerEdition.WmsHandler --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ===== Protected Properties ===== | ||
| - | ==== CapabilitiesFilePathName ==== | ||
| - | The file path for your capabilites xml document | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | String<!-- System.String --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.WmsServerEdition.WmsHandler --> | ||
| - | [[#Protected Properties|Go Back]] | ||
| - | ===== Public Events ===== | ||
| - | __NOTOC__ | ||
| - | [[Category:WmsServerEdition]] | ||
| - | [[Category:ThinkGeo.MapSuite.WmsServerEdition]] | ||
| - | [[Category:UpdateDocumentation]] | ||
8501 Wade Blvd Ste 550
Frisco, TX 75034
United States
sales@thinkgeo.com
1-785-727-4133
Online Store
- Desktop
WPF
WinForms
- Web
WebAPI HTML5/JavaScript
ASP.NET MVC
WebForms with AJAX
- Mobile
iOS
Android™
World Street
World Imagery
Routing
Geocoding
Reverse Geocoding
Elevation
Quick Start Guides
Documentation
Blogs
Discussion Forums
Customer Portal
About Us
News & Announcemets
Privacy Policy
Copyright 2003-2017 ThinkGeo LLC.
All rights reserved.