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/21 07:44] 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 ==== | ||
| - | ** {{wiki:PublicMethod.gif|}} 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 == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} 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. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} 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. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} 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. | ||
| - | |||
| - | <div newline></div> | ||
| - | ==== Protected Constructors ==== | ||
| - | ==== Public Methods ==== | ||
| - | ** {{wiki:PublicMethod.gif|}} 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 == | ||
| - | * Type:Stream | ||
| - | * Description:This method returns the stream of the GeoImage. | ||
| - | |||
| - | == Parameters == | ||
| - | * //canvas// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetWidth() ** | ||
| - | |||
| - | This method gets the width (in pixels) of this image. | ||
| - | == Remarks == | ||
| - | None. | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Int32 | ||
| - | * Description:This method returns the width (in pixels) of this image. | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetHeight() ** | ||
| - | |||
| - | This method gets the height (in pixels) of this image. | ||
| - | == Remarks == | ||
| - | None. | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Int32 | ||
| - | * Description:This method returns the height (in pixels) of this image. | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} 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 == | ||
| - | * Type:Void | ||
| - | * Description:None | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} 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 == | ||
| - | * Type:Void | ||
| - | * Description:None | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Boolean | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //obj// | ||
| - | * Type:Object | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Int32 | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Type | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ==== Protected Methods ==== | ||
| - | ** {{wiki:ProtectedMethod.gif|}} OnStreamLoading(StreamLoadingEventArgs) ** | ||
| - | |||
| - | This method raises the StreamLoading event, allowing you to specify your own stream. | ||
| - | == Remarks == | ||
| - | None | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //e// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.StreamLoadingEventArgs|StreamLoadingEventArgs]] | ||
| - | * Description:This parameter represents the event arguments for the StreamLoading event. | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} 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 == | ||
| - | * Type:Stream | ||
| - | * Description:This method returns the stream of the GeoImage. | ||
| - | |||
| - | == Parameters == | ||
| - | * //canvas// | ||
| - | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| - | |||
| - | This is the Dispose method for the class. | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Object | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | <div newline></div> | ||
| - | ==== Public Properties ==== | ||
| - | ** {{wiki:PublicProperty.gif|}} 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 == | ||
| - | * Type:String | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} PathName ** | ||
| - | |||
| - | This property returns the path part of the PathFileName. | ||
| - | == Remarks == | ||
| - | None | ||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} FileName ** | ||
| - | |||
| - | This property returns the filename part of the PathFileName. | ||
| - | == Remarks == | ||
| - | None | ||
| - | == Return Value == | ||
| - | * Type:String | ||
| - | |||
| - | ** {{wiki:PublicProperty.gif|}} CanvasImageFormat ** | ||
| - | |||
| - | This property returns the image format. | ||
| - | == Remarks == | ||
| - | None | ||
| - | == Return Value == | ||
| - | * Type:Guid | ||
| - | |||
| - | ==== Protected Properties ==== | ||
| - | ** {{wiki:ProtectedProperty.gif|}} 4UI= ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | == Return Value == | ||
| - | * Type:Object | ||
| - | |||
| - | ==== Public Events ==== | ||
| - | ** {{wiki:PublicEvent.gif|}} 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]] | ||
| - | |||
thinkgeo.mapsuite.core.geoimage.1442821486.txt.gz ยท Last modified: 2015/09/21 07:44 by admin
