====== ThinkGeo.Core.WmsRasterSource ====== ===== Inheritance Hierarchy ===== *System.Object *ThinkGeo.Core.RasterSource ***ThinkGeo.Core.WmsRasterSource** ===== Members Summary ===== ==== Public Constructors ==== ** {{wiki:PublicMethod.gif|}} WmsRasterSource() ** * //This is the constructor for the class. If you use this constructor, then you need to set the required properties manually.// == Remarks == * //None// == Parameters ==
** {{wiki:PublicMethod.gif|}} WmsRasterSource(Uri) ** * //This is the constructor the for the class.// == Remarks == * //This constructor initializes a new WmsRasterSource and downloads and parses the service description. In an ASP.NET application, the service description is automatically cached for 24 hours when it is not specified.// == Parameters == * //uri// * Type:Uri * Description:URI of the WMS server.
** {{wiki:PublicMethod.gif|}} WmsRasterSource(Uri,IWebProxy) ** * //This is the constructor the for the class.// == Remarks == * //This constructor initializes a new WmsRasterSource and downloads and parses the service description In an ASP.NET application, the service description is automatically cached for 24 hours when it is not specified.// == Parameters == * //uri// * Type:Uri * Description:URI of the WMS server. * //proxy// * Type:IWebProxy * Description:Proxy to use for the current WMS layer.
==== Protected Constructors ==== ==== Public Methods ==== ** {{wiki:PublicMethod.gif|}} GetServerLayerNames() ** * //N/A// == Remarks == * //None.// == Return Value == * Type:Collection * Description:The names of all layers at the server side. == Parameters ==
** {{wiki:PublicMethod.gif|}} GetServerStyleNames() ** * //N/A// == Remarks == * //None.// == Return Value == * Type:Collection * Description:The names of all styles at the server side. == Parameters ==
** {{wiki:PublicMethod.gif|}} GetServerOutputFormats() ** * //N/A// == Remarks == * //None.// == Return Value == * Type:Collection * Description:The output format at the server side. == Parameters ==
** {{wiki:PublicMethod.gif|}} GetServerCrss() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Collection * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetServerExceptionFormats() ** * //N/A// == Remarks == * //None.// == Return Value == * Type:Collection * Description:The exception format at the server side. == Parameters ==
** {{wiki:PublicMethod.gif|}} GetServiceVersion() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String * Description:Returns a string reflecting the version of the service in WMS. == Parameters ==
** {{wiki:PublicMethod.gif|}} GetServerFeatureInfoFormats() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Collection * Description:This API returns the FeatureInfo formats supported on the server-side. == Parameters ==
** {{wiki:PublicMethod.gif|}} GetServerCapabilitiesXml() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String * Description:This API returns the GetCapabilites document of the service. == Parameters ==
** {{wiki:PublicMethod.gif|}} GetRequestUrl(RectangleShape,Int32,Int32) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String * Description:The request URL from the client to the WMS. == Parameters == * //worldExtent// * Type:[[ThinkGeo.Core.RectangleShape|RectangleShape]] * Description:The world extent requested by the client to get the map. * //canvasWidth// * Type:Int32 * Description:The returning map width, as well as the drawing view width. * //canvasHeight// * Type:Int32 * Description:The returning map height, as well as the drawing view height.
** {{wiki:PublicMethod.gif|}} GetFeatureInfo(ScreenPointF) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Dictionary> * Description:N/A == Parameters == * //screenPointF// * Type:[[ThinkGeo.Core.ScreenPointF|ScreenPointF]] * Description:N/A
** {{wiki:PublicMethod.gif|}} GetFeatureInfo(ScreenPointF,String) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Dictionary> * Description:N/A == Parameters == * //screenPointF// * Type:[[ThinkGeo.Core.ScreenPointF|ScreenPointF]] * Description:N/A * //infoFormat// * Type:String * Description:N/A
** {{wiki:PublicMethod.gif|}} GetFeatureInfo(ScreenPointF,Int32) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Dictionary> * Description:N/A == Parameters == * //screenPointF// * Type:[[ThinkGeo.Core.ScreenPointF|ScreenPointF]] * Description:N/A * //maxFeatures// * Type:Int32 * Description:N/A
** {{wiki:PublicMethod.gif|}} GetFeatureInfo(ScreenPointF,String,Int32) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Dictionary> * Description:N/A == Parameters == * //screenPointF// * Type:[[ThinkGeo.Core.ScreenPointF|ScreenPointF]] * Description:N/A * //infoFormat// * Type:String * Description:N/A * //maxFeatures// * Type:Int32 * Description:N/A
** {{wiki:PublicMethod.gif|}} CloneDeep() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Core.RasterSource|RasterSource]] * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetWorldFileText() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetImageWidth() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Int32 * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetImageHeight() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Int32 * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetHorizontalResolution() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Single * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetVerticalResolution() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Single * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Core.RectangleShape|RectangleShape]] * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Open() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Close() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetImage(RectangleShape,Int32,Int32) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Core.GeoImage|GeoImage]] * Description:N/A == Parameters == * //worldExtent// * Type:[[ThinkGeo.Core.RectangleShape|RectangleShape]] * Description:N/A * //canvasWidth// * Type:Int32 * Description:N/A * //canvasHeight// * Type:Int32 * Description:N/A
** {{wiki:PublicMethod.gif|}} GetType() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Type * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} ToString() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Equals(Object) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean * Description:N/A == Parameters == * //obj// * Type:Object * Description:N/A
** {{wiki:PublicMethod.gif|}} GetHashCode() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Int32 * Description:N/A == Parameters ==
===== Protected Methods ===== ** {{wiki:ProtectedMethod.gif|}} SendWebRequest(WebRequest) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:WebResponse * Description:N/A == Parameters == * //webRequest// * Type:WebRequest * Description:N/A
** {{wiki:ProtectedMethod.gif|}} SendWebRequestCore(WebRequest) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:WebResponse * Description:N/A == Parameters == * //webRequest// * Type:WebRequest * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnSendingWebRequest(SendingWebRequestEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //e// * Type:[[ThinkGeo.Core.SendingWebRequestEventArgs|SendingWebRequestEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnSentWebRequest(SentWebRequestEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //e// * Type:[[ThinkGeo.Core.SentWebRequestEventArgs|SentWebRequestEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} GetRequestUrlCore(RectangleShape,Int32,Int32) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String * Description:N/A == Parameters == * //worldExtent// * Type:[[ThinkGeo.Core.RectangleShape|RectangleShape]] * Description:N/A * //canvasWidth// * Type:Int32 * Description:N/A * //canvasHeight// * Type:Int32 * Description:N/A
** {{wiki:ProtectedMethod.gif|}} GetImageWidthCore() ** * //N/A// == Remarks == * //This virtual method is called from the concrete method GetImageWidth. It returns the width of the image in screen coordinates.// == Return Value == * Type:Int32 * Description:The width of the image in screen coordinates. == Parameters ==
** {{wiki:ProtectedMethod.gif|}} GetImageHeightCore() ** * //N/A// == Remarks == * //This virtual method is called from the concrete method GetImageHeight. It returns the height of the image in screen coordinates.// == Return Value == * Type:Int32 * Description:The height of the image in screen coordinates. == Parameters ==
** {{wiki:ProtectedMethod.gif|}} OpenCore() ** * //N/A// == Remarks == * //This protected virtual method is called from the concrete public method Open. The Open method plays an important role, as it is responsible for initializing the RasterSource. Most methods on the RasterSource will throw an exception if the state of the RasterSource is not opened. When the map draws each layer, it will open the RasterSource as one of its first steps; then, after it is finished drawing with that layer, it will close it. In this way, we are sure to release all resources used by the RasterSource. When implementing this abstract method, consider opening files for file-based sources, connecting to databases in the database-based sources and so on. You will get a chance to close these in the Close method of the RasterSource.// == Return Value == * Type:Void * Description:None == Parameters ==
** {{wiki:ProtectedMethod.gif|}} CloseCore() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() ** * //N/A// == Remarks == * //This method returns the bounding box of the RasterSource.// == Return Value == * Type:[[ThinkGeo.Core.RectangleShape|RectangleShape]] * Description:The bounding box of the RasterSource. == Parameters ==
** {{wiki:ProtectedMethod.gif|}} GetImageCore(RectangleShape,Int32,Int32) ** * //N/A// == Remarks == * //This method is responsible for returning the image based on the parameters passed in. As the core version of this method is abstract, you will need to override it when creating our own RasterSource.// == Return Value == * Type:[[ThinkGeo.Core.GeoImage|GeoImage]] * Description:This method returns an image based on the worldExtent and image width and height. == Parameters == * //worldExtent// * Type:[[ThinkGeo.Core.RectangleShape|RectangleShape]] * Description:This parameter represents the worldExtent you want to draw. * //canvasWidth// * Type:Int32 * Description:This parameter represents the width of the image you want to draw. * //canvasHeight// * Type:Int32 * Description:This parameter represents the height of the image you want to draw.
** {{wiki:ProtectedMethod.gif|}} BuildWmsGetFeatureInfoUri(ScreenPointF,String,Int32) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Uri * Description:N/A == Parameters == * //screenPointF// * Type:[[ThinkGeo.Core.ScreenPointF|ScreenPointF]] * Description:N/A * //infoFormat// * Type:String * Description:N/A * //maxFeatures// * Type:Int32 * Description:N/A
** {{wiki:ProtectedMethod.gif|}} GetFeatureInfoCore(ScreenPointF,String,Int32) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Dictionary> * Description:N/A == Parameters == * //screenPointF// * Type:[[ThinkGeo.Core.ScreenPointF|ScreenPointF]] * Description:N/A * //infoFormat// * Type:String * Description:N/A * //maxFeatures// * Type:Int32 * Description:N/A
** {{wiki:ProtectedMethod.gif|}} HandleResponse(WebRequest) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Dictionary> * Description:N/A == Parameters == * //reqeust// * Type:WebRequest * Description:N/A
** {{wiki:ProtectedMethod.gif|}} HandleResponseCore(WebRequest) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Dictionary> * Description:N/A == Parameters == * //request// * Type:WebRequest * Description:N/A
** {{wiki:ProtectedMethod.gif|}} HandleXmlInfoFormatResponse(XmlDocument) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Dictionary> * Description:N/A == Parameters == * //xmlDocument// * Type:XmlDocument * Description:N/A
** {{wiki:ProtectedMethod.gif|}} HandleXmlInfoFormatResponseCore(XmlDocument) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Dictionary> * Description:N/A == Parameters == * //xmlDocument// * Type:XmlDocument * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnOpeningRasterSource(OpeningRasterSourceEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //e// * Type:[[ThinkGeo.Core.OpeningRasterSourceEventArgs|OpeningRasterSourceEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnChangedSourceStatus(ChangedSourceStatusEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //e// * Type:[[ThinkGeo.Core.ChangedSourceStatusEventArgs|ChangedSourceStatusEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnOpenedRasterSource(OpenedRasterSourceEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //e// * Type:[[ThinkGeo.Core.OpenedRasterSourceEventArgs|OpenedRasterSourceEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnClosingRasterSource(ClosingRasterSourceEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //e// * Type:[[ThinkGeo.Core.ClosingRasterSourceEventArgs|ClosingRasterSourceEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnClosedRasterSource(ClosedRasterSourceEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //e// * Type:[[ThinkGeo.Core.ClosedRasterSourceEventArgs|ClosedRasterSourceEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Core.RasterSource|RasterSource]] * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} GetWrappingImageLeft(RectangleShape,Double,Double,RectangleShape) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Core.GeoImage|GeoImage]] * Description:N/A == Parameters == * //boundingBox// * Type:[[ThinkGeo.Core.RectangleShape|RectangleShape]] * Description:N/A * //screenWidth// * Type:Double * Description:N/A * //screenHeight// * Type:Double * Description:N/A * //wrappingExtent// * Type:[[ThinkGeo.Core.RectangleShape|RectangleShape]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} GetWrappingImageRight(RectangleShape,Double,Double,RectangleShape) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Core.GeoImage|GeoImage]] * Description:N/A == Parameters == * //boundingBox// * Type:[[ThinkGeo.Core.RectangleShape|RectangleShape]] * Description:N/A * //screenWidth// * Type:Double * Description:N/A * //screenHeight// * Type:Double * Description:N/A * //wrappingExtent// * Type:[[ThinkGeo.Core.RectangleShape|RectangleShape]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Object * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} Finalize() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
==== Public Properties ==== ** {{wiki:PublicProperty.gif|}} ActiveLayerNames ** * //N/A// == Remarks == * //When requesting a map, a client may specify the layers to be shown on the map.// == Return Value == * Type:Collection ** {{wiki:PublicProperty.gif|}} ActiveStyleNames ** * //N/A// == Remarks == * //When requesting a map, a client may specify the styles to be shown on the map.// == Return Value == * Type:Collection ** {{wiki:PublicProperty.gif|}} Uri ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Uri ** {{wiki:PublicProperty.gif|}} IsTransparent ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean ** {{wiki:PublicProperty.gif|}} OutputFormat ** * //N/A// == Remarks == * //When requesting a map, a client may specify the output format in which to show the map. Formats are specified as MIME types such as "image/gif" or "image/png".// == Return Value == * Type:String ** {{wiki:PublicProperty.gif|}} Proxy ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:IWebProxy ** {{wiki:PublicProperty.gif|}} TimeoutInSecond ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Int32 ** {{wiki:PublicProperty.gif|}} Crs ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String ** {{wiki:PublicProperty.gif|}} Credentials ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:ICredentials ** {{wiki:PublicProperty.gif|}} Exceptions ** * //N/A// == Remarks == * //Upon receiving a request that is invalid according to the OGC standard, the server shall issue a service exception report. The service report is meant to describe to the client application or its human user the reason(s) that the request is invalid.// == Return Value == * Type:String ** {{wiki:PublicProperty.gif|}} Parameters ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Dictionary ** {{wiki:PublicProperty.gif|}} AxisOrder ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Core.WmsAxisOrder|WmsAxisOrder]] ** {{wiki:PublicProperty.gif|}} CapabilitesCacheTimeout ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:TimeSpan ** {{wiki:PublicProperty.gif|}} ProjectionConverter ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Core.ProjectionConverter|ProjectionConverter]] ** {{wiki:PublicProperty.gif|}} Projection ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Core.Projection|Projection]] ** {{wiki:PublicProperty.gif|}} Transparency ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Single ** {{wiki:PublicProperty.gif|}} BlueTranslation ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Single ** {{wiki:PublicProperty.gif|}} RedTranslation ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Single ** {{wiki:PublicProperty.gif|}} GreenTranslation ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Single ** {{wiki:PublicProperty.gif|}} IsNegative ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean ** {{wiki:PublicProperty.gif|}} IsGrayscale ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean ** {{wiki:PublicProperty.gif|}} ScaleFactor ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Double ** {{wiki:PublicProperty.gif|}} IsOpen ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean ==== Protected Properties ==== ==== Public Events ==== ** {{wiki:PublicEvent.gif|}} SendingWebRequest ** * //N/A// == Remarks == * //This event is called before sending the reqeust for raster image. It is typical that user want to get the url of reqeust and modify it according to their requirements. For example, user could create a signiture for it, and verify it on the server side.// Event Arguments:[[ThinkGeo.Core.SendingWebRequestEventArgs|SendingWebRequestEventArgs]] ** {{wiki:PublicEvent.gif|}} SentWebRequest ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.Core.SentWebRequestEventArgs|SentWebRequestEventArgs]] ** {{wiki:PublicEvent.gif|}} OpeningRasterSource ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.Core.OpeningRasterSourceEventArgs|OpeningRasterSourceEventArgs]] ** {{wiki:PublicEvent.gif|}} OpenedRasterSource ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.Core.OpenedRasterSourceEventArgs|OpenedRasterSourceEventArgs]] ** {{wiki:PublicEvent.gif|}} ClosingRasterSource ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.Core.ClosingRasterSourceEventArgs|ClosingRasterSourceEventArgs]] ** {{wiki:PublicEvent.gif|}} ClosedRasterSource ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.Core.ClosedRasterSourceEventArgs|ClosedRasterSourceEventArgs]]