User Tools

Site Tools


thinkgeo.mapsuite.core.geoimage

This is an old revision of the document!


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

GeoImage

  • Parameters:N/A
  • DeclaringType:N/A
  • Summary:This is the constructor used to create a new GeoImage.

GeoImage

  • Parameters:String
  • DeclaringType:N/A
  • Summary:This is the constructor to create a new GeoImage

GeoImage

  • Parameters:Stream
  • DeclaringType:N/A
  • Summary:This is the constructor to create a new GeoImage.

GeoImage

  • Parameters:Int32,Int32
  • DeclaringType:N/A
  • Summary:This is the constructor to create a new GeoImage

Protected Constructors

Public Methods

Close

  • Parameters:N/A
  • DeclaringType:N/A
  • Summary:This method closes the GeoImage. It is the same as calling the Dispose.

Dispose

  • Parameters:N/A
  • DeclaringType:N/A
  • Summary:This is the Dispose for the class.

Equals

  • Parameters:Object
  • DeclaringType:Object
  • Summary:N/A

GetHashCode

  • Parameters:N/A
  • DeclaringType:Object
  • Summary:N/A

GetHeight

  • Parameters:N/A
  • DeclaringType:N/A
  • Summary:This method gets the height (in pixels) of this image.

GetImageStream

  • Parameters:GeoCanvas
  • DeclaringType:N/A
  • Summary:This method returns the stream of the GeoImage.

GetType

  • Parameters:N/A
  • DeclaringType:Object
  • Summary:N/A

GetWidth

  • Parameters:N/A
  • DeclaringType:N/A
  • Summary:This method gets the width (in pixels) of this image.

ToString

  • Parameters:N/A
  • DeclaringType:Object
  • Summary:N/A

Protected Methods

Finalize

  • Parameters:N/A
  • DeclaringType:N/A
  • Summary:This is the Dispose method for the class.

GetImageStreamCore

  • Parameters:GeoCanvas
  • DeclaringType:N/A
  • Summary:This method returns the stream of the GeoImage.

MemberwiseClone

  • Parameters:N/A
  • DeclaringType:Object
  • Summary:N/A

OnStreamLoading

  • DeclaringType:N/A
  • Summary:This method raises the StreamLoading event, allowing you to specify your own stream.

Public Properties

CanvasImageFormat

  • Return:Guid
  • Summary:This property returns the image format.

FileName

  • Return:String
  • Summary:This property returns the filename part of the PathFileName.

PathFilename

  • Return:String
  • Summary:This property returns the path and filename of the image you want to represent.

PathName

  • Return:String
  • Summary:This property returns the path part of the PathFileName.

Protected Properties

4UI=

  • Return:Object
  • Summary:N/A

Public Events

StreamLoading

  • Event Arguments: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

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. 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.

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.

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

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

Equals(Object)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

obj

  • Type:Object
  • Description:N/A

Go Back

GetHashCode()

N/A

Remarks

N/A

Return Value

  • Return Type:Int32
  • Description:N/A

Parameters

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

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

Go Back

GetType()

N/A

Remarks

N/A

Return Value

  • Return Type:Type
  • Description:N/A

Parameters

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

ToString()

N/A

Remarks

N/A

Return Value

  • Return Type:String
  • Description:N/A

Parameters

Protected Methods

Finalize()

This is the Dispose method for the class.

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

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

Go Back

MemberwiseClone()

N/A

Remarks

N/A

Return Value

  • Return Type:Object
  • Description:N/A

Parameters

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

  • Description:This parameter represents the event arguments for the StreamLoading event.

Go Back

Public Properties

CanvasImageFormat

This property returns the image format.

Remarks

None

Return Value

Return Type:Guid

Go Back

FileName

This property returns the filename part of the PathFileName.

Remarks

None

Return Value

Return Type:String

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

Go Back

PathName

This property returns the path part of the PathFileName.

Remarks

None

Return Value

Return Type:String

Go Back

Protected Properties

4UI=

N/A

Remarks

N/A

Return Value

Return Type:Object

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:StreamLoadingEventArgs

Go Back

thinkgeo.mapsuite.core.geoimage.1442485793.txt.gz · Last modified: 2015/09/17 10:29 by admin