ThinkGeo Cloud
ThinkGeo UI Controls
ThinkGeo Open Source
Help and Support
External Resources
Sidebar
thinkgeo.mapsuite.giseditor.layerplugin
Table of Contents
ThinkGeo.MapSuite.GisEditor.LayerPlugin
Note: The page was created before Map Suite 10. Map Suite 10.0 organized many classes into new namespaces and assemblies as well as had a few minor breaks in compatibility. The majority of previously built code should work without modification assuming the new namespaces are added. For guidance on upgrading your existing code, please check out MapSuite 10 Upgrade Guide.
<!– Class –> This class is the base class of all LayerPlugins. This plugin provides the functionality of creating a specific type of layer instance.
Inheritance Hierarchy
*System.Object ThinkGeo.MapSuite.GisEditor.Plugin *ThinkGeo.MapSuite.GisEditor.LayerPlugin ThinkGeo.MapSuite.GisEditor.FeatureLayerPlugin
Members Summary
Public Constructors
| Name | Parameters | DeclaringType | Summary |
|---|
Protected Constructors
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 LayerPlugin | Initializes a new instance of the class. |
Public Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 ApplySettings | StorableSettings | Plugin | Applies the settings to this plugin. |
| Equals | Object | Object | |
| GetHashCode | Object | ||
| GetLayerListItem | Layer | This method gets a hierarchy object to build the layer list tree. | |
| GetLayerType | Gets the type of the layer. GisEditor will use this method to find a match plugin to create a specific layer instance. | ||
| GetLayers | This method creates layers instance. In this method, it might popup a dialog to configuration. For example, a ShapeFileFeatureLayer is based on a shapefile, we need popup an OpenFileDialog to choose a file. Or MSSql layer needs a connection string to connect to the server, etc. | ||
| GetLayers | GetLayersParameters | ||
| GetPropertiesUI | Layer | Gets an UI that holds information of the pass layer. | |
| GetSettings | Plugin | Gets plugin settings to save. | |
| GetSettingsUI | Plugin | Gets an UI that configures settings. | |
| GetType | Object | ||
| GetUri | Layer | Gets the name of passed layer | |
| Load | Plugin | This method raises when load this plugin. | |
| ToString | Object | ||
| Unload | Plugin | This method raises when unload this plugin. |
Protected Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
| ApplySettingsCore | StorableSettings | Plugin | Applies the settings to this plugin. |
| Finalize | Object | ||
| GetLayerListItemCore | Layer | This method gets a hierarchy object to build the layer list tree. | |
| GetLayerTypeCore | Gets the type of the layer. GisEditor will use this method to find a match plugin to create a specific layer instance. This is the core method of public Type GetLayerType() for override. | ||
| GetLayersCore | GetLayersParameters | This method creates layers instance. In this method, it might popup a dialog to configuration. For example, a ShapeFileFeatureLayer is based on a shapefile, we need popup an OpenFileDialog to choose a file. Or MSSql layer needs a connection string to connect to the server, etc. | |
| GetPropertiesUICore | Layer | Gets an UI that holds information of the pass layer. | |
| GetSettingsCore | Plugin | Gets plugin settings to save. | |
| GetSettingsUICore | Plugin | Gets an UI that configures settings. | |
| GetUriCore | Layer | Gets the name of passed layer | |
| LoadCore | Plugin | This method raises when load this plugin. | |
| MemberwiseClone | Object | ||
| OnGettingLayers | GettingLayersLayerPluginEventArgs | ||
| OnGottenLayers | GottenLayersLayerPluginEventArgs | ||
| UnloadCore | Plugin | This method raises when unload this plugin. |
Public Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 Author | String | Plugin | Gets or sets author information for plugin. |
| Description | String | Plugin | Gets or sets description for plugin. |
| ExtensionFilter | String | Gets or sets the extension filter that allows to create a specific layer. | |
| Id | String | Plugin | Gets the identify of plugin. |
| Index | Int32 | Plugin | Gets or sets the index of the plugin. |
| IsActive | Boolean | Plugin | Gets or sets a value indicating whether this plugin is active. |
| IsRequired | Boolean | Plugin | Gets or sets a value indicating whether this plugin is required. |
| LargeIcon | ImageSource | Plugin | Gets or sets large icon for plugin. |
| Name | String | Plugin | Gets or sets the name of plugin. |
| SmallIcon | ImageSource | Plugin | Gets or sets small icon path for plugin. |
Protected Properties
| Name | Return | DeclaringType | Summary |
|---|
Public Events
| Name | Event Arguments | DeclaringType | Summary |
|---|---|---|---|
 GettingLayers | GettingLayersLayerPluginEventArgs | ||
| GottenLayers | GottenLayersLayerPluginEventArgs |
Public Constructors
Protected Constructors
LayerPlugin()
Initializes a new instance of the class.
Parameters
| Name | Type | Description |
|---|
Public Methods
ApplySettings(StorableSettings)
Applies the settings to this plugin.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| settings | StorableSettings<!– ThinkGeo.MapSuite.GisEditor.StorableSettings –> | The settings to be applied to this plugin. |
<!– ThinkGeo.MapSuite.GisEditor.Plugin –> Go Back
Equals(Object)
Return Value
| Return Type | Description |
|---|---|
| Boolean<!– System.Boolean –> |
Parameters
| Name | Type | Description |
|---|---|---|
| obj | Object<!– System.Object –> |
<!– System.Object –> Go Back
GetHashCode()
Return Value
| Return Type | Description |
|---|---|
| Int32<!– System.Int32 –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
GetLayerListItem(Layer)
This method gets a hierarchy object to build the layer list tree.
Return Value
| Return Type | Description |
|---|---|
| LayerListItem<!– ThinkGeo.MapSuite.GisEditor.LayerListItem –> |
Parameters
| Name | Type | Description |
|---|---|---|
| layer | Layer<!– ThinkGeo.MapSuite.Core.Layer –> | The layer list item to build the layer list tree. |
<!– ThinkGeo.MapSuite.GisEditor.LayerPlugin –> Go Back
GetLayerType()
Gets the type of the layer. GisEditor will use this method to find a match plugin to create a specific layer instance.
Return Value
| Return Type | Description |
|---|---|
| Type<!– System.Type –> | A type of subclasses that inherit from ThinkGeo.MapSuite.Layer. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.GisEditor.LayerPlugin –> Go Back
GetLayers()
This method creates layers instance. In this method, it might popup a dialog to configuration. For example, a ShapeFileFeatureLayer is based on a shapefile, we need popup an OpenFileDialog to choose a file. Or MSSql layer needs a connection string to connect to the server, etc.
Return Value
| Return Type | Description |
|---|---|
| Collection<Layer><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Layer} –> | A set of specific layers that created by this plugin. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.GisEditor.LayerPlugin –> Go Back
GetLayers(GetLayersParameters)
Return Value
| Return Type | Description |
|---|---|
| Collection<Layer><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Layer} –> |
Parameters
| Name | Type | Description |
|---|---|---|
| getLayersParameters | GetLayersParameters<!– ThinkGeo.MapSuite.GisEditor.GetLayersParameters –> |
<!– ThinkGeo.MapSuite.GisEditor.LayerPlugin –> Go Back
GetPropertiesUI(Layer)
Gets an UI that holds information of the pass layer.
Return Value
| Return Type | Description |
|---|---|
| UserControl<!– System.Windows.Controls.UserControl –> | An UI that holds information of the pass layer |
Parameters
| Name | Type | Description |
|---|---|---|
| layer | Layer<!– ThinkGeo.MapSuite.Core.Layer –> | The layer that to build the UI. |
<!– ThinkGeo.MapSuite.GisEditor.LayerPlugin –> Go Back
GetSettings()
Gets plugin settings to save.
Return Value
| Return Type | Description |
|---|---|
| StorableSettings<!– ThinkGeo.MapSuite.GisEditor.StorableSettings –> | Plugin's settings to save. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.GisEditor.Plugin –> Go Back
GetSettingsUI()
Gets an UI that configures settings.
Return Value
| Return Type | Description |
|---|---|
| SettingUserControl<!– ThinkGeo.MapSuite.GisEditor.SettingUserControl –> | A SettingUserControl that configures settings. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.GisEditor.Plugin –> Go Back
GetType()
Return Value
| Return Type | Description |
|---|---|
| Type<!– System.Type –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
GetUri(Layer)
Gets the name of passed layer
Return Value
| Return Type | Description |
|---|---|
| Uri<!– System.Uri –> | The path file name of this layer. |
Parameters
| Name | Type | Description |
|---|---|---|
| layer | Layer<!– ThinkGeo.MapSuite.Core.Layer –> | The layer to get path file name. |
<!– ThinkGeo.MapSuite.GisEditor.LayerPlugin –> Go Back
Load()
This method raises when load this plugin.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.GisEditor.Plugin –> Go Back
ToString()
Return Value
| Return Type | Description |
|---|---|
| String<!– System.String –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
Unload()
This method raises when unload this plugin.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.GisEditor.Plugin –> Go Back
Protected Methods
ApplySettingsCore(StorableSettings)
Applies the settings to this plugin.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| settings | StorableSettings<!– ThinkGeo.MapSuite.GisEditor.StorableSettings –> | The settings to be applied to this plugin. |
<!– ThinkGeo.MapSuite.GisEditor.Plugin –> Go Back
Finalize()
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
GetLayerListItemCore(Layer)
This method gets a hierarchy object to build the layer list tree.
Return Value
| Return Type | Description |
|---|---|
| LayerListItem<!– ThinkGeo.MapSuite.GisEditor.LayerListItem –> |
Parameters
| Name | Type | Description |
|---|---|---|
| layer | Layer<!– ThinkGeo.MapSuite.Core.Layer –> | The layer list item to build the layer list tree. |
<!– ThinkGeo.MapSuite.GisEditor.LayerPlugin –> Go Back
GetLayerTypeCore()
Gets the type of the layer. GisEditor will use this method to find a match plugin to create a specific layer instance. This is the core method of public Type GetLayerType() for override.
Return Value
| Return Type | Description |
|---|---|
| Type<!– System.Type –> | A type of subclasses that inherit from ThinkGeo.MapSuite.Layer. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.GisEditor.LayerPlugin –> Go Back
GetLayersCore(GetLayersParameters)
This method creates layers instance. In this method, it might popup a dialog to configuration. For example, a ShapeFileFeatureLayer is based on a shapefile, we need popup an OpenFileDialog to choose a file. Or MSSql layer needs a connection string to connect to the server, etc.
Return Value
| Return Type | Description |
|---|---|
| Collection<Layer><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Layer} –> | A set of specific layers that created by this plugin. |
Parameters
| Name | Type | Description |
|---|---|---|
| getLayersParameters | GetLayersParameters<!– ThinkGeo.MapSuite.GisEditor.GetLayersParameters –> |
<!– ThinkGeo.MapSuite.GisEditor.LayerPlugin –> Go Back
GetPropertiesUICore(Layer)
Gets an UI that holds information of the pass layer.
Return Value
| Return Type | Description |
|---|---|
| UserControl<!– System.Windows.Controls.UserControl –> | An UI that holds information of the pass layer |
Parameters
| Name | Type | Description |
|---|---|---|
| layer | Layer<!– ThinkGeo.MapSuite.Core.Layer –> | The layer that to build the UI. |
<!– ThinkGeo.MapSuite.GisEditor.LayerPlugin –> Go Back
GetSettingsCore()
Gets plugin settings to save.
Return Value
| Return Type | Description |
|---|---|
| StorableSettings<!– ThinkGeo.MapSuite.GisEditor.StorableSettings –> | Plugin's settings to save. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.GisEditor.Plugin –> Go Back
GetSettingsUICore()
Gets an UI that configures settings.
Return Value
| Return Type | Description |
|---|---|
| SettingUserControl<!– ThinkGeo.MapSuite.GisEditor.SettingUserControl –> | A SettingUserControl that configures settings. |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.GisEditor.Plugin –> Go Back
GetUriCore(Layer)
Gets the name of passed layer
Return Value
| Return Type | Description |
|---|---|
| Uri<!– System.Uri –> | The path file name of this layer. |
Parameters
| Name | Type | Description |
|---|---|---|
| layer | Layer<!– ThinkGeo.MapSuite.Core.Layer –> | The layer to get path file name. |
<!– ThinkGeo.MapSuite.GisEditor.LayerPlugin –> Go Back
LoadCore()
This method raises when load this plugin.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.GisEditor.Plugin –> Go Back
MemberwiseClone()
Return Value
| Return Type | Description |
|---|---|
| Object<!– System.Object –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
OnGettingLayers(GettingLayersLayerPluginEventArgs)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| e | GettingLayersLayerPluginEventArgs<!– ThinkGeo.MapSuite.GisEditor.GettingLayersLayerPluginEventArgs –> |
<!– ThinkGeo.MapSuite.GisEditor.LayerPlugin –> Go Back
OnGottenLayers(GottenLayersLayerPluginEventArgs)
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| e | GottenLayersLayerPluginEventArgs<!– ThinkGeo.MapSuite.GisEditor.GottenLayersLayerPluginEventArgs –> |
<!– ThinkGeo.MapSuite.GisEditor.LayerPlugin –> Go Back
UnloadCore()
This method raises when unload this plugin.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.GisEditor.Plugin –> Go Back
Public Properties
Author
Gets or sets author information for plugin.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.GisEditor.Plugin –> Go Back
Description
Gets or sets description for plugin.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.GisEditor.Plugin –> Go Back
ExtensionFilter
Gets or sets the extension filter that allows to create a specific layer.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.GisEditor.LayerPlugin –> Go Back
Id
Gets the identify of plugin.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.GisEditor.Plugin –> Go Back
Index
Gets or sets the index of the plugin.
Remarks
<remarks> Plugins are orded by this property. </remarks>
Return Value
| Return Type |
|---|
| Int32<!– System.Int32 –> |
<!– ThinkGeo.MapSuite.GisEditor.Plugin –> Go Back
IsActive
Gets or sets a value indicating whether this plugin is active.
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.GisEditor.Plugin –> Go Back
IsRequired
Gets or sets a value indicating whether this plugin is required.
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.GisEditor.Plugin –> Go Back
LargeIcon
Gets or sets large icon for plugin.
Remarks
<remarks> Setting relative path to this property to discover image. Path should be like the form of FolderName(optional)/ImageFullName, such as “Images/NewContent.png” or “Content.png”. Make sure that image you supplied compiling with Build Action Resource. </remarks>
Return Value
| Return Type |
|---|
| ImageSource<!– System.Windows.Media.ImageSource –> |
<!– ThinkGeo.MapSuite.GisEditor.Plugin –> Go Back
Name
Gets or sets the name of plugin.
Return Value
| Return Type |
|---|
| String<!– System.String –> |
<!– ThinkGeo.MapSuite.GisEditor.Plugin –> Go Back
SmallIcon
Gets or sets small icon path for plugin.
Remarks
<remarks> Setting relative path to this property to discover image. Path should be like the form of FolderName(optional)/ImageFullName, such as “Images/NewContent.png” or “Content.png”. Make sure that image you supplied compiling with Build Action Resource. </remarks>
Return Value
| Return Type |
|---|
| ImageSource<!– System.Windows.Media.ImageSource –> |
<!– ThinkGeo.MapSuite.GisEditor.Plugin –> Go Back
Protected Properties
Public Events
GettingLayers
Event Arguments
| Event Arguments |
|---|
| GettingLayersLayerPluginEventArgs<!– ThinkGeo.MapSuite.GisEditor.GettingLayersLayerPluginEventArgs –> |
<!– ThinkGeo.MapSuite.GisEditor.LayerPlugin –> Go Back
GottenLayers
Event Arguments
| Event Arguments |
|---|
| GottenLayersLayerPluginEventArgs<!– ThinkGeo.MapSuite.GisEditor.GottenLayersLayerPluginEventArgs –> |
<!– ThinkGeo.MapSuite.GisEditor.LayerPlugin –> Go Back
NOTOC GisEditorInfrastructure ThinkGeo.MapSuite.GisEditor UpdateDocumentation
thinkgeo.mapsuite.giseditor.layerplugin.txt · Last modified: 2017/03/16 21:59 (external edit)