thinkgeo.mapsuite.portablecore.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.portablecore.geoimage [2015/09/21 08:08] admin |
thinkgeo.mapsuite.portablecore.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 48: | Line 51: | ||
| * Type:Int32 | * Type:Int32 | ||
| * Description:This parameter is the height in pixels for the new GeoImage. | * Description:This parameter is the height in pixels for the new GeoImage. | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} GeoImage(Object) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | == Parameters == | ||
| + | * //nativeImage// | ||
| + | * Type:Object | ||
| + | * Description:N/A | ||
| <div newline></div> | <div newline></div> | ||
| Line 54: | Line 68: | ||
| ** {{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 84: | ||
| ** {{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 96: | ||
| ** {{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 108: | ||
| ** {{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 103: | Line 117: | ||
| == Parameters == | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} Save(Stream) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //stream// | ||
| + | * Type:Stream | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} Save(Stream,GeoImageFormat) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //stream// | ||
| + | * Type:Stream | ||
| + | * Description:N/A | ||
| + | |||
| + | * //geoImageFormat// | ||
| + | * Type:[[ThinkGeo.MapSuite.Portable.GeoImageFormat|GeoImageFormat]] | ||
| + | * Description:N/A | ||
| + | |||
| <div newline></div> | <div newline></div> | ||
| ** {{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 168: | ||
| ** {{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 180: | ||
| ** {{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 196: | ||
| ** {{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 208: | ||
| ** {{wiki:PublicMethod.gif|}} GetType() ** | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 169: | Line 219: | ||
| <div newline></div> | <div newline></div> | ||
| ==== Protected Methods ==== | ==== Protected Methods ==== | ||
| + | ** {{wiki:ProtectedMethod.gif|}} Create(Stream) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Object | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //stream// | ||
| + | * Type:Stream | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} CreateCore(Stream) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Object | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //stream// | ||
| + | * Type:Stream | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} Create(Single,Single) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Object | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //width// | ||
| + | * Type:Single | ||
| + | * Description:N/A | ||
| + | |||
| + | * //height// | ||
| + | * Type:Single | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} CreateCore(Single,Single) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Object | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //width// | ||
| + | * Type:Single | ||
| + | * Description:N/A | ||
| + | |||
| + | * //height// | ||
| + | * Type:Single | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} GetWidth(GeoImage) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Int32 | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //image// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} GetWidthCore(GeoImage) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Int32 | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //image// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} GetHeight(GeoImage) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Int32 | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //image// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} GetHeightCore(GeoImage) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Int32 | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //image// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} SetPixel(GeoImage,Int32,Int32,GeoColor) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //image// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //x// | ||
| + | * Type:Int32 | ||
| + | * Description:N/A | ||
| + | |||
| + | * //y// | ||
| + | * Type:Int32 | ||
| + | * Description:N/A | ||
| + | |||
| + | * //color// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} SetPixelCore(GeoImage,Int32,Int32,GeoColor) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //image// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //x// | ||
| + | * Type:Int32 | ||
| + | * Description:N/A | ||
| + | |||
| + | * //y// | ||
| + | * Type:Int32 | ||
| + | * Description:N/A | ||
| + | |||
| + | * //color// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} Clone(GeoImage) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //image// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} CloneCore(GeoImage) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //image// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} GetPixel(GeoImage,Int32,Int32) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]] | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //image// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //x// | ||
| + | * Type:Int32 | ||
| + | * Description:N/A | ||
| + | |||
| + | * //y// | ||
| + | * Type:Int32 | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} GetPixelCore(GeoImage,Int32,Int32) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]] | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //image// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //j// | ||
| + | * Type:Int32 | ||
| + | * Description:N/A | ||
| + | |||
| + | * //i// | ||
| + | * Type:Int32 | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} Dispose(Object) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //concrete// | ||
| + | * Type:Object | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} DisposeCore(Object) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //concrete// | ||
| + | * Type:Object | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} Save(GeoImage,Stream,ImageCodecInfo,EncoderParameters) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //image// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //stream// | ||
| + | * Type:Stream | ||
| + | * Description:N/A | ||
| + | |||
| + | * //jpegCodecInfo// | ||
| + | * Type:ImageCodecInfo | ||
| + | * Description:N/A | ||
| + | |||
| + | * //encoderParameters// | ||
| + | * Type:EncoderParameters | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} SaveCore(GeoImage,Stream,Guid,Guid,Int64) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //image// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //stream// | ||
| + | * Type:Stream | ||
| + | * Description:N/A | ||
| + | |||
| + | * //jpegCodecInfo// | ||
| + | * Type:Guid | ||
| + | * Description:N/A | ||
| + | |||
| + | * //encoderParameters// | ||
| + | * Type:Guid | ||
| + | * Description:N/A | ||
| + | |||
| + | * //jpegQuality// | ||
| + | * Type:Int64 | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} Save(GeoImage,Stream,GeoImageFormat) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //image// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //stream// | ||
| + | * Type:Stream | ||
| + | * Description:N/A | ||
| + | |||
| + | * //imageFormat// | ||
| + | * Type:[[ThinkGeo.MapSuite.Portable.GeoImageFormat|GeoImageFormat]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} SaveCore(GeoImage,Stream,GeoImageFormat) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //image// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //streamSource// | ||
| + | * Type:Stream | ||
| + | * Description:N/A | ||
| + | |||
| + | * //imageFormat// | ||
| + | * Type:[[ThinkGeo.MapSuite.Portable.GeoImageFormat|GeoImageFormat]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} SetResolution(GeoImage,Single,Single) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //image// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //xDpi// | ||
| + | * Type:Single | ||
| + | * Description:N/A | ||
| + | |||
| + | * //yDpi// | ||
| + | * Type:Single | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} SetResolutionCore(GeoImage,Single,Single) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //image// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //xDpi// | ||
| + | * Type:Single | ||
| + | * Description:N/A | ||
| + | |||
| + | * //yDpi// | ||
| + | * Type:Single | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} Save(GeoImage,String) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //image// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | ||
| + | * Description:N/A | ||
| + | |||
| + | * //filename// | ||
| + | * Type:String | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} GetImageHeight(Stream) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Single | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //imageStream// | ||
| + | * Type:Stream | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} GetImageHeightCore(Stream) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Single | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //imageStream// | ||
| + | * Type:Stream | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} GetImageWidth(Stream) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Single | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //imageStream// | ||
| + | * Type:Stream | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} GetImageWidthCore(Stream) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Single | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //imageStream// | ||
| + | * Type:Stream | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| ** {{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 184: | Line 778: | ||
| * Description:This parameter represents the event arguments for the StreamLoading event. | * Description:This parameter represents the event arguments for the StreamLoading event. | ||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} GetImageStream() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Stream | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| <div newline></div> | <div newline></div> | ||
| ** {{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 198: | Line 804: | ||
| * //canvas// | * //canvas// | ||
| * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} Clone() ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} SetPixel(Int32,Int32,GeoColor) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //x// | ||
| + | * Type:Int32 | ||
| + | * Description:N/A | ||
| + | |||
| + | * //y// | ||
| + | * Type:Int32 | ||
| + | * Description:N/A | ||
| + | |||
| + | * //color// | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} Save(String) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //filename// | ||
| + | * Type:String | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} Save(String,GeoImageFormat) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //filePath// | ||
| + | * Type:String | ||
| + | * Description:N/A | ||
| + | |||
| + | * //fileFormat// | ||
| + | * Type:[[ThinkGeo.MapSuite.Portable.GeoImageFormat|GeoImageFormat]] | ||
| + | * Description:N/A | ||
| + | |||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}} Save(Stream,ImageCodecInfo,EncoderParameters) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:Void | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //stream// | ||
| + | * Type:Stream | ||
| + | * Description:N/A | ||
| + | |||
| + | * //jpegCodecInfo// | ||
| + | * Type:ImageCodecInfo | ||
| + | * Description:N/A | ||
| + | |||
| + | * //encoderParameters// | ||
| + | * Type:EncoderParameters | ||
| * Description:N/A | * Description:N/A | ||
| Line 203: | Line 905: | ||
| ** {{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 917: | ||
| ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 224: | Line 926: | ||
| == Parameters == | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:ProtectedMethod.gif|}}{{wiki:Static.gif|}} FromStream(Stream) ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | |||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]] | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | * //stream// | ||
| + | * Type:Stream | ||
| + | * Description:N/A | ||
| + | |||
| <div newline></div> | <div newline></div> | ||
| ==== Public Properties ==== | ==== Public Properties ==== | ||
| + | ** {{wiki:PublicProperty.gif|}} NativeImage ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | == Return Value == | ||
| + | * Type:Object | ||
| + | |||
| ** {{wiki:PublicProperty.gif|}} PathFilename ** | ** {{wiki:PublicProperty.gif|}} PathFilename ** | ||
| - | This property returns the path and filename of the image you want to represent. | + | * //This property returns the path and filename of the image you want to represent.// |
| == 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.// |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| Line 236: | Line 962: | ||
| ** {{wiki:PublicProperty.gif|}} PathName ** | ** {{wiki:PublicProperty.gif|}} PathName ** | ||
| - | This property returns the path part of the PathFileName. | + | * //This property returns the path part of the PathFileName.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| Line 244: | Line 970: | ||
| ** {{wiki:PublicProperty.gif|}} FileName ** | ** {{wiki:PublicProperty.gif|}} FileName ** | ||
| - | This property returns the filename part of the PathFileName. | + | * //This property returns the filename part of the PathFileName.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| Line 252: | Line 978: | ||
| ** {{wiki:PublicProperty.gif|}} CanvasImageFormat ** | ** {{wiki:PublicProperty.gif|}} CanvasImageFormat ** | ||
| - | This property returns the image format. | + | * //This property returns the image format.// |
| == Remarks == | == Remarks == | ||
| - | None | + | * //None// |
| == Return Value == | == Return Value == | ||
| * Type:Guid | * Type:Guid | ||
| ==== Protected Properties ==== | ==== Protected Properties ==== | ||
| - | ** {{wiki:ProtectedProperty.gif|}} 4UI= ** | + | ** {{wiki:ProtectedProperty.gif|}} Width ** |
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| - | * Type:Object | + | * Type:Int32 |
| + | |||
| + | ** {{wiki:ProtectedProperty.gif|}} Height ** | ||
| + | |||
| + | * //N/A// | ||
| + | == Remarks == | ||
| + | * //N/A// | ||
| + | == Return Value == | ||
| + | * Type:Int32 | ||
| ==== Public Events ==== | ==== Public Events ==== | ||
| ** {{wiki:PublicEvent.gif|}} StreamLoading ** | ** {{wiki:PublicEvent.gif|}} StreamLoading ** | ||
| - | This event allows you to pass in your own stream to represent the GeoImage. | + | * //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. | + | * //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]] | ||
thinkgeo.mapsuite.portablecore.geoimage.1442822937.txt.gz · Last modified: 2015/09/21 08:08 by admin