====== ThinkGeo.MapSuite.GisEditor.LayerPlugin ====== {{section>upgrade_map_suite_to_10.0}} 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 ^ | {{wiki:ProtectedMethod.gif|Protected Method}}[[#LayerPlugin()|LayerPlugin]] | | | Initializes a new instance of the class. | ==== Public Methods ==== ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | {{wiki:PublicMethod.gif|Public Method}}[[#ApplySettings(StorableSettings)|ApplySettings]] | [[ThinkGeo.MapSuite.GisEditor.StorableSettings|StorableSettings]] | [[ThinkGeo.MapSuite.GisEditor.Plugin|Plugin]] | Applies the settings to this plugin. | | {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]] | Object | Object | | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object | | | {{wiki:PublicMethod.gif|Public Method}}[[#GetLayerListItem(Layer)|GetLayerListItem]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | This method gets a hierarchy object to build the layer list tree. | | {{wiki:PublicMethod.gif|Public Method}}[[#GetLayerType()|GetLayerType]] | | | Gets the type of the layer. GisEditor will use this method to find a match plugin to create a specific layer instance. | | {{wiki:PublicMethod.gif|Public Method}}[[#GetLayers()|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. | | {{wiki:PublicMethod.gif|Public Method}}[[#GetLayers(GetLayersParameters)|GetLayers]] | [[ThinkGeo.MapSuite.GisEditor.GetLayersParameters|GetLayersParameters]] | | | | {{wiki:PublicMethod.gif|Public Method}}[[#GetPropertiesUI(Layer)|GetPropertiesUI]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | Gets an UI that holds information of the pass layer. | | {{wiki:PublicMethod.gif|Public Method}}[[#GetSettings()|GetSettings]] | | [[ThinkGeo.MapSuite.GisEditor.Plugin|Plugin]] | Gets plugin settings to save. | | {{wiki:PublicMethod.gif|Public Method}}[[#GetSettingsUI()|GetSettingsUI]] | | [[ThinkGeo.MapSuite.GisEditor.Plugin|Plugin]] | Gets an UI that configures settings. | | {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]] | | Object | | | {{wiki:PublicMethod.gif|Public Method}}[[#GetUri(Layer)|GetUri]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | Gets the name of passed layer | | {{wiki:PublicMethod.gif|Public Method}}[[#Load()|Load]] | | [[ThinkGeo.MapSuite.GisEditor.Plugin|Plugin]] | This method raises when load this plugin. | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object | | | {{wiki:PublicMethod.gif|Public Method}}[[#Unload()|Unload]] | | [[ThinkGeo.MapSuite.GisEditor.Plugin|Plugin]] | This method raises when unload this plugin. | ==== Protected Methods ==== ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | {{wiki:ProtectedMethod.gif|Protected Method}}[[#ApplySettingsCore(StorableSettings)|ApplySettingsCore]] | [[ThinkGeo.MapSuite.GisEditor.StorableSettings|StorableSettings]] | [[ThinkGeo.MapSuite.GisEditor.Plugin|Plugin]] | Applies the settings to this plugin. | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetLayerListItemCore(Layer)|GetLayerListItemCore]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | This method gets a hierarchy object to build the layer list tree. | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetLayerTypeCore()|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. | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetLayersCore(GetLayersParameters)|GetLayersCore]] | [[ThinkGeo.MapSuite.GisEditor.GetLayersParameters|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. | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetPropertiesUICore(Layer)|GetPropertiesUICore]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | Gets an UI that holds information of the pass layer. | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetSettingsCore()|GetSettingsCore]] | | [[ThinkGeo.MapSuite.GisEditor.Plugin|Plugin]] | Gets plugin settings to save. | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetSettingsUICore()|GetSettingsUICore]] | | [[ThinkGeo.MapSuite.GisEditor.Plugin|Plugin]] | Gets an UI that configures settings. | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetUriCore(Layer)|GetUriCore]] | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | | Gets the name of passed layer | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#LoadCore()|LoadCore]] | | [[ThinkGeo.MapSuite.GisEditor.Plugin|Plugin]] | This method raises when load this plugin. | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnGettingLayers(GettingLayersLayerPluginEventArgs)|OnGettingLayers]] | [[ThinkGeo.MapSuite.GisEditor.GettingLayersLayerPluginEventArgs|GettingLayersLayerPluginEventArgs]] | | | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnGottenLayers(GottenLayersLayerPluginEventArgs)|OnGottenLayers]] | [[ThinkGeo.MapSuite.GisEditor.GottenLayersLayerPluginEventArgs|GottenLayersLayerPluginEventArgs]] | | | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#UnloadCore()|UnloadCore]] | | [[ThinkGeo.MapSuite.GisEditor.Plugin|Plugin]] | This method raises when unload this plugin. | ==== Public Properties ==== ^ Name ^ Return ^ DeclaringType ^ Summary ^ | {{wiki:PublicProperty.gif|Public Property}}[[#Author|Author]] | String | [[ThinkGeo.MapSuite.GisEditor.Plugin|Plugin]] | Gets or sets author information for plugin. | | {{wiki:PublicProperty.gif|Public Property}}[[#Description|Description]] | String | [[ThinkGeo.MapSuite.GisEditor.Plugin|Plugin]] | Gets or sets description for plugin. | | {{wiki:PublicProperty.gif|Public Property}}[[#ExtensionFilter|ExtensionFilter]] | String | | Gets or sets the extension filter that allows to create a specific layer. | | {{wiki:PublicProperty.gif|Public Property}}[[#Id|Id]] | String | [[ThinkGeo.MapSuite.GisEditor.Plugin|Plugin]] | Gets the identify of plugin. | | {{wiki:PublicProperty.gif|Public Property}}[[#Index|Index]] | Int32 | [[ThinkGeo.MapSuite.GisEditor.Plugin|Plugin]] | Gets or sets the index of the plugin. | | {{wiki:PublicProperty.gif|Public Property}}[[#IsActive|IsActive]] | Boolean | [[ThinkGeo.MapSuite.GisEditor.Plugin|Plugin]] | Gets or sets a value indicating whether this plugin is active. | | {{wiki:PublicProperty.gif|Public Property}}[[#IsRequired|IsRequired]] | Boolean | [[ThinkGeo.MapSuite.GisEditor.Plugin|Plugin]] | Gets or sets a value indicating whether this plugin is required. | | {{wiki:PublicProperty.gif|Public Property}}[[#LargeIcon|LargeIcon]] | ImageSource | [[ThinkGeo.MapSuite.GisEditor.Plugin|Plugin]] | Gets or sets large icon for plugin. | | {{wiki:PublicProperty.gif|Public Property}}[[#Name|Name]] | String | [[ThinkGeo.MapSuite.GisEditor.Plugin|Plugin]] | Gets or sets the name of plugin. | | {{wiki:PublicProperty.gif|Public Property}}[[#SmallIcon|SmallIcon]] | ImageSource | [[ThinkGeo.MapSuite.GisEditor.Plugin|Plugin]] | Gets or sets small icon path for plugin. | ==== Protected Properties ==== ^ Name ^ Return ^ DeclaringType ^ Summary ^ ==== Public Events ==== ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | {{wiki:PublicEvent.gif|Public Event}}[[#GettingLayers|GettingLayers]] | [[ThinkGeo.MapSuite.GisEditor.GettingLayersLayerPluginEventArgs|GettingLayersLayerPluginEventArgs]] | | | | {{wiki:PublicEvent.gif|Public Event}}[[#GottenLayers|GottenLayers]] | [[ThinkGeo.MapSuite.GisEditor.GottenLayersLayerPluginEventArgs|GottenLayersLayerPluginEventArgs]] | | | ===== Public Constructors ===== ===== Protected Constructors ===== ==== LayerPlugin() ==== Initializes a new instance of the class. === Parameters === ^ Name ^ Type ^ Description ^ [[#Protected Constructors|Go Back]] ===== Public Methods ===== ==== ApplySettings(StorableSettings) ==== Applies the settings to this plugin. === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ | settings | [[ThinkGeo.MapSuite.GisEditor.StorableSettings|StorableSettings]] | The settings to be applied to this plugin. | [[#Public Methods|Go Back]] ==== Equals(Object) ==== === Return Value === ^ Return Type ^ Description ^ | Boolean | | === Parameters === ^ Name ^ Type ^ Description ^ | obj | Object | | [[#Public Methods|Go Back]] ==== GetHashCode() ==== === Return Value === ^ Return Type ^ Description ^ | Int32 | | === Parameters === ^ Name ^ Type ^ Description ^ [[#Public Methods|Go Back]] ==== GetLayerListItem(Layer) ==== This method gets a hierarchy object to build the layer list tree. === Return Value === ^ Return Type ^ Description ^ | [[ThinkGeo.MapSuite.GisEditor.LayerListItem|LayerListItem]] | | === Parameters === ^ Name ^ Type ^ Description ^ | layer | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | The layer list item to build the layer list tree. | [[#Public Methods|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 | A type of subclasses that inherit from ThinkGeo.MapSuite.Layer. | === Parameters === ^ Name ^ Type ^ Description ^ [[#Public Methods|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<[[ThinkGeo.MapSuite.Core.Layer|Layer]]> | A set of specific layers that created by this plugin. | === Parameters === ^ Name ^ Type ^ Description ^ [[#Public Methods|Go Back]] ==== GetLayers(GetLayersParameters) ==== === Return Value === ^ Return Type ^ Description ^ | Collection<[[ThinkGeo.MapSuite.Core.Layer|Layer]]> | | === Parameters === ^ Name ^ Type ^ Description ^ | getLayersParameters | [[ThinkGeo.MapSuite.GisEditor.GetLayersParameters|GetLayersParameters]] | | [[#Public Methods|Go Back]] ==== GetPropertiesUI(Layer) ==== Gets an UI that holds information of the pass layer. === Return Value === ^ Return Type ^ Description ^ | UserControl | An UI that holds information of the pass layer | === Parameters === ^ Name ^ Type ^ Description ^ | layer | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | The layer that to build the UI. | [[#Public Methods|Go Back]] ==== GetSettings() ==== Gets plugin settings to save. === Return Value === ^ Return Type ^ Description ^ | [[ThinkGeo.MapSuite.GisEditor.StorableSettings|StorableSettings]] | Plugin's settings to save. | === Parameters === ^ Name ^ Type ^ Description ^ [[#Public Methods|Go Back]] ==== GetSettingsUI() ==== Gets an UI that configures settings. === Return Value === ^ Return Type ^ Description ^ | [[ThinkGeo.MapSuite.GisEditor.SettingUserControl|SettingUserControl]] | A SettingUserControl that configures settings. | === Parameters === ^ Name ^ Type ^ Description ^ [[#Public Methods|Go Back]] ==== GetType() ==== === Return Value === ^ Return Type ^ Description ^ | Type | | === Parameters === ^ Name ^ Type ^ Description ^ [[#Public Methods|Go Back]] ==== GetUri(Layer) ==== Gets the name of passed layer === Return Value === ^ Return Type ^ Description ^ | Uri | The path file name of this layer. | === Parameters === ^ Name ^ Type ^ Description ^ | layer | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | The layer to get path file name. | [[#Public Methods|Go Back]] ==== Load() ==== This method raises when load this plugin. === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ [[#Public Methods|Go Back]] ==== ToString() ==== === Return Value === ^ Return Type ^ Description ^ | String | | === Parameters === ^ Name ^ Type ^ Description ^ [[#Public Methods|Go Back]] ==== Unload() ==== This method raises when unload this plugin. === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ [[#Public Methods|Go Back]] ===== Protected Methods ===== ==== ApplySettingsCore(StorableSettings) ==== Applies the settings to this plugin. === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ | settings | [[ThinkGeo.MapSuite.GisEditor.StorableSettings|StorableSettings]] | The settings to be applied to this plugin. | [[#Protected Methods|Go Back]] ==== Finalize() ==== === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ [[#Protected Methods|Go Back]] ==== GetLayerListItemCore(Layer) ==== This method gets a hierarchy object to build the layer list tree. === Return Value === ^ Return Type ^ Description ^ | [[ThinkGeo.MapSuite.GisEditor.LayerListItem|LayerListItem]] | | === Parameters === ^ Name ^ Type ^ Description ^ | layer | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | The layer list item to build the layer list tree. | [[#Protected Methods|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 | A type of subclasses that inherit from ThinkGeo.MapSuite.Layer. | === Parameters === ^ Name ^ Type ^ Description ^ [[#Protected Methods|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<[[ThinkGeo.MapSuite.Core.Layer|Layer]]> | A set of specific layers that created by this plugin. | === Parameters === ^ Name ^ Type ^ Description ^ | getLayersParameters | [[ThinkGeo.MapSuite.GisEditor.GetLayersParameters|GetLayersParameters]] | | [[#Protected Methods|Go Back]] ==== GetPropertiesUICore(Layer) ==== Gets an UI that holds information of the pass layer. === Return Value === ^ Return Type ^ Description ^ | UserControl | An UI that holds information of the pass layer | === Parameters === ^ Name ^ Type ^ Description ^ | layer | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | The layer that to build the UI. | [[#Protected Methods|Go Back]] ==== GetSettingsCore() ==== Gets plugin settings to save. === Return Value === ^ Return Type ^ Description ^ | [[ThinkGeo.MapSuite.GisEditor.StorableSettings|StorableSettings]] | Plugin's settings to save. | === Parameters === ^ Name ^ Type ^ Description ^ [[#Protected Methods|Go Back]] ==== GetSettingsUICore() ==== Gets an UI that configures settings. === Return Value === ^ Return Type ^ Description ^ | [[ThinkGeo.MapSuite.GisEditor.SettingUserControl|SettingUserControl]] | A SettingUserControl that configures settings. | === Parameters === ^ Name ^ Type ^ Description ^ [[#Protected Methods|Go Back]] ==== GetUriCore(Layer) ==== Gets the name of passed layer === Return Value === ^ Return Type ^ Description ^ | Uri | The path file name of this layer. | === Parameters === ^ Name ^ Type ^ Description ^ | layer | [[ThinkGeo.MapSuite.Core.Layer|Layer]] | The layer to get path file name. | [[#Protected Methods|Go Back]] ==== LoadCore() ==== This method raises when load this plugin. === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ [[#Protected Methods|Go Back]] ==== MemberwiseClone() ==== === Return Value === ^ Return Type ^ Description ^ | Object | | === Parameters === ^ Name ^ Type ^ Description ^ [[#Protected Methods|Go Back]] ==== OnGettingLayers(GettingLayersLayerPluginEventArgs) ==== === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ | e | [[ThinkGeo.MapSuite.GisEditor.GettingLayersLayerPluginEventArgs|GettingLayersLayerPluginEventArgs]] | | [[#Protected Methods|Go Back]] ==== OnGottenLayers(GottenLayersLayerPluginEventArgs) ==== === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ | e | [[ThinkGeo.MapSuite.GisEditor.GottenLayersLayerPluginEventArgs|GottenLayersLayerPluginEventArgs]] | | [[#Protected Methods|Go Back]] ==== UnloadCore() ==== This method raises when unload this plugin. === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ [[#Protected Methods|Go Back]] ===== Public Properties ===== ==== Author ==== Gets or sets author information for plugin. === Return Value === ^ Return Type ^ | String | [[#Public Properties|Go Back]] ==== Description ==== Gets or sets description for plugin. === Return Value === ^ Return Type ^ | String | [[#Public Properties|Go Back]] ==== ExtensionFilter ==== Gets or sets the extension filter that allows to create a specific layer. === Return Value === ^ Return Type ^ | String | [[#Public Properties|Go Back]] ==== Id ==== Gets the identify of plugin. === Return Value === ^ Return Type ^ | String | [[#Public Properties|Go Back]] ==== Index ==== Gets or sets the index of the plugin. === Remarks === Plugins are orded by this property. === Return Value === ^ Return Type ^ | Int32 | [[#Public Properties|Go Back]] ==== IsActive ==== Gets or sets a value indicating whether this plugin is active. === Return Value === ^ Return Type ^ | Boolean | [[#Public Properties|Go Back]] ==== IsRequired ==== Gets or sets a value indicating whether this plugin is required. === Return Value === ^ Return Type ^ | Boolean | [[#Public Properties|Go Back]] ==== LargeIcon ==== Gets or sets large icon for plugin. === 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. === Return Value === ^ Return Type ^ | ImageSource | [[#Public Properties|Go Back]] ==== Name ==== Gets or sets the name of plugin. === Return Value === ^ Return Type ^ | String | [[#Public Properties|Go Back]] ==== SmallIcon ==== Gets or sets small icon path for plugin. === 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. === Return Value === ^ Return Type ^ | ImageSource | [[#Public Properties|Go Back]] ===== Protected Properties ===== ===== Public Events ===== ==== GettingLayers ==== === Event Arguments === ^ Event Arguments ^ | [[ThinkGeo.MapSuite.GisEditor.GettingLayersLayerPluginEventArgs|GettingLayersLayerPluginEventArgs]] | [[#Public Events|Go Back]] ==== GottenLayers ==== === Event Arguments === ^ Event Arguments ^ | [[ThinkGeo.MapSuite.GisEditor.GottenLayersLayerPluginEventArgs|GottenLayersLayerPluginEventArgs]] | [[#Public Events|Go Back]] __NOTOC__ [[Category:GisEditorInfrastructure]] [[Category:ThinkGeo.MapSuite.GisEditor]] [[Category:UpdateDocumentation]]