====== ThinkGeo.MapSuite.GisEditor.UIPlugin ====== {{section>upgrade_map_suite_to_10.0}} This is an abstract class. Also this is a base class which will be used for creating our own plugins === Remarks === When override this class, consider the OnConnect and OnDisconnect method are the main methods in this class. OnConnect is used for adding UIs in the explorer while OnDisconnect indicates remove the UIs from the explorer. In OnConnect method, you can handle several properties: 1, RibbonGroups is a collection of the Microsoft.Windows.Controls.Ribbon.RibbonGroup. It allows adding a customize RibbonGroup with several ribbon buttons in it. Before using it, please reference RibbonControlsLibrary.dll in our reference folder. 2, DockablePanels is a collection of wrapper AvalonDock.DockableContent. It allows adding a customize DockableContent in it; DockableContent has a Content property whose type is object; in another word, the content accepts any user control and window. 3, OptionContent is a way to setting the options for this plugin. When set this property, a Option button will display in the PluginManager window. That all for the critial properties. A plugin all needs its providers information; so we have an attribute for you. To set it, the explorer will analyse it. ===== Inheritance Hierarchy ===== *System.Object **[[ThinkGeo.MapSuite.GisEditor.Plugin]] ***[[ThinkGeo.MapSuite.GisEditor.UIPlugin]] ===== Members Summary ===== ==== Public Constructors ==== ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ ==== Protected Constructors ==== ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | {{wiki:ProtectedMethod.gif|Protected Method}}[[#UIPlugin()|UIPlugin]] | | | 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}}[[#AttachMap(GisEditorWpfMap)|AttachMap]] | [[ThinkGeo.MapSuite.WpfDesktopEdition.Extension.GisEditorWpfMap|GisEditorWpfMap]] | | Attaches the map. | | {{wiki:PublicMethod.gif|Public Method}}[[#DetachMap(GisEditorWpfMap)|DetachMap]] | [[ThinkGeo.MapSuite.WpfDesktopEdition.Extension.GisEditorWpfMap|GisEditorWpfMap]] | | Detaches the map. | | {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]] | Object | Object | | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object | | | {{wiki:PublicMethod.gif|Public Method}}[[#GetLayerListItem(Object)|GetLayerListItem]] | Object | | Gets the layer list item. | | {{wiki:PublicMethod.gif|Public Method}}[[#GetLayerListItemContextMenuItems(GetLayerListItemContextMenuParameters)|GetLayerListItemContextMenuItems]] | [[ThinkGeo.MapSuite.GisEditor.GetLayerListItemContextMenuParameters|GetLayerListItemContextMenuParameters]] | | Gets the layer list item context menu items. | | {{wiki:PublicMethod.gif|Public Method}}[[#GetMapContextMenuItems(GetMapContextMenuParameters)|GetMapContextMenuItems]] | [[ThinkGeo.MapSuite.GisEditor.GetMapContextMenuParameters|GetMapContextMenuParameters]] | | Gets the map context menu items. | | {{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}}[[#Refresh(RefreshArgs)|Refresh]] | [[ThinkGeo.MapSuite.GisEditor.RefreshArgs|RefreshArgs]] | | This method sychronizes status from map to controls in this plugin. For example, a map is changed by another plugin such as adding a new layer; we need to notice the shell that the map's status is changed; then shells send a message to all plugins that to synchronize status from map by their selfies. | | {{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}}[[#AttachMapCore(GisEditorWpfMap)|AttachMapCore]] | [[ThinkGeo.MapSuite.WpfDesktopEdition.Extension.GisEditorWpfMap|GisEditorWpfMap]] | | Attaches the map core. | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#DetachMapCore(GisEditorWpfMap)|DetachMapCore]] | [[ThinkGeo.MapSuite.WpfDesktopEdition.Extension.GisEditorWpfMap|GisEditorWpfMap]] | | Detaches the map core. | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetLayerListItemContextMenuItemsCore(GetLayerListItemContextMenuParameters)|GetLayerListItemContextMenuItemsCore]] | [[ThinkGeo.MapSuite.GisEditor.GetLayerListItemContextMenuParameters|GetLayerListItemContextMenuParameters]] | | Gets the layer list item context menu items core. | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetLayerListItemCore(Object)|GetLayerListItemCore]] | Object | | Gets the layer list item core. | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetMapContextMenuItemsCore(GetMapContextMenuParameters)|GetMapContextMenuItemsCore]] | [[ThinkGeo.MapSuite.GisEditor.GetMapContextMenuParameters|GetMapContextMenuParameters]] | | Gets the map context menu items core. | | {{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]](overriden) | This method raises when load this plugin. | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#RefreshCore(GisEditorWpfMap, RefreshArgs)|RefreshCore]] | [[ThinkGeo.MapSuite.WpfDesktopEdition.Extension.GisEditorWpfMap|GisEditorWpfMap]], [[ThinkGeo.MapSuite.GisEditor.RefreshArgs|RefreshArgs]] | | Refreshes the core. | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#UnloadCore()|UnloadCore]] | | [[ThinkGeo.MapSuite.GisEditor.Plugin|Plugin]](overriden) | | ==== Public Properties ==== ^ Name ^ Return ^ DeclaringType ^ Summary ^ | {{wiki:PublicProperty.gif|Public Property}}[[#ApplicationMenuItems|ApplicationMenuItems]] | Collection | | Gets the application menu items. | | {{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}}[[#DockWindows|DockWindows]] | Collection<[[ThinkGeo.MapSuite.GisEditor.DockWindow|DockWindow]]> | | Each plugin can have multiple dockable contents. If it returns null, it meamns the plugin doesn't have DOCK window. | | {{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}}[[#IsHighlighted|IsHighlighted]] | Boolean | | Gets or sets a value indicating whether this instance is highlighted. | | {{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}}[[#RibbonEntries|RibbonEntries]] | Collection<[[ThinkGeo.MapSuite.GisEditor.RibbonEntry|RibbonEntry]]> | | Gets the ribbon entries. | | {{wiki:PublicProperty.gif|Public Property}}[[#SmallIcon|SmallIcon]] | ImageSource | [[ThinkGeo.MapSuite.GisEditor.Plugin|Plugin]] | Gets or sets small icon path for plugin. | | {{wiki:PublicProperty.gif|Public Property}}[[#StatusBarItems|StatusBarItems]] | Collection | | Use this property to add status bar items on the explorere. | ==== Protected Properties ==== ^ Name ^ Return ^ DeclaringType ^ Summary ^ ==== Public Events ==== ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ ===== Public Constructors ===== ===== Protected Constructors ===== ==== UIPlugin() ==== 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]] ==== AttachMap(GisEditorWpfMap) ==== Attaches the map. === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ | wpfMap | [[ThinkGeo.MapSuite.WpfDesktopEdition.Extension.GisEditorWpfMap|GisEditorWpfMap]] | The WPF map. | [[#Public Methods|Go Back]] ==== DetachMap(GisEditorWpfMap) ==== Detaches the map. === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ | wpfMap | [[ThinkGeo.MapSuite.WpfDesktopEdition.Extension.GisEditorWpfMap|GisEditorWpfMap]] | The WPF map. | [[#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(Object) ==== Gets the layer list item. === Return Value === ^ Return Type ^ Description ^ | [[ThinkGeo.MapSuite.GisEditor.LayerListItem|LayerListItem]] | a list item in the layer | === Parameters === ^ Name ^ Type ^ Description ^ | concreteObject | Object | The concrete object. | [[#Public Methods|Go Back]] ==== GetLayerListItemContextMenuItems(GetLayerListItemContextMenuParameters) ==== Gets the layer list item context menu items. === Return Value === ^ Return Type ^ Description ^ | Collection | Menu item collection | === Parameters === ^ Name ^ Type ^ Description ^ | parameters | [[ThinkGeo.MapSuite.GisEditor.GetLayerListItemContextMenuParameters|GetLayerListItemContextMenuParameters]] | The e. | [[#Public Methods|Go Back]] ==== GetMapContextMenuItems(GetMapContextMenuParameters) ==== Gets the map context menu items. === Return Value === ^ Return Type ^ Description ^ | Collection | Menu item collection | === Parameters === ^ Name ^ Type ^ Description ^ | parameters | [[ThinkGeo.MapSuite.GisEditor.GetMapContextMenuParameters|GetMapContextMenuParameters]] | The e. | [[#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]] ==== Refresh(RefreshArgs) ==== This method sychronizes status from map to controls in this plugin. For example, a map is changed by another plugin such as adding a new layer; we need to notice the shell that the map's status is changed; then shells send a message to all plugins that to synchronize status from map by their selfies. === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ | refreshArgs | [[ThinkGeo.MapSuite.GisEditor.RefreshArgs|RefreshArgs]] | | [[#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]] ==== AttachMapCore(GisEditorWpfMap) ==== Attaches the map core. === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ | wpfMap | [[ThinkGeo.MapSuite.WpfDesktopEdition.Extension.GisEditorWpfMap|GisEditorWpfMap]] | The WPF map. | [[#Protected Methods|Go Back]] ==== DetachMapCore(GisEditorWpfMap) ==== Detaches the map core. === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ | wpfMap | [[ThinkGeo.MapSuite.WpfDesktopEdition.Extension.GisEditorWpfMap|GisEditorWpfMap]] | The WPF map. | [[#Protected Methods|Go Back]] ==== Finalize() ==== === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ [[#Protected Methods|Go Back]] ==== GetLayerListItemContextMenuItemsCore(GetLayerListItemContextMenuParameters) ==== Gets the layer list item context menu items core. === Return Value === ^ Return Type ^ Description ^ | Collection | Menu item collection | === Parameters === ^ Name ^ Type ^ Description ^ | parameters | [[ThinkGeo.MapSuite.GisEditor.GetLayerListItemContextMenuParameters|GetLayerListItemContextMenuParameters]] | The e. | [[#Protected Methods|Go Back]] ==== GetLayerListItemCore(Object) ==== Gets the layer list item core. === Return Value === ^ Return Type ^ Description ^ | [[ThinkGeo.MapSuite.GisEditor.LayerListItem|LayerListItem]] | a list item in the layer | === Parameters === ^ Name ^ Type ^ Description ^ | concreteObject | Object | The concrete object. | [[#Protected Methods|Go Back]] ==== GetMapContextMenuItemsCore(GetMapContextMenuParameters) ==== Gets the map context menu items core. === Return Value === ^ Return Type ^ Description ^ | Collection | Menu item collection | === Parameters === ^ Name ^ Type ^ Description ^ | parameters | [[ThinkGeo.MapSuite.GisEditor.GetMapContextMenuParameters|GetMapContextMenuParameters]] | The e. | [[#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]] ==== RefreshCore(GisEditorWpfMap, RefreshArgs) ==== Refreshes the core. === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ | currentMap | [[ThinkGeo.MapSuite.WpfDesktopEdition.Extension.GisEditorWpfMap|GisEditorWpfMap]] | The current map. | | refreshArgs | [[ThinkGeo.MapSuite.GisEditor.RefreshArgs|RefreshArgs]] | The refresh args. | [[#Protected Methods|Go Back]] ==== UnloadCore() ==== === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ [[#Protected Methods|Go Back]] ===== Public Properties ===== ==== ApplicationMenuItems ==== Gets the application menu items. === Return Value === ^ Return Type ^ | Collection | [[#Public Properties|Go Back]] ==== 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]] ==== DockWindows ==== Each plugin can have multiple dockable contents. If it returns null, it meamns the plugin doesn't have DOCK window. === Return Value === ^ Return Type ^ | Collection<[[ThinkGeo.MapSuite.GisEditor.DockWindow|DockWindow]]> | [[#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]] ==== IsHighlighted ==== Gets or sets a value indicating whether this instance is highlighted. === 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]] ==== RibbonEntries ==== Gets the ribbon entries. === Return Value === ^ Return Type ^ | Collection<[[ThinkGeo.MapSuite.GisEditor.RibbonEntry|RibbonEntry]]> | [[#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]] ==== StatusBarItems ==== Use this property to add status bar items on the explorere. === Return Value === ^ Return Type ^ | Collection | [[#Public Properties|Go Back]] ===== Protected Properties ===== ===== Public Events ===== __NOTOC__ [[Category:GisEditorInfrastructure]] [[Category:ThinkGeo.MapSuite.GisEditor]] [[Category:UpdateDocumentation]]