ThinkGeo Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== ThinkGeo.MapSuite.Core.KmlRasterSource ======



<!-- Class -->
===== Inheritance Hierarchy =====
*System.Object
**[[ThinkGeo.MapSuite.Core.RasterSource]]
***[[ThinkGeo.MapSuite.Core.KmlRasterSource]]
===== Members Summary =====
==== Public Constructors ====
^ Name ^ Parameters ^ DeclaringType ^ Summary ^
| {{wiki:PublicMethod.gif|Public Method}}[[#KmlRasterSource()|KmlRasterSource]]   |    |    |    |
| {{wiki:PublicMethod.gif|Public Method}}[[#KmlRasterSource(String)|KmlRasterSource]]   | String   |    |    |

==== Protected Constructors ====
^ Name ^ Parameters ^ DeclaringType ^ Summary ^

==== Public Methods ====
^ Name ^ Parameters ^ DeclaringType ^ Summary ^
| {{wiki:PublicMethod.gif|Public Method}}[[#CloneDeep()|CloneDeep]]   |    | [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]]   | Create a copy of RasterSource using the deep clone process.   |
| {{wiki:PublicMethod.gif|Public Method}}[[#Close()|Close]]   |    | [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]]   | This method closes the RasterSource and releases any resources it was using.   |
| {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]]   | Object   | Object   |    |
| {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#GenerateWorldFileText(RectangleShape, Int32, Int32)|GenerateWorldFileText]]   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]], Int32, Int32   | [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]]   | This method returns a string that represents the image's world file based on the parameters passed in.   |
| {{wiki:PublicMethod.gif|Public Method}}[[#GetBoundingBox()|GetBoundingBox]]   |    | [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]]   | This method returns the bounding box of the RasterSource.   |
| {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]]   |    | Object   |    |
| {{wiki:PublicMethod.gif|Public Method}}[[#GetHorizontalResolution()|GetHorizontalResolution]]   |    | [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]]   | This method returns the horizontal resolution of the image.   |
| {{wiki:PublicMethod.gif|Public Method}}[[#GetImage(RectangleShape, Int32, Int32)|GetImage]]   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]], Int32, Int32   | [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]]   | This method returns an image based on the worldExtent and image width and height.   |
| {{wiki:PublicMethod.gif|Public Method}}[[#GetImageHeight()|GetImageHeight]]   |    | [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]]   | This method returns the height of the image in screen coordinates.   |
| {{wiki:PublicMethod.gif|Public Method}}[[#GetImageWidth()|GetImageWidth]]   |    | [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]]   | This method returns the width of the image in screen coordinates.   |
| {{wiki:PublicMethod.gif|Public Method}}[[#GetProjectionText()|GetProjectionText]]   |    | [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]]   | This method returns the projection text in proj4 format.   |
| {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]]   |    | Object   |    |
| {{wiki:PublicMethod.gif|Public Method}}[[#GetVerticalResolution()|GetVerticalResolution]]   |    | [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]]   | This method returns the vertical resolution of the image.   |
| {{wiki:PublicMethod.gif|Public Method}}[[#GetWorldFileText()|GetWorldFileText]]   |    | [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]]   | This method returns a string that represents the image's world file.   |
| {{wiki:PublicMethod.gif|Public Method}}[[#Open()|Open]]   |    | [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]]   | This method opens the RasterSource so that it is initialized and ready to use.   |
| {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]]   |    | Object   |    |

==== Protected Methods ====
^ Name ^ Parameters ^ DeclaringType ^ Summary ^
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#CloneDeepCore()|CloneDeepCore]]   |    | [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]]   | Create a copy of RasterSource using the deep clone process. The default implementation uses serialization.   |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#CloseCore()|CloseCore]]   |    | [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]](overriden)   |    |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]]   |    | Object   |    |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetBoundingBoxCore()|GetBoundingBoxCore]]   |    | [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]](overriden)   |    |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetImageCore(RectangleShape, Int32, Int32)|GetImageCore]]   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]], Int32, Int32   | [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]](overriden)   |    |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetImageHeightCore()|GetImageHeightCore]]   |    | [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]](overriden)   |    |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetImageWidthCore()|GetImageWidthCore]]   |    | [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]](overriden)   |    |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetProjectionTextCore()|GetProjectionTextCore]]   |    | [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]]   | This method returns the projection text in proj4 format.   |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]]   |    | Object   |    |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnClosedRasterSource(ClosedRasterSourceEventArgs)|OnClosedRasterSource]]   | [[ThinkGeo.MapSuite.Core.ClosedRasterSourceEventArgs|ClosedRasterSourceEventArgs]]   | [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]]   | This method allows you to raise the ClosedRasterSource event from a derived class.   |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnClosingRasterSource(ClosingRasterSourceEventArgs)|OnClosingRasterSource]]   | [[ThinkGeo.MapSuite.Core.ClosingRasterSourceEventArgs|ClosingRasterSourceEventArgs]]   | [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]]   | This method allows you to raise the ClosingRasterSource event from a derived class.   |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnOpenedRasterSource(OpenedRasterSourceEventArgs)|OnOpenedRasterSource]]   | [[ThinkGeo.MapSuite.Core.OpenedRasterSourceEventArgs|OpenedRasterSourceEventArgs]]   | [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]]   | This method allows you to raise the OpenedRasterSource event from a derived class.   |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnOpeningRasterSource(OpeningRasterSourceEventArgs)|OnOpeningRasterSource]]   | [[ThinkGeo.MapSuite.Core.OpeningRasterSourceEventArgs|OpeningRasterSourceEventArgs]]   | [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]]   | This method allows you to raise the OpeningRasterSource event from a derived class.   |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#OpenCore()|OpenCore]]   |    | [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]](overriden)   |    |

==== Public Properties ====
^ Name ^ Return ^ DeclaringType ^ Summary ^
| {{wiki:PublicProperty.gif|Public Property}}[[#BlueTranslation|BlueTranslation]]   | Single   | [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]]   | This property gets and sets the amount of blue to apply to the image.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#GreenTranslation|GreenTranslation]]   | Single   | [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]]   | This property gets and sets the amount of green to apply to the image.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#HasProjectionText|HasProjectionText]]   | Boolean   | [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]]   | This property returns true if the RasterSource has projection text, false if not.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#IsGrayscale|IsGrayscale]]   | Boolean   | [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]]   | This property gets and sets if the image should be converted to grayscale.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#IsNegative|IsNegative]]   | Boolean   | [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]]   | This property gets and sets whether the image should be converted to negative (inverse colors).   |
| {{wiki:PublicProperty.gif|Public Property}}[[#IsOpen|IsOpen]]   | Boolean   | [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]]   | This property returns true if the RasterSource is open and false if it is not.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#KmlPathFilename|KmlPathFilename]]   | String   |    |    |
| {{wiki:PublicProperty.gif|Public Property}}[[#Projection|Projection]]   | [[ThinkGeo.MapSuite.Core.Projection|Projection]]   | [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]]   |    |
| {{wiki:PublicProperty.gif|Public Property}}[[#RedTranslation|RedTranslation]]   | Single   | [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]]   | This property gets and sets the amount of red to apply to the image.   |
| {{wiki:PublicProperty.gif|Public Property}}[[#Transparency|Transparency]]   | Single   | [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]]   | This property gets and sets the amount of transparency to apply to the image.   |

==== Protected Properties ====
^ Name ^ Return ^ DeclaringType ^ Summary ^
| {{wiki:ProtectedProperty.gif|Protected Property}}[[#HasProjectionTextCore|HasProjectionTextCore]]   | Boolean   | [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]]   | This property returns true if the RasterSource has projection text, false if not.   |

==== Public Events ====
^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^
| {{wiki:PublicEvent.gif|Public Event}}[[#ClosedRasterSource|ClosedRasterSource]]   | [[ThinkGeo.MapSuite.Core.ClosedRasterSourceEventArgs|ClosedRasterSourceEventArgs]]   | [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]]   | This event is called after the closing of the RasterSource.   |
| {{wiki:PublicEvent.gif|Public Event}}[[#ClosingRasterSource|ClosingRasterSource]]   | [[ThinkGeo.MapSuite.Core.ClosingRasterSourceEventArgs|ClosingRasterSourceEventArgs]]   | [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]]   | This event is called before the closing of the RasterSource.   |
| {{wiki:PublicEvent.gif|Public Event}}[[#OpenedRasterSource|OpenedRasterSource]]   | [[ThinkGeo.MapSuite.Core.OpenedRasterSourceEventArgs|OpenedRasterSourceEventArgs]]   | [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]]   | This event is called after the opening of the RasterSource.   |
| {{wiki:PublicEvent.gif|Public Event}}[[#OpeningRasterSource|OpeningRasterSource]]   | [[ThinkGeo.MapSuite.Core.OpeningRasterSourceEventArgs|OpeningRasterSourceEventArgs]]   | [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]]   | This event is called before the opening of the RasterSource.   |
| {{wiki:PublicEvent.gif|Public Event}}[[#StreamLoading|StreamLoading]]   | [[ThinkGeo.MapSuite.Core.StreamLoadingEventArgs|StreamLoadingEventArgs]]   |    |    |

===== Public Constructors =====
==== KmlRasterSource() ====
=== Parameters ===
^  Name ^  Type ^  Description ^

[[#Public Constructors|Go Back]]
==== KmlRasterSource(String) ====
=== Parameters ===
^  Name ^  Type ^  Description ^
| kmlPathFilename   | String<!-- System.String -->   |    |

[[#Public Constructors|Go Back]]
===== Protected Constructors =====
===== Public Methods =====
==== CloneDeep() ====
Create a copy of RasterSource using the deep clone process.
=== Remarks ===
The difference between deep clone and shallow clone is: when shallow cloned, only the object is copied, but the contained objects are not; while in deep clone it does copy the cloned object as well as all the objects within.
=== Return Value ===
^ Return Type ^ Description ^
| [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]]<!-- ThinkGeo.MapSuite.Core.RasterSource -->   | A cloned RasterSource.   |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.Core.RasterSource -->
[[#Public Methods|Go Back]]
==== Close() ====
This method closes the RasterSource and releases any resources it was using.
=== Remarks ===
This method is the concrete wrapper for the abstract method CloseCore. The Close method plays an important role in the life cycle of the RasterSource. It may be called after drawing to release any memory and other resources that were allocated since the Open method was called.

If you override the Core version of this method, it is recommended that you take the following things into account: This method may be called multiple times, so we suggest you write the method so that that a call to a closed RasterSource is ignored and does not generate an error. We also suggest that in the Close you free all resources that have been opened. Remember that the object will not be destroyed, but will be re-opened possibly in the near future.

As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.Core.RasterSource -->
[[#Public Methods|Go Back]]
==== Equals(Object) ====
=== Return Value ===
^ Return Type ^ Description ^
| Boolean<!-- System.Boolean -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| obj   | Object<!-- System.Object -->   |    |

<!-- System.Object -->
[[#Public Methods|Go Back]]
==== GenerateWorldFileText(RectangleShape, Int32, Int32) ====
<!-- static -->
This method returns a string that represents the image's world file based on the parameters passed in.
=== Remarks ===
This method returns a string that represents the image's world file. The world file is a file type that can accompany image files. It contains information about the image's position, resolution and other spatial-related items. It is common to have this kind of file associated with generic image types such as JPG, BMP, and normal TIFF because they do not have a mechanism to store this data internally. Modern GIS image types such as JPEG2000, ECW, and MrSid typically have this information stored internally. We provide this method in the event that you want to create your own world file from any image that either already has one or has its data stored internally.
=== Return Value ===
^ Return Type ^ Description ^
| String<!-- System.String -->   | This method returns a string that represents the image's world file based on the parameters passed in.   |

=== Parameters ===
^  Name ^  Type ^  Description ^
| worldExtent   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape -->   | This parameter represents the worldExtent of the image in world coordinates.   |
| imageWidth   | Int32<!-- System.Int32 -->   | This parameter is the width of the image in screen coordinates.   |
| imageHeight   | Int32<!-- System.Int32 -->   | This parameter is the height of the image in screen coordinates.   |

<!-- ThinkGeo.MapSuite.Core.RasterSource -->
[[#Public Methods|Go Back]]
==== GetBoundingBox() ====
This method returns the bounding box of the RasterSource.
=== Remarks ===
This method returns the bounding box of the RasterSource.

As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.
=== Return Value ===
^ Return Type ^ Description ^
| [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape -->   | This method returns the bounding box of the RasterSource.   |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.Core.RasterSource -->
[[#Public Methods|Go Back]]
==== GetHashCode() ====
=== Return Value ===
^ Return Type ^ Description ^
| Int32<!-- System.Int32 -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- System.Object -->
[[#Public Methods|Go Back]]
==== GetHorizontalResolution() ====
This method returns the horizontal resolution of the image.
=== Remarks ===
This method returns the horizontal resolution of the image.

As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.
=== Return Value ===
^ Return Type ^ Description ^
| Single<!-- System.Single -->   | This method returns the horizontal resolution of the image.   |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.Core.RasterSource -->
[[#Public Methods|Go Back]]
==== GetImage(RectangleShape, Int32, Int32) ====
This method returns an image based on the worldExtent and image width and height.
=== Remarks ===
This method is responsible for returning the image based on the parameters passed in. As the core version of this method is abstract, you will need to override it when creating your own RasterSource.

As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.
=== Return Value ===
^ Return Type ^ Description ^
| [[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]]<!-- ThinkGeo.MapSuite.Core.GeoImage -->   | This method returns an image based on the worldExtent and image width and height.   |

=== Parameters ===
^  Name ^  Type ^  Description ^
| worldExtent   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape -->   | This parameter represents the worldExtent you want to draw.   |
| canvasWidth   | Int32<!-- System.Int32 -->   | This parameter represents the width of the image you want to draw.   |
| canvasHeight   | Int32<!-- System.Int32 -->   | This parameter represents the height of the image you want to draw.   |

<!-- ThinkGeo.MapSuite.Core.RasterSource -->
[[#Public Methods|Go Back]]
==== GetImageHeight() ====
This method returns the height of the image in screen coordinates.
=== Remarks ===
This method returns the height of the image in screen coordinates.

As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.
=== Return Value ===
^ Return Type ^ Description ^
| Int32<!-- System.Int32 -->   | This method returns the height of the image in screen coordinates.   |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.Core.RasterSource -->
[[#Public Methods|Go Back]]
==== GetImageWidth() ====
This method returns the width of the image in screen coordinates.
=== Remarks ===
This method returns the width of the image in screen coordinates.

As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.
=== Return Value ===
^ Return Type ^ Description ^
| Int32<!-- System.Int32 -->   | This method returns the width of the image in screen coordinates.   |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.Core.RasterSource -->
[[#Public Methods|Go Back]]
==== GetProjectionText() ====
This method returns the projection text in proj4 format.
=== Return Value ===
^ Return Type ^ Description ^
| String<!-- System.String -->   | This method returns the projection text in proj4 format.   |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.Core.RasterSource -->
[[#Public Methods|Go Back]]
==== GetType() ====
=== Return Value ===
^ Return Type ^ Description ^
| Type<!-- System.Type -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- System.Object -->
[[#Public Methods|Go Back]]
==== GetVerticalResolution() ====
This method returns the vertical resolution of the image.
=== Remarks ===
This method returns the vertical resolution of the image.

As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.
=== Return Value ===
^ Return Type ^ Description ^
| Single<!-- System.Single -->   | This method returns the vertical resolution of the image.   |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.Core.RasterSource -->
[[#Public Methods|Go Back]]
==== GetWorldFileText() ====
This method returns a string that represents the image's world file.
=== Remarks ===
This method wraps the Core version of this method and returns a string that represents the image's world file. The world file is a file type that can accompany image files. It contains information about the image's position, resolution and other spatial-related items. It is common to have this kind of file associated with generic image types such as JPG, BMP, and normal TIFF because they do not have a mechanism to store this data internally. Modern GIS image types such as JPEG2000, ECW, and MrSid typically have this information stored internally. We provide this method in the event that you want to create your own world file from any image that either already has one or has its data stored internally.

As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.
=== Return Value ===
^ Return Type ^ Description ^
| String<!-- System.String -->   | This method returns a string that represents the image's world file.   |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.Core.RasterSource -->
[[#Public Methods|Go Back]]
==== Open() ====
This method opens the RasterSource so that it is initialized and ready to use.
=== Remarks ===
This method is the concrete wrapper for the abstract method OpenCore. The Open method plays an important role, as it is responsible for initializing the RasterSource. Most methods on the RasterSource will throw an exception if the state of the RasterSource is not opened. When the map draws each layer, it will open the RasterSource as one of its first steps; then, after it is finished drawing with that layer, it will close it. In this way, we are sure to release all resources used by the RasterSource.

When implementing the abstract method, consider opening files for file-based sources, connecting to databases in the database-based sources and so on. You will get a chance to close these in the Close method of the RasterSource. 		
As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.Core.RasterSource -->
[[#Public Methods|Go Back]]
==== ToString() ====
=== Return Value ===
^ Return Type ^ Description ^
| String<!-- System.String -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- System.Object -->
[[#Public Methods|Go Back]]
===== Protected Methods =====
==== CloneDeepCore() ====
Create a copy of RasterSource using the deep clone process. The default implementation uses serialization.
=== Remarks ===
The difference between deep clone and shallow clone is: when shallow cloned, only the object is copied, but the contained objects are not; while in deep clone it does copy the cloned object as well as all the objects within.
=== Return Value ===
^ Return Type ^ Description ^
| [[ThinkGeo.MapSuite.Core.RasterSource|RasterSource]]<!-- ThinkGeo.MapSuite.Core.RasterSource -->   | A cloned RasterSource.   |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.Core.RasterSource -->
[[#Protected Methods|Go Back]]
==== CloseCore() ====
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.Core.RasterSource(overriden) -->
[[#Protected Methods|Go Back]]
==== Finalize() ====
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- System.Object -->
[[#Protected Methods|Go Back]]
==== GetBoundingBoxCore() ====
=== Return Value ===
^ Return Type ^ Description ^
| [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.Core.RasterSource(overriden) -->
[[#Protected Methods|Go Back]]
==== GetImageCore(RectangleShape, Int32, Int32) ====
=== Return Value ===
^ Return Type ^ Description ^
| [[ThinkGeo.MapSuite.Core.GeoImage|GeoImage]]<!-- ThinkGeo.MapSuite.Core.GeoImage -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| worldExtent   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape -->   |    |
| canvasWidth   | Int32<!-- System.Int32 -->   |    |
| canvasHeight   | Int32<!-- System.Int32 -->   |    |

<!-- ThinkGeo.MapSuite.Core.RasterSource(overriden) -->
[[#Protected Methods|Go Back]]
==== GetImageHeightCore() ====
=== Return Value ===
^ Return Type ^ Description ^
| Int32<!-- System.Int32 -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.Core.RasterSource(overriden) -->
[[#Protected Methods|Go Back]]
==== GetImageWidthCore() ====
=== Return Value ===
^ Return Type ^ Description ^
| Int32<!-- System.Int32 -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.Core.RasterSource(overriden) -->
[[#Protected Methods|Go Back]]
==== GetProjectionTextCore() ====
This method returns the projection text in proj4 format.
=== Remarks ===
This protected virtual method is called from the concrete public method GetProjectionText.

The default implementation of this core method is to throw an exception. So you need to overwrite this method to return the RasterSource projection text.
=== Return Value ===
^ Return Type ^ Description ^
| String<!-- System.String -->   | Projection text string.   |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.Core.RasterSource -->
[[#Protected Methods|Go Back]]
==== MemberwiseClone() ====
=== Return Value ===
^ Return Type ^ Description ^
| Object<!-- System.Object -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- System.Object -->
[[#Protected Methods|Go Back]]
==== OnClosedRasterSource(ClosedRasterSourceEventArgs) ====
This method allows you to raise the ClosedRasterSource event from a derived class.
=== Remarks ===
You can call this method from a derived class to enable it to raise the ClosedRasterSource event. This may be useful if you plan to extend the RasterSource and you need access to the event.

Details on the event:

This event is called after the closing of the RasterSource. Technically, this event is called after the calling of the Close method on the RasterSource and after the protected CloseCore method.

It is typical that the RasterSource may be opened and closed may times during the life cycle of your application. The type of control the MapEngine is embedded in will dictate how often this happens. For example, in the case of the Web Edition, each time a RasterSource is in the Ajax or Post Back part of the page cycle, it will close the RasterSource before returning back to the client. This is to conserve resources, as the web is a connection-less environment. In the case of the Desktop Edition, we can keep the RasterSource open, knowing that we can maintain a persistent connection.
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| e   | [[ThinkGeo.MapSuite.Core.ClosedRasterSourceEventArgs|ClosedRasterSourceEventArgs]]<!-- ThinkGeo.MapSuite.Core.ClosedRasterSourceEventArgs -->   | This parameter is the event arguments that define the parameters passed to the recipient of the event.   |

<!-- ThinkGeo.MapSuite.Core.RasterSource -->
[[#Protected Methods|Go Back]]
==== OnClosingRasterSource(ClosingRasterSourceEventArgs) ====
This method allows you to raise the ClosingRasterSource event from a derived class.
=== Remarks ===
You can call this method from a derived class to enable it to raise the ClosingRasterSource event. This may be useful if you plan to extend the RasterSource and you need access to the event.

Details on the event:

This event is called before the closing of the RasterSource. Technically, this event is called after the calling of the Close method on the RasterSource, but before the protected CloseCore method.

It is typical that the RasterSource may be opened and closed may times during the life cycle of your application. The type of control the MapEngine is embedded in will dictate how often this happens. For example, in the case of the Web Edition, each time a RasterSource is in the Ajax or Post Back part of the page cycle, it will close the RasterSource before returning back to the client. This is to conserve resources, as the web is a connection-less environment. In the case of the Desktop Edition, we can keep the RasterSource open, knowing that we can maintain a persistent connection.
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| e   | [[ThinkGeo.MapSuite.Core.ClosingRasterSourceEventArgs|ClosingRasterSourceEventArgs]]<!-- ThinkGeo.MapSuite.Core.ClosingRasterSourceEventArgs -->   | This parameter is the event arguments that define the parameters passed to the recipient of the event.   |

<!-- ThinkGeo.MapSuite.Core.RasterSource -->
[[#Protected Methods|Go Back]]
==== OnOpenedRasterSource(OpenedRasterSourceEventArgs) ====
This method allows you to raise the OpenedRasterSource event from a derived class.
=== Remarks ===
You can call this method from a derived class to enable it to raise the OpenedRasterSource event. This may be useful if you plan to extend the RasterSource and you need access to the event.

Details on the event:

This event is called after the opening of the RasterSource. Technically, this event is called after the calling of the Open method on the RasterSource and after the protected OpenCore method is called.

It is typical that the RasterSource may be opened and closed may times during the life cycle of your application. The type of control the MapEngine is embedded in will dictate how often this happens. For example, in the case of the Web Edition, each time a RasterSource is in the Ajax or Post Back part of the page cycle, it will close the RasterSource before returning back to the client. This is to conserve resources, as the web is a connection-less environment. In the case of the Desktop Edition, we can keep the RasterSource open, knowing that we can maintain a persistent connection.
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| e   | [[ThinkGeo.MapSuite.Core.OpenedRasterSourceEventArgs|OpenedRasterSourceEventArgs]]<!-- ThinkGeo.MapSuite.Core.OpenedRasterSourceEventArgs -->   | This parameter is the event arguments that define the parameters passed to the recipient of the event.   |

<!-- ThinkGeo.MapSuite.Core.RasterSource -->
[[#Protected Methods|Go Back]]
==== OnOpeningRasterSource(OpeningRasterSourceEventArgs) ====
This method allows you to raise the OpeningRasterSource event from a derived class.
=== Remarks ===
You can call this method from a derived class to enable it to raise the OpeningRasterSource event. This may be useful if you plan to extend the RasterSource and you need access to the event.

Details on the event:

This event is called before the opening of the RasterSource. Technically, this event is called after the calling of the Open method on the RasterSource, but before the protected OpenCore method.

It is typical that the RasterSource may be opened and closed may times during the life cycle of your application. The type of control the MapEngine is embedded in will dictate how often this happens. For example, in the case of the Web Edition, each time a RasterSource is in the Ajax or Post Back part of the page cycle, it will close the RasterSource before returning back to the client. This is to conserve resources, as the web is a connection-less environment. In the case of the Desktop Edition, we can keep the RasterSource open, knowing that we can maintain a persistent connection.
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| e   | [[ThinkGeo.MapSuite.Core.OpeningRasterSourceEventArgs|OpeningRasterSourceEventArgs]]<!-- ThinkGeo.MapSuite.Core.OpeningRasterSourceEventArgs -->   | This parameter is the event arguments that define the parameters passed to the recipient of the event.   |

<!-- ThinkGeo.MapSuite.Core.RasterSource -->
[[#Protected Methods|Go Back]]
==== OpenCore() ====
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.Core.RasterSource(overriden) -->
[[#Protected Methods|Go Back]]
===== Public Properties =====
==== BlueTranslation ====
This property gets and sets the amount of blue to apply to the image.
=== Return Value ===
^ Return Type ^
| Single<!-- System.Single -->   |

<!-- ThinkGeo.MapSuite.Core.RasterSource -->
[[#Public Properties|Go Back]]
==== GreenTranslation ====
This property gets and sets the amount of green to apply to the image.
=== Return Value ===
^ Return Type ^
| Single<!-- System.Single -->   |

<!-- ThinkGeo.MapSuite.Core.RasterSource -->
[[#Public Properties|Go Back]]
==== HasProjectionText ====
This property returns true if the RasterSource has projection text, false if not.
=== Remarks ===
Before you call GetProjectionText method, you should check this property to ensure that your RasterSource has projection information. It will throw an exception if there is no projection information in the RasterSource.
=== Return Value ===
^ Return Type ^
| Boolean<!-- System.Boolean -->   |

<!-- ThinkGeo.MapSuite.Core.RasterSource -->
[[#Public Properties|Go Back]]
==== IsGrayscale ====
This property gets and sets if the image should be converted to grayscale.
=== Return Value ===
^ Return Type ^
| Boolean<!-- System.Boolean -->   |

<!-- ThinkGeo.MapSuite.Core.RasterSource -->
[[#Public Properties|Go Back]]
==== IsNegative ====
This property gets and sets whether the image should be converted to negative (inverse colors).
=== Return Value ===
^ Return Type ^
| Boolean<!-- System.Boolean -->   |

<!-- ThinkGeo.MapSuite.Core.RasterSource -->
[[#Public Properties|Go Back]]
==== IsOpen ====
This property returns true if the RasterSource is open and false if it is not.
=== Remarks ===
Various methods on the RasterSource require that it be in an open state. If one of those methods is called when the state is not open, the method will throw an exception. To enter the open state, you must call the RasterSource's Open method. The method will raise an exception if the current RasterSource is already open.
=== Return Value ===
^ Return Type ^
| Boolean<!-- System.Boolean -->   |

<!-- ThinkGeo.MapSuite.Core.RasterSource -->
[[#Public Properties|Go Back]]
==== KmlPathFilename ====
=== Return Value ===
^ Return Type ^
| String<!-- System.String -->   |

<!-- ThinkGeo.MapSuite.Core.KmlRasterSource -->
[[#Public Properties|Go Back]]
==== Projection ====
=== Return Value ===
^ Return Type ^
| [[ThinkGeo.MapSuite.Core.Projection|Projection]]<!-- ThinkGeo.MapSuite.Core.Projection -->   |

<!-- ThinkGeo.MapSuite.Core.RasterSource -->
[[#Public Properties|Go Back]]
==== RedTranslation ====
This property gets and sets the amount of red to apply to the image.
=== Return Value ===
^ Return Type ^
| Single<!-- System.Single -->   |

<!-- ThinkGeo.MapSuite.Core.RasterSource -->
[[#Public Properties|Go Back]]
==== Transparency ====
This property gets and sets the amount of transparency to apply to the image.
=== Return Value ===
^ Return Type ^
| Single<!-- System.Single -->   |

<!-- ThinkGeo.MapSuite.Core.RasterSource -->
[[#Public Properties|Go Back]]
===== Protected Properties =====
==== HasProjectionTextCore ====
This property returns true if the RasterSource has projection text, false if not.
=== Remarks ===
This protected virtual method is called from the concrete public property HasProjectionText. The default implementation for this method returns false. So if you inherit RasterSource, please ensure that you override this virtual property to return the correct projection status of your RasterSource.

We will check the HasProjectionText status before you call the GetProjectionText method. It will throw an exception if the HasProjectionText property returns false.
=== Return Value ===
^ Return Type ^
| Boolean<!-- System.Boolean -->   |

<!-- ThinkGeo.MapSuite.Core.RasterSource -->
[[#Protected Properties|Go Back]]
===== Public Events =====
==== ClosedRasterSource ====
This event is called after the closing of the RasterSource.
=== Remarks ===
This event is called after the closing of the RasterSource. Technically, this event is called after the calling of the Close method on the RasterSource and after the protected CloseCore method.

It is typical that the RasterSource may be opened and closed may times during the life cycle of your application. The type of control the MapEngine is embedded in will dictate how often this happens. For example, in the case of the Web Edition, each time a RasterSource is in the Ajax or Post Back part of the page cycle, it will close the RasterSource before returning back to the client. This is to conserve resources, as the web is a connection-less environment. In the case of the Desktop Edition, we can keep the RasterSource open, knowing that we can maintain a persistent connection.
=== Event Arguments ===
^ Event Arguments ^
| [[ThinkGeo.MapSuite.Core.ClosedRasterSourceEventArgs|ClosedRasterSourceEventArgs]]<!-- ThinkGeo.MapSuite.Core.ClosedRasterSourceEventArgs -->   |

<!-- ThinkGeo.MapSuite.Core.RasterSource -->
[[#Public Events|Go Back]]
==== ClosingRasterSource ====
This event is called before the closing of the RasterSource.
=== Remarks ===
This event is called before the closing of the RasterSource. Technically, this event is called after the calling of the Close method on the RasterSource, but before the protected CloseCore method.

It is typical that the RasterSource may be opened and closed may times during the life cycle of your application. The type of control the MapEngine is embedded in will dictate how often this happens. For example, in the case of the Web Edition, each time a RasterSource is in the Ajax or Post Back part of the page cycle, it will close the RasterSource before returning back to the client. This is to conserve resources, as the web is a connection-less environment. In the case of the Desktop Edition, we can keep the RasterSource open, knowing that we can maintain a persistent connection.
=== Event Arguments ===
^ Event Arguments ^
| [[ThinkGeo.MapSuite.Core.ClosingRasterSourceEventArgs|ClosingRasterSourceEventArgs]]<!-- ThinkGeo.MapSuite.Core.ClosingRasterSourceEventArgs -->   |

<!-- ThinkGeo.MapSuite.Core.RasterSource -->
[[#Public Events|Go Back]]
==== OpenedRasterSource ====
This event is called after the opening of the RasterSource.
=== Remarks ===
This event is called after the opening of the RasterSource. Technically, this event is called after the calling of the Open method on the RasterSource and after the protected OpenCore method is called.

It is typical that the RasterSource may be opened and closed may times during the life cycle of your application. The type of control the MapEngine is embedded in will dictate how often this happens. For example, in the case of the Web Edition, each time a RasterSource is in the Ajax or Post Back part of the page cycle, it will close the RasterSource before returning back to the client. This is to conserve resources, as the web is a connection-less environment. In the case of the Desktop Edition, we can keep the RasterSource open, knowing that we can maintain a persistent connection.
=== Event Arguments ===
^ Event Arguments ^
| [[ThinkGeo.MapSuite.Core.OpenedRasterSourceEventArgs|OpenedRasterSourceEventArgs]]<!-- ThinkGeo.MapSuite.Core.OpenedRasterSourceEventArgs -->   |

<!-- ThinkGeo.MapSuite.Core.RasterSource -->
[[#Public Events|Go Back]]
==== OpeningRasterSource ====
This event is called before the opening of the RasterSource.
=== Remarks ===
This event is called before the opening of the RasterSource. Technically, this event is called after the calling of the Open method on the RasterSource, but before the protected OpenCore method.

It is typical that the RasterSource may be opened and closed may times during the life cycle of your application. The type of control the MapEngine is embedded in will dictate how often this happens. For example, in the case of the Web Edition, each time a RasterSource is in the Ajax or Post Back part of the page cycle, it will close the RasterSource before returning back to the client. This is to conserve resources, as the web is a connection-less environment. In the case of the Desktop Edition, we can keep the RasterSource open, knowing that we can maintain a persistent connection.
=== Event Arguments ===
^ Event Arguments ^
| [[ThinkGeo.MapSuite.Core.OpeningRasterSourceEventArgs|OpeningRasterSourceEventArgs]]<!-- ThinkGeo.MapSuite.Core.OpeningRasterSourceEventArgs -->   |

<!-- ThinkGeo.MapSuite.Core.RasterSource -->
[[#Public Events|Go Back]]
==== StreamLoading ====
=== Event Arguments ===
^ Event Arguments ^
| [[ThinkGeo.MapSuite.Core.StreamLoadingEventArgs|StreamLoadingEventArgs]]<!-- ThinkGeo.MapSuite.Core.StreamLoadingEventArgs -->   |

<!-- ThinkGeo.MapSuite.Core.KmlRasterSource -->
[[#Public Events|Go Back]]

__NOTOC__
[[Category:MapSuiteCore]]
[[Category:ThinkGeo.MapSuite.Core]]
[[Category:UpdateDocumentation]]
User Tools

Site Tools

Page Tools
