thinkgeo.mapsuite.core.geoimage
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
thinkgeo.mapsuite.core.geoimage [2015/09/17 10:29] admin |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.Core.GeoImage ====== | ||
| - | This class represents an image you want to use on the GeoCanvas. | ||
| - | ===== Inheritance Hierarchy ===== | ||
| - | *System.Object | ||
| - | ***ThinkGeo.MapSuite.Core.GeoImage** | ||
| - | ===== Members Summary ===== | ||
| - | === Public Constructors === | ||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#GeoImage()|GeoImage]]** | ||
| - | * **Parameters**:N/A | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:This is the constructor used to create a new GeoImage. | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#GeoImage(String)|GeoImage]]** | ||
| - | * **Parameters**:String | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:This is the constructor to create a new GeoImage | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#GeoImage(Stream)|GeoImage]]** | ||
| - | * **Parameters**:Stream | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:This is the constructor to create a new GeoImage. | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#GeoImage(Int32,Int32)|GeoImage]]** | ||
| - | * **Parameters**:Int32,Int32 | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:This is the constructor to create a new GeoImage | ||
| - | </div> | ||
| - | |||
| - | === Protected Constructors === | ||
| - | === Public Methods === | ||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#Close()|Close]]** | ||
| - | * **Parameters**:N/A | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:This method closes the GeoImage. It is the same as calling the Dispose. | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#Dispose()|Dispose]]** | ||
| - | * **Parameters**:N/A | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:This is the Dispose for the class. | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#Equals(Object)|Equals]]** | ||
| - | * **Parameters**:Object | ||
| - | * **DeclaringType**:Object | ||
| - | * **Summary**:N/A | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#GetHashCode()|GetHashCode]]** | ||
| - | * **Parameters**:N/A | ||
| - | * **DeclaringType**:Object | ||
| - | * **Summary**:N/A | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#GetHeight()|GetHeight]]** | ||
| - | * **Parameters**:N/A | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:This method gets the height (in pixels) of this image. | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#GetImageStream(GeoCanvas)|GetImageStream]]** | ||
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:This method returns the stream of the GeoImage. | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#GetType()|GetType]]** | ||
| - | * **Parameters**:N/A | ||
| - | * **DeclaringType**:Object | ||
| - | * **Summary**:N/A | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#GetWidth()|GetWidth]]** | ||
| - | * **Parameters**:N/A | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:This method gets the width (in pixels) of this image. | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:PublicMethod.gif|}}[[#ToString()|ToString]]** | ||
| - | * **Parameters**:N/A | ||
| - | * **DeclaringType**:Object | ||
| - | * **Summary**:N/A | ||
| - | </div> | ||
| - | |||
| - | === Protected Methods === | ||
| - | <div class_table> | ||
| - | **{{wiki:ProtectedMethod.gif|}}[[#Finalize()|Finalize]]** | ||
| - | * **Parameters**:N/A | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:This is the Dispose method for the class. | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:ProtectedMethod.gif|}}[[#GetImageStreamCore(GeoCanvas)|GetImageStreamCore]]** | ||
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:This method returns the stream of the GeoImage. | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:ProtectedMethod.gif|}}[[#MemberwiseClone()|MemberwiseClone]]** | ||
| - | * **Parameters**:N/A | ||
| - | * **DeclaringType**:Object | ||
| - | * **Summary**:N/A | ||
| - | </div> | ||
| - | |||
| - | <div class_table> | ||
| - | **{{wiki:ProtectedMethod.gif|}}[[#OnStreamLoading(StreamLoadingEventArgs)|OnStreamLoading]]** | ||
| - | * **Parameters**:[[ThinkGeo.MapSuite.Core.StreamLoadingEventArgs|StreamLoadingEventArgs]] | ||
| - | * **DeclaringType**:N/A | ||
| - | * **Summary**:This method raises the StreamLoading event, allowing you to specify your own stream. | ||
| - | </div> | ||
| - | |||
| - | === Public Properties === | ||
| - | **{{wiki:PublicProperty.gif|}}[[#CanvasImageFormat|CanvasImageFormat]]** | ||
| - | * **Return**:Guid | ||
| - | * **Summary**:This property returns the image format. | ||
| - | |||
| - | **{{wiki:PublicProperty.gif|}}[[#FileName|FileName]]** | ||
| - | * **Return**:String | ||
| - | * **Summary**:This property returns the filename part of the PathFileName. | ||
| - | |||
| - | **{{wiki:PublicProperty.gif|}}[[#PathFilename|PathFilename]]** | ||
| - | * **Return**:String | ||
| - | * **Summary**:This property returns the path and filename of the image you want to represent. | ||
| - | |||
| - | **{{wiki:PublicProperty.gif|}}[[#PathName|PathName]]** | ||
| - | * **Return**:String | ||
| - | * **Summary**:This property returns the path part of the PathFileName. | ||
| - | |||
| - | === Protected Properties === | ||
| - | **{{wiki:ProtectedProperty.gif|}}[[#4UI=|4UI=]]** | ||
| - | * **Return**:Object | ||
| - | * **Summary**:N/A | ||
| - | |||
| - | === Public Events === | ||
| - | **{{wiki:PublicEvent.gif|}}[[#StreamLoading|StreamLoading]]** | ||
| - | * **Event Arguments**:[[ThinkGeo.MapSuite.Core.StreamLoadingEventArgs|StreamLoadingEventArgs]] | ||
| - | * **Summary**:This event allows you to pass in your own stream to represent the GeoImage. | ||
| - | |||
| - | ===== Public Constructors ===== | ||
| - | === GeoImage() === | ||
| - | This is the constructor used to create a new GeoImage. | ||
| - | ==== Remarks ==== | ||
| - | You need to set the PathFileName if you intend to use this constructor. | ||
| - | ==== Parameters ==== | ||
| - | [[#Public Constructors|Go Back]] | ||
| - | === GeoImage(String) === | ||
| - | This is the constructor to create a new GeoImage | ||
| - | ==== Remarks ==== | ||
| - | When you specify the path and filename, it should be in the correct format as such; however, the file does not need to exist on the file system. This is to allow us to accept streams supplied by the developer at runtime. If you choose to provide a file that exists, then we will attempt to use it. If we cannot find it, then we will raise the SteamLoading event and allow you to supply the stream. For example, you can pass in "C:\NotARealPath\File1.ecw", which does not exist on the file system. When we raise the event for you to supply a stream, we will pass to you the path and filename so you can differentiate the files. | ||
| - | ==== Parameters ==== | ||
| - | **pathFileName** | ||
| - | * **Type**:String | ||
| - | * **Description:The path and filename of the image file. Note that this need not actually exisit on the file system; see remarks below. | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | === GeoImage(Stream) === | ||
| - | This is the constructor to create a new GeoImage. | ||
| - | ==== Remarks ==== | ||
| - | If you have a stream or an image in TIFF format, you can use this constructor to create a GeoImage from it. | ||
| - | ==== Parameters ==== | ||
| - | **imageStream** | ||
| - | * **Type**:Stream | ||
| - | * **Description:This parameter must be a stream in TIFF format. | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | === GeoImage(Int32,Int32) === | ||
| - | This is the constructor to create a new GeoImage | ||
| - | ==== Remarks ==== | ||
| - | You can use this overload when you want to create a new GeoImage and only want to specify the width and height. You also need to pass in a GeoCanvas that will be used to create the GeoImage. | ||
| - | ==== Parameters ==== | ||
| - | **width** | ||
| - | * **Type**:Int32 | ||
| - | * **Description:This parameter is the width in pixels for the new GeoImage. | ||
| - | |||
| - | **height** | ||
| - | * **Type**:Int32 | ||
| - | * **Description:This parameter is the height in pixels for the new GeoImage. | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ===== Protected Constructors ===== | ||
| - | ===== Public Methods ===== | ||
| - | === Close() === | ||
| - | This method closes the GeoImage. It is the same as calling the Dispose. | ||
| - | ==== Remarks ==== | ||
| - | This method closes the GeoImage. It is the same as calling the Dispose. | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Void | ||
| - | * **Description**:None | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | [[#Public Methods|Go Back]] | ||
| - | === Dispose() === | ||
| - | This is the Dispose for the class. | ||
| - | ==== Remarks ==== | ||
| - | This overload will dispose of the stream in the GeoImage and release its resources. | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Void | ||
| - | * **Description**:None | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | [[#Public Methods|Go Back]] | ||
| - | === Equals(Object) === | ||
| - | N/A | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Boolean | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | **obj** | ||
| - | * **Type**:Object | ||
| - | * **Description**:N/A | ||
| - | |||
| - | [[#Public Methods|Go Back]] | ||
| - | === GetHashCode() === | ||
| - | N/A | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Int32 | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | [[#Public Methods|Go Back]] | ||
| - | === GetHeight() === | ||
| - | This method gets the height (in pixels) of this image. | ||
| - | ==== Remarks ==== | ||
| - | None. | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Int32 | ||
| - | * **Description**:This method returns the height (in pixels) of this image. | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | [[#Public Methods|Go Back]] | ||
| - | === GetImageStream(GeoCanvas) === | ||
| - | This method returns the stream of the GeoImage. | ||
| - | ==== Remarks ==== | ||
| - | This method will raise the event that allows the user to supply their own stream. The event is also raised if they do not attempt to open the file specified in the PathFileName property. | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Stream | ||
| - | * **Description**:This method returns the stream of the GeoImage. | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | **canvas** | ||
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | ||
| - | * **Description**:N/A | ||
| - | |||
| - | [[#Public Methods|Go Back]] | ||
| - | === GetType() === | ||
| - | N/A | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Type | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | [[#Public Methods|Go Back]] | ||
| - | === GetWidth() === | ||
| - | This method gets the width (in pixels) of this image. | ||
| - | ==== Remarks ==== | ||
| - | None. | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Int32 | ||
| - | * **Description**:This method returns the width (in pixels) of this image. | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | [[#Public Methods|Go Back]] | ||
| - | === ToString() === | ||
| - | N/A | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:String | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ===== Protected Methods ===== | ||
| - | === Finalize() === | ||
| - | This is the Dispose method for the class. | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Void | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | === GetImageStreamCore(GeoCanvas) === | ||
| - | This method returns the stream of the GeoImage. | ||
| - | ==== Remarks ==== | ||
| - | This method will raise the event that allows the user to supply their own stream. The event is also raised if they do not attempt to open the file specified in the PathFileName property. | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Stream | ||
| - | * **Description**:This method returns the stream of the GeoImage. | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | **canvas** | ||
| - | * **Type**:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | ||
| - | * **Description**:N/A | ||
| - | |||
| - | [[#Protected Methods|Go Back]] | ||
| - | === MemberwiseClone() === | ||
| - | N/A | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Object | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | === OnStreamLoading(StreamLoadingEventArgs) === | ||
| - | This method raises the StreamLoading event, allowing you to specify your own stream. | ||
| - | ==== Remarks ==== | ||
| - | None | ||
| - | |||
| - | **Return Value** | ||
| - | * **Return Type**:Void | ||
| - | * **Description**:N/A | ||
| - | |||
| - | ==== Parameters ==== | ||
| - | **e** | ||
| - | * **Type**:[[ThinkGeo.MapSuite.Core.StreamLoadingEventArgs|StreamLoadingEventArgs]] | ||
| - | * **Description**:This parameter represents the event arguments for the StreamLoading event. | ||
| - | |||
| - | [[#Protected Methods|Go Back]] | ||
| - | ===== Public Properties ===== | ||
| - | === CanvasImageFormat === | ||
| - | This property returns the image format. | ||
| - | ==== Remarks ==== | ||
| - | None | ||
| - | ==== Return Value ==== | ||
| - | **Return Type**:Guid | ||
| - | |||
| - | [[#Public Properties|Go Back]] | ||
| - | === FileName === | ||
| - | This property returns the filename part of the PathFileName. | ||
| - | ==== Remarks ==== | ||
| - | None | ||
| - | ==== Return Value ==== | ||
| - | **Return Type**:String | ||
| - | |||
| - | [[#Public Properties|Go Back]] | ||
| - | === PathFilename === | ||
| - | This property returns the path and filename of the image you want to represent. | ||
| - | ==== Remarks ==== | ||
| - | When you specify the path and filename, it should be in the correct format as such; however, the file does not need to exist on the file system. This is to allow us to accept streams supplied by the developer at runtime. If you choose to provide a file that exists, then we will attempt to use it. If we cannot find it, then we will raise the SteamLoading event and allow you to supply the stream. For example, you can pass in "C:\NotARealPath\File1.ecw", which does not exist on the file system. When we raise the event for you to supply a stream, we will pass to you the path and filename so you can differentiate the files. | ||
| - | ==== Return Value ==== | ||
| - | **Return Type**:String | ||
| - | |||
| - | [[#Public Properties|Go Back]] | ||
| - | === PathName === | ||
| - | This property returns the path part of the PathFileName. | ||
| - | ==== Remarks ==== | ||
| - | None | ||
| - | ==== Return Value ==== | ||
| - | **Return Type**:String | ||
| - | |||
| - | [[#Public Properties|Go Back]] | ||
| - | ===== Protected Properties ===== | ||
| - | === 4UI= === | ||
| - | N/A | ||
| - | ==== Remarks ==== | ||
| - | N/A | ||
| - | ==== Return Value ==== | ||
| - | **Return Type**:Object | ||
| - | |||
| - | [[#Protected Properties|Go Back]] | ||
| - | ===== Public Events ===== | ||
| - | === StreamLoading === | ||
| - | This event allows you to pass in your own stream to represent the GeoImage. | ||
| - | ==== Remarks ==== | ||
| - | If you choose, you can pass in your own stream to represent the GeoImage. The stream can come from a variety of places, such as isolated storage, a compressed file, or an encrypted stream. When the GeoImage is finished with the stream it will dispose of it, so be sure to keep this in mind when passing the stream in. If you do not pass in an alternate stream, the GeoImage will attempt to load the file from the file system using the PathFileName property. | ||
| - | |||
| - | **Event Arguments**:[[ThinkGeo.MapSuite.Core.StreamLoadingEventArgs|StreamLoadingEventArgs]] | ||
| - | |||
| - | [[#Public Events|Go Back]] | ||
thinkgeo.mapsuite.core.geoimage.1442485793.txt.gz ยท Last modified: 2015/09/17 10:29 by admin
