Differences

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

--- thinkgeo.mapsuite.core.geoimage [2015/09/17 10:29]
admin
+++ thinkgeo.mapsuite.core.geoimage [2017/03/16 21:59] (current)
@@ Line 1: / Line 1: @@
 ====== ThinkGeo.MapSuite.Core.GeoImage ======
+{{section>upgrade_map_suite_to_10.0}}
 This class represents an image you want to use on the GeoCanvas.
 ===== Inheritance Hierarchy =====
@@ Line 5: / Line 8: @@
     ***ThinkGeo.MapSuite.Core.GeoImage**
 ===== Members Summary =====
-=== Public Constructors ===
+==== Public Constructors ====
-<div class_table>
+** {{wiki:PublicMethod.gif|}} GeoImage() **
-**{{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>
+  * //This is the constructor used to create a new GeoImage.//
-**{{wiki:PublicMethod.gif|}}[[#GeoImage(String)|GeoImage]]**
+== Remarks ==
-  * **Parameters**:String
+  * //You need to set the PathFileName if you intend to use this constructor.//
-  * **DeclaringType**:N/A
+== Parameters ==
-  * **Summary**:This is the constructor to create a new GeoImage
+<div newline></div>
-</div>
+** {{wiki:PublicMethod.gif|}} GeoImage(String) **
-<div class_table>
+  * //This is the constructor to create a new GeoImage//
-**{{wiki:PublicMethod.gif|}}[[#GeoImage(Stream)|GeoImage]]**
+== Remarks ==
-  * **Parameters**:Stream
+  * //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.//
-  * **DeclaringType**:N/A
+== Parameters ==
-  * **Summary**:This is the constructor to create a new GeoImage.
+  * //pathFileName//
-</div>
+    * 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.
-<div class_table>
+<div newline></div>
-**{{wiki:PublicMethod.gif|}}[[#GeoImage(Int32,Int32)|GeoImage]]**
+** {{wiki:PublicMethod.gif|}} GeoImage(Stream) **
-  * **Parameters**:Int32,Int32
-  * **DeclaringType**:N/A
-  * **Summary**:This is the constructor to create a new GeoImage
-</div>
-=== Protected Constructors ===
+  * //This is the constructor to create a new GeoImage.//
-=== Public Methods ===
+== Remarks ==
-<div class_table>
+  * //If you have a stream or an image in TIFF format, you can use this constructor to create a GeoImage from it.//
-**{{wiki:PublicMethod.gif|}}[[#Close()|Close]]**
+== Parameters ==
-  * **Parameters**:N/A
+  * //imageStream//
-  * **DeclaringType**:N/A
+    * Type:Stream
-  * **Summary**:This method closes the GeoImage. It is the same as calling the Dispose.
+    * Description:This parameter must be a stream in TIFF format.
-</div>
-<div class_table>
+<div newline></div>
-**{{wiki:PublicMethod.gif|}}[[#Dispose()|Dispose]]**
+** {{wiki:PublicMethod.gif|}} GeoImage(Int32,Int32) **
-  * **Parameters**:N/A
-  * **DeclaringType**:N/A
-  * **Summary**:This is the Dispose for the class.
-</div>
-<div class_table>
+  * //This is the constructor to create a new GeoImage//
-**{{wiki:PublicMethod.gif|}}[[#Equals(Object)|Equals]]**
+== Remarks ==
-  * **Parameters**:Object
+  * //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.//
-  * **DeclaringType**:Object
+== Parameters ==
-  * **Summary**:N/A
+  * //width//
-</div>
+    * Type:Int32
+    * Description:This parameter is the width in pixels for the new GeoImage.
-<div class_table>
+  * //height//
-**{{wiki:PublicMethod.gif|}}[[#GetHashCode()|GetHashCode]]**
+    * Type:Int32
-  * **Parameters**:N/A
+    * Description:This parameter is the height in pixels for the new GeoImage.
-  * **DeclaringType**:Object
-  * **Summary**:N/A
-</div>
-<div class_table>
+<div newline></div>
-**{{wiki:PublicMethod.gif|}}[[#GetHeight()|GetHeight]]**
+==== Protected Constructors ====
-  * **Parameters**:N/A
+==== Public Methods ====
-  * **DeclaringType**:N/A
+** {{wiki:PublicMethod.gif|}} GetImageStream(GeoCanvas) **
-  * **Summary**:This method gets the height (in pixels) of this image.
-</div>
-<div class_table>
+  * //This method returns the stream of the GeoImage.//
-**{{wiki:PublicMethod.gif|}}[[#GetImageStream(GeoCanvas)|GetImageStream]]**
+== Remarks ==
-  * **Parameters**:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
+  * //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.//
-  * **DeclaringType**:N/A
-  * **Summary**:This method returns the stream of the GeoImage.
-</div>
-<div class_table>
+== Return Value ==
-**{{wiki:PublicMethod.gif|}}[[#GetType()|GetType]]**
+  * Type:Stream
-  * **Parameters**:N/A
+  * Description:This method returns the stream of the GeoImage.
-  * **DeclaringType**:Object
-  * **Summary**:N/A
-</div>
-<div class_table>
+== Parameters ==
-**{{wiki:PublicMethod.gif|}}[[#GetWidth()|GetWidth]]**
+  * //canvas//
-  * **Parameters**:N/A
+    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
-  * **DeclaringType**:N/A
+    * Description:N/A
-  * **Summary**:This method gets the width (in pixels) of this image.
-</div>
-<div class_table>
+<div newline></div>
-**{{wiki:PublicMethod.gif|}}[[#ToString()|ToString]]**
+** {{wiki:PublicMethod.gif|}} GetWidth() **
-  * **Parameters**:N/A
-  * **DeclaringType**:Object
-  * **Summary**:N/A
-</div>
-=== Protected Methods ===
+  * //This method gets the width (in pixels) of this image.//
-<div class_table>
+== Remarks ==
-**{{wiki:ProtectedMethod.gif|}}[[#Finalize()|Finalize]]**
+  * //None.//
-  * **Parameters**:N/A
-  * **DeclaringType**:N/A
-  * **Summary**:This is the Dispose method for the class.
-</div>
-<div class_table>
+== Return Value ==
-**{{wiki:ProtectedMethod.gif|}}[[#GetImageStreamCore(GeoCanvas)|GetImageStreamCore]]**
+  * Type:Int32
-  * **Parameters**:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
+  * Description:This method returns the width (in pixels) of this image.
-  * **DeclaringType**:N/A
-  * **Summary**:This method returns the stream of the GeoImage.
-</div>
-<div class_table>
+== Parameters ==
-**{{wiki:ProtectedMethod.gif|}}[[#MemberwiseClone()|MemberwiseClone]]**
+<div newline></div>
-  * **Parameters**:N/A
+** {{wiki:PublicMethod.gif|}} GetHeight() **
-  * **DeclaringType**:Object
-  * **Summary**:N/A
-</div>
-<div class_table>
+  * //This method gets the height (in pixels) of this image.//
-**{{wiki:ProtectedMethod.gif|}}[[#OnStreamLoading(StreamLoadingEventArgs)|OnStreamLoading]]**
+== Remarks ==
-  * **Parameters**:[[ThinkGeo.MapSuite.Core.StreamLoadingEventArgs|StreamLoadingEventArgs]]
+  * //None.//
-  * **DeclaringType**:N/A
-  * **Summary**:This method raises the StreamLoading event, allowing you to specify your own stream.
-</div>
-=== Public Properties ===
+== Return Value ==
-**{{wiki:PublicProperty.gif|}}[[#CanvasImageFormat|CanvasImageFormat]]**
+  * Type:Int32
-  * **Return**:Guid
+  * Description:This method returns the height (in pixels) of this image.
-  * **Summary**:This property returns the image format.
-**{{wiki:PublicProperty.gif|}}[[#FileName|FileName]]**
+== Parameters ==
-  * **Return**:String
+<div newline></div>
-  * **Summary**:This property returns the filename part of the PathFileName.
+** {{wiki:PublicMethod.gif|}} Close() **
-**{{wiki:PublicProperty.gif|}}[[#PathFilename|PathFilename]]**
+  * //This method closes the GeoImage. It is the same as calling the Dispose.//
-  * **Return**:String
+== Remarks ==
-  * **Summary**:This property returns the path and filename of the image you want to represent.
+  * //This method closes the GeoImage. It is the same as calling the Dispose.//
-**{{wiki:PublicProperty.gif|}}[[#PathName|PathName]]**
+== Return Value ==
-  * **Return**:String
+  * Type:Void
-  * **Summary**:This property returns the path part of the PathFileName.
+  * Description:None
-=== Protected Properties ===
+== Parameters ==
-**{{wiki:ProtectedProperty.gif|}}[[#4UI=|4UI=]]**
+<div newline></div>
-  * **Return**:Object
+** {{wiki:PublicMethod.gif|}} Dispose() **
-  * **Summary**:N/A
-=== Public Events ===
+  * //This is the Dispose for the class.//
-**{{wiki:PublicEvent.gif|}}[[#StreamLoading|StreamLoading]]**
+== Remarks ==
-  * **Event Arguments**:[[ThinkGeo.MapSuite.Core.StreamLoadingEventArgs|StreamLoadingEventArgs]]
+  * //This overload will dispose of the stream in the GeoImage and release its resources.//
-  * **Summary**:This event allows you to pass in your own stream to represent the GeoImage.
-===== Public Constructors =====
+== Return Value ==
-=== GeoImage() ===
+  * Type:Void
-This is the constructor used to create a new GeoImage.
+  * Description:None
-==== 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]]
+== Parameters ==
-=== GeoImage(Stream) ===
+<div newline></div>
-This is the constructor to create a new GeoImage.
+** {{wiki:PublicMethod.gif|}} ToString() **
-==== 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]]
+  * //N/A//
-=== GeoImage(Int32,Int32) ===
+== Remarks ==
-This is the constructor to create a new GeoImage
+  * //N/A//
-==== 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**
+== Return Value ==
-  * **Type**:Int32
+  * Type:String
-  * **Description:This parameter is the height in pixels for the new GeoImage.
+  * Description:N/A
-[[#Public Constructors|Go Back]]
+== Parameters ==
-===== Protected Constructors =====
+<div newline></div>
-===== Public Methods =====
+** {{wiki:PublicMethod.gif|}} Equals(Object) **
-=== 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**
+  * //N/A//
-  * **Return Type**:Void
+== Remarks ==
-  * **Description**:None
+  * //N/A//
-==== Parameters ====
+== Return Value ==
-[[#Public Methods|Go Back]]
+  * Type:Boolean
-=== Dispose() ===
+  * Description:N/A
-This is the Dispose for the class.
-==== Remarks ====
-This overload will dispose of the stream in the GeoImage and release its resources.
-**Return Value**
+== Parameters ==
-  * **Return Type**:Void
+  * //obj//
-  * **Description**:None
+    * Type:Object
+    * Description:N/A
-==== Parameters ====
+<div newline></div>
-[[#Public Methods|Go Back]]
+** {{wiki:PublicMethod.gif|}} GetHashCode() **
-=== Equals(Object) ===
-N/A
-==== Remarks ====
-N/A
-**Return Value**
+  * //N/A//
-  * **Return Type**:Boolean
+== Remarks ==
-  * **Description**:N/A
+  * //N/A//
-==== Parameters ====
+== Return Value ==
-**obj**
+  * Type:Int32
-  * **Type**:Object
+  * Description:N/A
-  * **Description**:N/A
-[[#Public Methods|Go Back]]
+== Parameters ==
-=== GetHashCode() ===
+<div newline></div>
-N/A
+** {{wiki:PublicMethod.gif|}} GetType() **
-==== Remarks ====
-N/A
-**Return Value**
+  * //N/A//
-  * **Return Type**:Int32
+== Remarks ==
-  * **Description**:N/A
+  * //N/A//
-==== Parameters ====
+== Return Value ==
-[[#Public Methods|Go Back]]
+  * Type:Type
-=== GetHeight() ===
+  * Description:N/A
-This method gets the height (in pixels) of this image.
-==== Remarks ====
-None.
-**Return Value**
+== Parameters ==
-  * **Return Type**:Int32
+<div newline></div>
-  * **Description**:This method returns the height (in pixels) of this image.
+==== Protected Methods ====
+** {{wiki:ProtectedMethod.gif|}} OnStreamLoading(StreamLoadingEventArgs) **
-==== Parameters ====
+  * //This method raises the StreamLoading event, allowing you to specify your own stream.//
-[[#Public Methods|Go Back]]
+== Remarks ==
-=== GetImageStream(GeoCanvas) ===
+  * //None//
-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 Value ==
-  * **Return Type**:Stream
+  * Type:Void
-  * **Description**:This method returns the stream of the GeoImage.
+  * Description:N/A
-==== Parameters ====
+== Parameters ==
-**canvas**
+  * //e//
-  * **Type**:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
+    * Type:[[ThinkGeo.MapSuite.Core.StreamLoadingEventArgs|StreamLoadingEventArgs]]
-  * **Description**:N/A
+    * Description:This parameter represents the event arguments for the StreamLoading event.
-[[#Public Methods|Go Back]]
+<div newline></div>
-=== GetType() ===
+** {{wiki:ProtectedMethod.gif|}} GetImageStreamCore(GeoCanvas) **
-N/A
-==== Remarks ====
-N/A
-**Return Value**
+  * //This method returns the stream of the GeoImage.//
-  * **Return Type**:Type
+== Remarks ==
-  * **Description**:N/A
+  * //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.//
-==== Parameters ====
+== Return Value ==
-[[#Public Methods|Go Back]]
+  * Type:Stream
-=== GetWidth() ===
+  * Description:This method returns the stream of the GeoImage.
-This method gets the width (in pixels) of this image.
-==== Remarks ====
-None.
-**Return Value**
+== Parameters ==
-  * **Return Type**:Int32
+  * //canvas//
-  * **Description**:This method returns the width (in pixels) of this image.
+    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
+    * Description:N/A
-==== Parameters ====
+<div newline></div>
-[[#Public Methods|Go Back]]
+** {{wiki:ProtectedMethod.gif|}} Finalize() **
-=== ToString() ===
-N/A
-==== Remarks ====
-N/A
-**Return Value**
+  * //This is the Dispose method for the class.//
-  * **Return Type**:String
+== Remarks ==
-  * **Description**:N/A
+  * //N/A//
-==== Parameters ====
+== Return Value ==
-[[#Public Methods|Go Back]]
+  * Type:Void
-===== Protected Methods =====
+  * Description:N/A
-=== Finalize() ===
-This is the Dispose method for the class.
-==== Remarks ====
-N/A
-**Return Value**
+== Parameters ==
-  * **Return Type**:Void
+<div newline></div>
-  * **Description**:N/A
+** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **
-==== Parameters ====
+  * //N/A//
-[[#Protected Methods|Go Back]]
+== Remarks ==
-=== GetImageStreamCore(GeoCanvas) ===
+  * //N/A//
-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 Value ==
-  * **Return Type**:Stream
+  * Type:Object
-  * **Description**:This method returns the stream of the GeoImage.
+  * Description:N/A
-==== Parameters ====
+== Parameters ==
-**canvas**
+<div newline></div>
-  * **Type**:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
+==== Public Properties ====
-  * **Description**:N/A
+** {{wiki:PublicProperty.gif|}} Opacity **
-[[#Protected Methods|Go Back]]
-=== MemberwiseClone() ===
 N/A
-==== Remarks ====
+== Remarks ==
 N/A
+== Return Value ==
+  * Type:Single
-**Return Value**
+** {{wiki:PublicProperty.gif|}} PathFilename **
-  * **Return Type**:Object
-  * **Description**:N/A
-==== Parameters ====
+This property returns the path and filename of the image you want to represent.
-[[#Protected Methods|Go Back]]
+== Remarks ==
-=== OnStreamLoading(StreamLoadingEventArgs) ===
+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.
-This method raises the StreamLoading event, allowing you to specify your own stream.
+== Return Value ==
-==== Remarks ====
+  * Type:String
-None
-**Return Value**
+** {{wiki:PublicProperty.gif|}} PathName **
-  * **Return Type**:Void
-  * **Description**:N/A
-==== Parameters ====
+This property returns the path part of the PathFileName.
-**e**
+== Remarks ==
-  * **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 Value ==
-**Return Type**:Guid
+  * Type:String
+** {{wiki:PublicProperty.gif|}} FileName **
-[[#Public Properties|Go Back]]
-=== FileName ===
 This property returns the filename part of the PathFileName.
-==== Remarks ====
+== Remarks ==
 None
-==== Return Value ====
+== Return Value ==
-**Return Type**:String
+  * Type:String
-[[#Public Properties|Go Back]]
+** {{wiki:PublicProperty.gif|}} CanvasImageFormat **
-=== 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]]
+This property returns the image format.
-=== PathName ===
+== Remarks ==
-This property returns the path part of the PathFileName.
-==== Remarks ====
 None
-==== Return Value ====
+== Return Value ==
-**Return Type**:String
+  * Type:Guid
+==== Protected Properties ====
+** {{wiki:ProtectedProperty.gif|}} NativeImage **
-[[#Public Properties|Go Back]]
-===== Protected Properties =====
-=== 4UI= ===
 N/A
-==== Remarks ====
+== Remarks ==
 N/A
-==== Return Value ====
+== Return Value ==
-**Return Type**:Object
+  * Type:Object
-[[#Protected Properties|Go Back]]
+==== Public Events ====
-===== Public Events =====
+** {{wiki:PublicEvent.gif|}} StreamLoading **
-=== StreamLoading ===
 This event allows you to pass in your own stream to represent the GeoImage.
-==== Remarks ====
+== 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]]
+Event Arguments:[[ThinkGeo.MapSuite.Core.StreamLoadingEventArgs|StreamLoadingEventArgs]]
-[[#Public Events|Go Back]]

User Tools

Site Tools

Differences

Page Tools