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/18 05:42] admin |
thinkgeo.mapsuite.core.geoimage [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.Core.GeoImage ====== | ====== ThinkGeo.MapSuite.Core.GeoImage ====== | ||
| + | |||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| + | |||
| This class represents an image you want to use on the GeoCanvas. | This class represents an image you want to use on the GeoCanvas. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| Line 8: | Line 11: | ||
| ** {{wiki:PublicMethod.gif|}} GeoImage() ** | ** {{wiki:PublicMethod.gif|}} GeoImage() ** | ||
| - | This is the constructor used to create a new GeoImage. | + | * //This is the constructor used to create a new GeoImage.// |
| == Remarks == | == Remarks == | ||
| - | You need to set the PathFileName if you intend to use this constructor. | + | * //You need to set the PathFileName if you intend to use this constructor.// |
| == Parameters == | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| ** {{wiki:PublicMethod.gif|}} GeoImage(String) ** | ** {{wiki:PublicMethod.gif|}} GeoImage(String) ** | ||
| - | This is the constructor to create a new GeoImage | + | * //This is the constructor to create a new GeoImage// |
| == Remarks == | == 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. | + | * //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 == | == Parameters == | ||
| * //pathFileName// | * //pathFileName// | ||
| Line 26: | Line 29: | ||
| ** {{wiki:PublicMethod.gif|}} GeoImage(Stream) ** | ** {{wiki:PublicMethod.gif|}} GeoImage(Stream) ** | ||
| - | This is the constructor to create a new GeoImage. | + | * //This is the constructor to create a new GeoImage.// |
| == Remarks == | == Remarks == | ||
| - | If you have a stream or an image in TIFF format, you can use this constructor to create a GeoImage from it. | + | * //If you have a stream or an image in TIFF format, you can use this constructor to create a GeoImage from it.// |
| == Parameters == | == Parameters == | ||
| * //imageStream// | * //imageStream// | ||
| Line 37: | Line 40: | ||
| ** {{wiki:PublicMethod.gif|}} GeoImage(Int32,Int32) ** | ** {{wiki:PublicMethod.gif|}} GeoImage(Int32,Int32) ** | ||
| - | This is the constructor to create a new GeoImage | + | * //This is the constructor to create a new GeoImage// |
| == Remarks == | == 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. | + | * //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 == | == Parameters == | ||
| * //width// | * //width// | ||
| Line 54: | Line 57: | ||
| ** {{wiki:PublicMethod.gif|}} GetImageStream(GeoCanvas) ** | ** {{wiki:PublicMethod.gif|}} GetImageStream(GeoCanvas) ** | ||
| - | This method returns the stream of the GeoImage. | + | * //This method returns the stream of the GeoImage.// |
| == Remarks == | == 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. | + | * //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 == | ||
| Line 70: | Line 73: | ||
| ** {{wiki:PublicMethod.gif|}} GetWidth() ** | ** {{wiki:PublicMethod.gif|}} GetWidth() ** | ||
| - | This method gets the width (in pixels) of this image. | + | * //This method gets the width (in pixels) of this image.// |
| == Remarks == | == Remarks == | ||
| - | None. | + | * //None.// |
| == Return Value == | == Return Value == | ||
| Line 82: | Line 85: | ||
| ** {{wiki:PublicMethod.gif|}} GetHeight() ** | ** {{wiki:PublicMethod.gif|}} GetHeight() ** | ||
| - | This method gets the height (in pixels) of this image. | + | * //This method gets the height (in pixels) of this image.// |
| == Remarks == | == Remarks == | ||
| - | None. | + | * //None.// |
| == Return Value == | == Return Value == | ||
| Line 94: | Line 97: | ||
| ** {{wiki:PublicMethod.gif|}} Close() ** | ** {{wiki:PublicMethod.gif|}} Close() ** | ||
| - | This method closes the GeoImage. It is the same as calling the Dispose. | + | * //This method closes the GeoImage. It is the same as calling the Dispose.// |
| == Remarks == | == Remarks == | ||
| - | This method closes the GeoImage. It is the same as calling the Dispose. | + | * //This method closes the GeoImage. It is the same as calling the Dispose.// |
| == Return Value == | == Return Value == | ||
| Line 106: | Line 109: | ||
| ** {{wiki:PublicMethod.gif|}} Dispose() ** | ** {{wiki:PublicMethod.gif|}} Dispose() ** | ||
| - | This is the Dispose for the class. | + | * //This is the Dispose for the class.// |
| == Remarks == | == Remarks == | ||
| - | This overload will dispose of the stream in the GeoImage and release its resources. | + | * //This overload will dispose of the stream in the GeoImage and release its resources.// |
| == Return Value == | == Return Value == | ||
| Line 118: | Line 121: | ||
| ** {{wiki:PublicMethod.gif|}} ToString() ** | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 130: | Line 133: | ||
| ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 146: | Line 149: | ||
| ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 158: | Line 161: | ||
| ** {{wiki:PublicMethod.gif|}} GetType() ** | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 171: | Line 174: | ||
| ** {{wiki:ProtectedMethod.gif|}} OnStreamLoading(StreamLoadingEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnStreamLoading(StreamLoadingEventArgs) ** | ||
| - | This method raises the StreamLoading event, allowing you to specify your own stream. | + | * //This method raises the StreamLoading event, allowing you to specify your own stream.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Return Value == | == Return Value == | ||
| Line 187: | Line 190: | ||
| ** {{wiki:ProtectedMethod.gif|}} GetImageStreamCore(GeoCanvas) ** | ** {{wiki:ProtectedMethod.gif|}} GetImageStreamCore(GeoCanvas) ** | ||
| - | This method returns the stream of the GeoImage. | + | * //This method returns the stream of the GeoImage.// |
| == Remarks == | == 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. | + | * //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 == | ||
| Line 203: | Line 206: | ||
| ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| - | This is the Dispose method for the class. | + | * //This is the Dispose method for the class.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 215: | Line 218: | ||
| ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 226: | Line 229: | ||
| <div newline></div> | <div newline></div> | ||
| ==== Public Properties ==== | ==== Public Properties ==== | ||
| + | ** {{wiki:PublicProperty.gif|}} Opacity ** | ||
| + | |||
| + | N/A | ||
| + | == Remarks == | ||
| + | N/A | ||
| + | == Return Value == | ||
| + | * Type:Single | ||
| + | |||
| ** {{wiki:PublicProperty.gif|}} PathFilename ** | ** {{wiki:PublicProperty.gif|}} PathFilename ** | ||
| Line 259: | Line 270: | ||
| ==== Protected Properties ==== | ==== Protected Properties ==== | ||
| - | ** {{wiki:ProtectedProperty.gif|}} 4UI= ** | + | ** {{wiki:ProtectedProperty.gif|}} NativeImage ** |
| N/A | N/A | ||
thinkgeo.mapsuite.core.geoimage.1442554964.txt.gz ยท Last modified: 2015/09/18 05:42 by admin