====== ThinkGeo.MapSuite.GisEditor.DataRepositoryPlugin ====== {{section>upgrade_map_suite_to_10.0}} This plugin is the base class of all data repository plugins. GisEditor collects those plugins to create the data repository tree. ===== Inheritance Hierarchy ===== *System.Object **[[ThinkGeo.MapSuite.GisEditor.Plugin]] ***[[ThinkGeo.MapSuite.GisEditor.DataRepositoryPlugin]] ===== Members Summary ===== ==== Public Constructors ==== ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ ==== Protected Constructors ==== ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | {{wiki:ProtectedMethod.gif|Protected Method}}[[#DataRepositoryPlugin()|DataRepositoryPlugin]] | | | | ==== 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}}[[#CreateDataRepositoryItem()|CreateDataRepositoryItem]] | | | Gets the data repository item of data repository plugin. | | {{wiki:PublicMethod.gif|Public Method}}[[#DropOnMap(IEnumerable)|DropOnMap]] | IEnumerable<[[ThinkGeo.MapSuite.GisEditor.DataRepositoryItem|DataRepositoryItem]]> | | | | {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]] | Object | Object | | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object | | | {{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}}[[#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}}[[#CreateDataRepositoryItemCore()|CreateDataRepositoryItemCore]] | | | Gets the root data repository item of data repository plugin. This is the core method of GetDataRepositoryItem() to override. | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#DropOnMapCore(IEnumerable)|DropOnMapCore]] | IEnumerable<[[ThinkGeo.MapSuite.GisEditor.DataRepositoryItem|DataRepositoryItem]]> | | | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | {{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}}[[#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}}[[#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}}[[#CanDropOnMap|CanDropOnMap]] | Boolean | | | | {{wiki:PublicProperty.gif|Public Property}}[[#CanRefreshDynamically|CanRefreshDynamically]] | Boolean | | | | {{wiki:PublicProperty.gif|Public Property}}[[#Content|Content]] | UserControl | | Gets or sets the content of data repository plugin. | | {{wiki:PublicProperty.gif|Public Property}}[[#ContextMenu|ContextMenu]] | ContextMenu | | Gets or sets the context menu of data repository 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}}[[#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}}[[#RootDataRepositoryItem|RootDataRepositoryItem]] | [[ThinkGeo.MapSuite.GisEditor.DataRepositoryItem|DataRepositoryItem]] | | | | {{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 ^ | {{wiki:ProtectedProperty.gif|Protected Property}}[[#CanDropOnMapCore|CanDropOnMapCore]] | Boolean | | | | {{wiki:ProtectedProperty.gif|Protected Property}}[[#RootDataRepositoryItemCore|RootDataRepositoryItemCore]] | [[ThinkGeo.MapSuite.GisEditor.DataRepositoryItem|DataRepositoryItem]] | | | ==== Public Events ==== ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ ===== Public Constructors ===== ===== Protected Constructors ===== ==== DataRepositoryPlugin() ==== === 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]] ==== CreateDataRepositoryItem() ==== Gets the data repository item of data repository plugin. === Return Value === ^ Return Type ^ Description ^ | [[ThinkGeo.MapSuite.GisEditor.DataRepositoryItem|DataRepositoryItem]] | Data repository item. | === Parameters === ^ Name ^ Type ^ Description ^ [[#Public Methods|Go Back]] ==== DropOnMap(IEnumerable) ==== === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ | dataRepositoryItems | IEnumerable<[[ThinkGeo.MapSuite.GisEditor.DataRepositoryItem|DataRepositoryItem]]> | | [[#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]] ==== 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]] ==== 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]] ==== CreateDataRepositoryItemCore() ==== Gets the root data repository item of data repository plugin. This is the core method of GetDataRepositoryItem() to override. === Return Value === ^ Return Type ^ Description ^ | [[ThinkGeo.MapSuite.GisEditor.DataRepositoryItem|DataRepositoryItem]] | Root data repository item. | === Parameters === ^ Name ^ Type ^ Description ^ [[#Protected Methods|Go Back]] ==== DropOnMapCore(IEnumerable) ==== === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ | dataRepositoryItems | IEnumerable<[[ThinkGeo.MapSuite.GisEditor.DataRepositoryItem|DataRepositoryItem]]> | | [[#Protected Methods|Go Back]] ==== Finalize() ==== === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ [[#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]] ==== 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]] ==== 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]] ==== CanDropOnMap ==== === Return Value === ^ Return Type ^ | Boolean | [[#Public Properties|Go Back]] ==== CanRefreshDynamically ==== === Return Value === ^ Return Type ^ | Boolean | [[#Public Properties|Go Back]] ==== Content ==== Gets or sets the content of data repository plugin. === Return Value === ^ Return Type ^ | UserControl | [[#Public Properties|Go Back]] ==== ContextMenu ==== Gets or sets the context menu of data repository plugin. === Return Value === ^ Return Type ^ | ContextMenu | [[#Public Properties|Go Back]] ==== Description ==== Gets or sets description for plugin. === 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]] ==== RootDataRepositoryItem ==== === Return Value === ^ Return Type ^ | [[ThinkGeo.MapSuite.GisEditor.DataRepositoryItem|DataRepositoryItem]] | [[#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 ===== ==== CanDropOnMapCore ==== === Return Value === ^ Return Type ^ | Boolean | [[#Protected Properties|Go Back]] ==== RootDataRepositoryItemCore ==== === Return Value === ^ Return Type ^ | [[ThinkGeo.MapSuite.GisEditor.DataRepositoryItem|DataRepositoryItem]] | [[#Protected Properties|Go Back]] ===== Public Events ===== __NOTOC__ [[Category:GisEditorInfrastructure]] [[Category:ThinkGeo.MapSuite.GisEditor]] [[Category:UpdateDocumentation]]