User Tools

Site Tools

Trace:
thinkgeo.mapsuite.core.geoimage

Differences

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

Link to this comparison view

Next revision 		Previous revision
thinkgeo.mapsuite.core.geoimage [2015/08/20 03:08]
127.0.0.1 external edit 		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}}
  
- 
-<!-- Class --> 
 This class represents an image you want to use on the GeoCanvas. This class represents an image you want to use on the GeoCanvas.
-=== Remarks === 
-This class was designed so that it can be used for any type of stream while still being easy to use. For example, you can specify a path and filename in the constructor and the class will hold this. When the GeoCanvas needs the image, it will get its stream and then pass it off for drawing. After drawing, it disposes of the stream so there are no wasted resources. 
- 
-You can also pass in a path and filename that does not actually exist on disk. In that case we will raise an event where you can provide a stream on demand. With this function, you can use compressed streams, isolated storage and many other stream-related storage machanisms. 
 ===== Inheritance Hierarchy ===== ===== Inheritance Hierarchy =====
-*System.Object +  ​*System.Object 
-**[[ThinkGeo.MapSuite.Core.GeoImage]]+    ***ThinkGeo.MapSuite.Core.GeoImage**
 ===== Members Summary ===== ===== Members Summary =====
 ==== Public Constructors ==== ==== Public Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +** {{wiki:​PublicMethod.gif|}} GeoImage() ​**
-| {{wiki:​PublicMethod.gif|Public Method}}[[#GeoImage()|GeoImage]] ​  ​| ​   |    | This is the constructor used to create a new GeoImage. ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​GeoImage(String)|GeoImage]] ​  | String ​  ​| ​   | This is the constructor to create a new GeoImage ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​GeoImage(Stream)|GeoImage]] ​  | Stream ​  ​| ​   | This is the constructor to create a new GeoImage. ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​GeoImage(Int32,​ Int32)|GeoImage]] ​  | Int32, Int32   ​| ​   | This is the constructor to create a new GeoImage ​  |+
  
-==== Protected Constructors ​==== +  * //This is the constructor used to create a new GeoImage.//​ 
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^+== 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 ==== ==== Public Methods ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +** {{wiki:​PublicMethod.gif|}} GetImageStream(GeoCanvas) ​**
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​Close()|Close]] ​  ​| ​   |    | This method closes the GeoImage. It is the same as calling the Dispose. ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​Dispose()|Dispose]] ​  ​| ​   |    | This is the Dispose for the class. ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​Equals(Object)|Equals]] ​  | Object ​  | Object ​  ​| ​   | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​GetHashCode()|GetHashCode]] ​  ​| ​   | Object ​  ​| ​   | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​GetHeight()|GetHeight]] ​  ​| ​   |    | This method gets the height (in pixels) of this image. ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#GetImageStream(GeoCanvas)|GetImageStream]] ​  | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] ​  ​| ​   | This method returns the stream of the GeoImage. ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​GetType()|GetType]] ​  ​| ​   | Object ​  ​| ​   | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​GetWidth()|GetWidth]] ​  ​| ​   |    | This method gets the width (in pixels) of this image. ​  | +
-| {{wiki:​PublicMethod.gif|Public Method}}[[#​ToString()|ToString]] ​  ​| ​   | Object ​  ​| ​   |+
  
-==== Protected Methods ==== +  ​* //This method returns the stream of the GeoImage.// 
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ +== Remarks == 
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​Finalize()|Finalize]] ​  ​| ​   | Object(overriden) ​  | This is the Dispose method for the class. ​  | +  * //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.//
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​GetImageStreamCore(GeoCanvas)|GetImageStreamCore]] ​  | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] ​  ​|    | This method returns the stream of the GeoImage. ​  | +
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​MemberwiseClone()|MemberwiseClone]] ​  ​| ​   | Object ​  ​| ​   | +
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​OnStreamLoading(StreamLoadingEventArgs)|OnStreamLoading]] ​  | [[ThinkGeo.MapSuite.Core.StreamLoadingEventArgs|StreamLoadingEventArgs]] ​  ​| ​   | This method ​raises ​the StreamLoading ​event, allowing you to specify your own stream. ​  |+
  
-==== Public Properties ==== +== Return Value == 
-^ Name ^ Return ^ DeclaringType ^ Summary ^ +  * Type:Stream 
-| {{wiki:PublicProperty.gif|Public Property}}[[#​CanvasImageFormat|CanvasImageFormat]] ​  | Guid   ​| ​   | This property returns the image format. ​  | +  * Description:This method ​returns the stream ​of the GeoImage.
-| {{wiki:PublicProperty.gif|Public Property}}[[#​FileName|FileName]] ​  | String ​  ​| ​   | This property returns the filename part of the PathFileName. ​  | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​PathFilename|PathFilename]] ​  | String ​  ​| ​   | This property returns the path and filename of the image you want to represent. ​  | +
-| {{wiki:​PublicProperty.gif|Public Property}}[[#​PathName|PathName]] ​  | String ​  ​| ​   | This property ​returns the path part of the PathFileName.   |+
  
-==== Protected Properties ==== +== Parameters ​== 
-^ Name ^ Return ^ DeclaringType ^ Summary ^+  * //​canvas//​ 
 +    * Type:​[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] 
 +    * Description:​N/​A
  
-==== Public Events ==== +<div newline></​div>​ 
-^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ +** {{wiki:PublicMethod.gif|}} ​GetWidth() **
-| {{wiki:PublicEvent.gif|Public Event}}[[#​StreamLoading|StreamLoading]] ​  | [[ThinkGeo.MapSuite.Core.StreamLoadingEventArgs|StreamLoadingEventArgs]] ​  ​| ​   | This event allows you to pass in your own stream to represent the GeoImage. ​  |+
  
-===== Public Constructors ===== +  * //This method gets the width (in pixels) of this image.// 
-==== GeoImage() ==== +== Remarks == 
-This is the constructor used to create a new GeoImage. +  * //None.//
-=== Overloads === +
-This constructor allows you to create a drawing ​image without specifying a PathFileName. +
-=== Remarks ​=== +
-You need to set the PathFileName if you intend to use this constructor. +
-=== Parameters === +
-^  Name ^  Type ^  Description ^+
  
-[[#Public Constructors|Go Back]] +== Return Value == 
-==== GeoImage(String) ​==== +  * Type:Int32 
-This is the constructor to create a new GeoImage +  * Description:​This method returns ​the width (in pixels) ​of this image.
-=== Overloads === +
-This constructor allows you to create a drawing image by specifying a PathFileName. +
-=== 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 === +
-^  Name ^  Type ^  Description ^ +
-| pathFileName ​  | String<​!-- System.String --> ​  | 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|}} GetHeight() **
-=== Overloads === +
-This overload allows you to pass in a stream, as long as it is in TIFF format. +
-=== Remarks === +
-If you have a stream or an image in TIFF format, you can use this constructor to create a GeoImage from it. +
-=== Parameters ​=== +
-^  Name ^  Type ^  Description ^ +
-| imageStream ​  | Stream<!-- System.IO.Stream -->   | This parameter must be a stream in TIFF format.   ​|+
  
-[[#Public Constructors|Go Back]] +  * //This method gets the height ​(in pixels) of this image.// 
-==== GeoImage(Int32,​ Int32) ==== +== Remarks == 
-This is the constructor to create a new GeoImage +  ​* //None.//
-=== Overloads === +
-This constructor allows you to create a GeoImage by specifying a width, ​height ​and a GeoCanvas. +
-=== 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 === +
-^  Name ^  Type ^  Description ^ +
-| width   | Int32<​!-- System.Int32 --> ​  | This parameter is the width in pixels for the new GeoImage. ​  | +
-| height ​  | Int32<​!-- System.Int32 --> ​  | This parameter is the height in pixels for the new GeoImage. ​  |+
  
-[[#Public Constructors|Go Back]] +== Return Value == 
-===== Protected Constructors ===== +  * Type:Int32 
-===== Public Methods ===== +  * Description:​This method ​returns ​the height (in pixels) of this image.
-==== 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 ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   |+
  
-=== Parameters === +== Parameters == 
-^  Name ^  Type ^  Description ^+<div newline></​div>​ 
 +** {{wiki:​PublicMethod.gif|}} Close() **
  
-<!-- ThinkGeo.MapSuite.Core.GeoImage --> +  * //This method closes the GeoImage. It is the same as calling ​the Dispose.// 
-[[#Public Methods|Go Back]] +== Remarks ​== 
-==== Dispose() ==== +  * //This method closes ​the GeoImage. ​It is the same as calling ​the Dispose.//
-This is the Dispose for the class. +
-=== Overloads === +
-This overload will dispose of the stream in the GeoImage ​and release its resources. +
-=== Remarks === +
-This overload will dispose of the stream in the GeoImage and release its resources. +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​^  ​Description ​^+  ​* Type:Void 
 +  * Description:None
  
-<!-- ThinkGeo.MapSuite.Core.GeoImage --> +== Parameters ​== 
-[[#Public Methods|Go Back]] +<div newline></​div>​ 
-==== Equals(Object) ​==== +** {{wiki:​PublicMethod.gif|}} Dispose() **
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Boolean<​!-- System.Boolean --> ​  ​| ​   ​|+
  
-=== Parameters === +  * //This is the Dispose for the class.// 
-^  Name ^  Type ^  Description ^ +== Remarks ​== 
-| obj   | Object<​!-- System.Object --> ​  ​| ​   |+  ​* //This overload will dispose of the stream in the GeoImage and release its resources.//
  
-<!-- System.Object --> +== Return Value == 
-[[#Public Methods|Go Back]] +  ​* ​Type:Void 
-==== GetHashCode() ==== +  * Description:None
-=== Return Value === +
-^ Return ​Type ^ Description ​^ +
-| Int32<​!-- System.Int32 --> ​  ​| ​   |+
  
-=== Parameters === +== Parameters == 
-^  Name ^  Type ^  Description ^+<div newline></​div>​ 
 +** {{wiki:​PublicMethod.gif|}} ToString() **
  
-<!-- System.Object --> +  * //N/A// 
-[[#Public Methods|Go Back]] +== Remarks ​== 
-==== GetHeight() ==== +  * //N/A//
-This method gets the height (in pixels) of this image. +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Int32<​!-- System.Int32 --> ​  | This method returns the height (in pixels) of this image. ​  |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​^  ​Description ​^+  ​* Type:String 
 +  * Description:N/A
  
-<!-- ThinkGeo.MapSuite.Core.GeoImage --> +== Parameters ​== 
-[[#Public Methods|Go Back]] +<div newline></​div>​ 
-==== GetImageStream(GeoCanvas) ​==== +** {{wiki:​PublicMethod.gif|}} Equals(Object) **
-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 ^ Description ^ +
-| Stream<!-- System.IO.Stream -->   | This method returns the stream of the GeoImage.   ​|+
  
-=== Parameters === +  * //N/A// 
-^  Name ^  Type ^  Description ^ +== Remarks ​== 
-| canvas ​  | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<​!-- ThinkGeo.MapSuite.Core.GeoCanvas --> ​  ​| ​   |+  ​* //N/A//
  
-<!-- ThinkGeo.MapSuite.Core.GeoImage --> +== Return Value == 
-[[#Public Methods|Go Back]] +  ​* ​Type:Boolean 
-==== GetType() ==== +  * Description:N/A
-=== Return Value === +
-^ Return ​Type ^ Description ​^ +
-| Type<!-- System.Type --> ​  ​| ​   |+
  
-=== Parameters ​=== +== Parameters == 
-^  Name ^  ​Type ​^  ​Description ​^+  ​* //obj// 
 +    * Type:Object 
 +    * Description:N/A
  
-<!-- System.Object --> +<div newline></​div> 
-[[#Public Methods|Go Back]] +** {{wiki:​PublicMethod.gif|}} GetHashCode() **
-==== GetWidth() ==== +
-This method gets the width (in pixels) of this image. +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Int32<​!-- System.Int32 --> ​  | This method returns the width (in pixels) of this image. ​  |+
  
-=== Parameters === +  * //N/A// 
-^  Name ^  Type ^  Description ^+== Remarks ​== 
 +  ​* //N/A//
  
-<!-- ThinkGeo.MapSuite.Core.GeoImage --> +== Return Value == 
-[[#Public Methods|Go Back]] +  ​* ​Type:Int32 
-==== ToString() ==== +  * Description:N/A
-=== Return Value === +
-^ Return ​Type ^ Description ​^ +
-| String<​!-- System.String --> ​  ​| ​   |+
  
-=== Parameters === +== Parameters == 
-^  Name ^  Type ^  Description ^+<div newline></​div>​ 
 +** {{wiki:​PublicMethod.gif|}} GetType() **
  
-<!-- System.Object --> +  * //N/A// 
-[[#Public Methods|Go Back]] +== Remarks ​== 
-===== Protected Methods ===== +  * //N/A//
-==== Finalize() ==== +
-This is the Dispose method for the class. +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   |+
  
-=== Parameters === +== Return Value == 
-^  Name ^  ​Type ​^  ​Description ​^+  ​* Type:Type 
 +  * Description:N/A
  
-<!-- System.Object(overriden) --> +== Parameters ​== 
-[[#​Protected Methods|Go Back]] +<div newline></​div>​ 
-==== GetImageStreamCore(GeoCanvas) ​==== +==== Protected Methods ​==== 
-This method returns the stream of the GeoImage. +** {{wiki:​ProtectedMethod.gif|}} OnStreamLoading(StreamLoadingEventArgs) **
-=== 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 ^ Description ^ +
-| Stream<​!-- System.IO.Stream --> ​  | This method returns the stream of the GeoImage. ​  |+
  
-=== Parameters === +  * //This method raises the StreamLoading event, allowing you to specify your own stream.// 
-^  Name ^  Type ^  Description ^ +== Remarks ​== 
-| canvas ​  | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<​!-- ThinkGeo.MapSuite.Core.GeoCanvas --> ​  ​| ​   |+  ​* //None//
  
-<!-- ThinkGeo.MapSuite.Core.GeoImage --> +== Return Value == 
-[[#​Protected Methods|Go Back]] +  ​* ​Type:Void 
-==== MemberwiseClone() ==== +  * Description:N/A
-=== Return Value === +
-^ Return ​Type ^ Description ​^ +
-| Object<​!-- System.Object --> ​  ​| ​   |+
  
-=== Parameters ​=== +== Parameters == 
-^  Name ^  ​Type ​^  ​Description ​^+  ​* //e// 
 +    * Type:​[[ThinkGeo.MapSuite.Core.StreamLoadingEventArgs|StreamLoadingEventArgs]] 
 +    * Description:This parameter represents the event arguments for the StreamLoading event.
  
-<!-- System.Object --> +<div newline></​div> 
-[[#​Protected Methods|Go Back]] +** {{wiki:​ProtectedMethod.gif|}} GetImageStreamCore(GeoCanvas) **
-==== OnStreamLoading(StreamLoadingEventArgs) ==== +
-This method raises the StreamLoading event, allowing you to specify your own stream. +
-=== Return Value === +
-^ Return Type ^ Description ^ +
-| Void<!-- System.Void --> ​  ​| ​   |+
  
-=== Parameters === +  * //This method returns the stream of the GeoImage.//​ 
-^  Name ^  Type ^  Description ^ +== Remarks ​== 
-| e   | [[ThinkGeo.MapSuite.Core.StreamLoadingEventArgs|StreamLoadingEventArgs]]<​!-- ThinkGeo.MapSuite.Core.StreamLoadingEventArgs --> ​  ​| ​This parameter represents ​the event arguments for the StreamLoading ​event. ​  |+  ​* //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.//
  
-<!-- ThinkGeo.MapSuite.Core.GeoImage --> +== Return Value == 
-[[#​Protected Methods|Go Back]] +  * Type:Stream 
-===== Public Properties ===== +  * Description:​This method ​returns the stream of the GeoImage.
-==== CanvasImageFormat ==== +
-This property ​returns the image format. +
-=== Return Value === +
-^ Return Type ^ +
-| Guid<!-- System.Guid --> ​  |+
  
-<​!-- ​ThinkGeo.MapSuite.Core.GeoImage --> +== Parameters == 
-[[#Public Properties|Go Back]] +  * //​canvas//​ 
-==== FileName ​==== +    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] 
-This property returns the filename part of the PathFileName. +    * Description:​N/​A 
-=== Return Value === + 
-^ Return Type ^ +<div newline></​div>​ 
-| String<​!-- System.String --> ​  |+** {{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|}} Opacity ** 
 + 
 +N/A 
 +== Remarks == 
 +N/A 
 +== Return ​Value == 
 +  * Type:Single 
 + 
 +** {{wiki:​PublicProperty.gif|}} PathFilename **
  
-<!-- ThinkGeo.MapSuite.Core.GeoImage --> 
-[[#Public Properties|Go Back]] 
-==== 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 == 
-^ Return ​Type ^ +  ​* ​Type:String 
-| String<​!-- System.String --> ​  |+ 
 +** {{wiki:​PublicProperty.gif|}} PathName **
  
-<!-- ThinkGeo.MapSuite.Core.GeoImage --> 
-[[#Public Properties|Go Back]] 
-==== PathName ==== 
 This property returns the path part of the PathFileName. This property returns the path part of the PathFileName.
-=== Return Value === +== Remarks == 
-^ Return ​Type ^ +None 
-| String<​!-- System.String ​--> ​  |+== Return Value == 
 +  ​* ​Type:String
  
-<!-- ThinkGeo.MapSuite.Core.GeoImage --> +** {{wiki:​PublicProperty.gif|}} FileName ** 
-[[#Public Properties|Go Back]] + 
-===== Protected Properties ​===== +This property returns the filename part of the PathFileName. 
-===== Public Events ​===== +== Remarks == 
-==== StreamLoading ​====+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|}} NativeImage ** 
 + 
 +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. 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 === 
-^ Event Arguments ^ 
-| [[ThinkGeo.MapSuite.Core.StreamLoadingEventArgs|StreamLoadingEventArgs]]<​!-- ThinkGeo.MapSuite.Core.StreamLoadingEventArgs --> ​  | 
  
-<​!-- ​ThinkGeo.MapSuite.Core.GeoImage --> +Event Arguments:​[[ThinkGeo.MapSuite.Core.StreamLoadingEventArgs|StreamLoadingEventArgs]]
-[[#Public Events|Go Back]]+
  
-__NOTOC__ 
-[[Category:​MapSuiteCore]] 
-[[Category:​ThinkGeo.MapSuite.Core]] 
-[[Category:​UpdateDocumentation]] 
  
thinkgeo.mapsuite.core.geoimage.1440040128.txt.gz · Last modified: 2015/09/17 09:01 (external edit)

Page Tools