ThinkGeo Cloud
ThinkGeo UI Controls
ThinkGeo Open Source
Help and Support
External Resources
Sidebar
thinkgeo.mapsuite.giseditor.uiplugin
Table of Contents
ThinkGeo.MapSuite.GisEditor.UIPlugin
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 is an abstract class. Also this is a base class which will be used for creating our own plugins
Remarks
<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. </remarks>
Inheritance Hierarchy
Members Summary
Public Constructors
| Name | Parameters | DeclaringType | Summary |
|---|
Protected Constructors
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 UIPlugin | Initializes a new instance of the class. |
Public Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 ApplySettings | StorableSettings | Plugin | Applies the settings to this plugin. |
| AttachMap | GisEditorWpfMap | Attaches the map. | |
| DetachMap | GisEditorWpfMap | Detaches the map. | |
| Equals | Object | Object | |
| GetHashCode | Object | ||
| GetLayerListItem | Object | Gets the layer list item. | |
| GetLayerListItemContextMenuItems | GetLayerListItemContextMenuParameters | Gets the layer list item context menu items. | |
| GetMapContextMenuItems | GetMapContextMenuParameters | Gets the map context menu items. | |
| GetSettings | Plugin | Gets plugin settings to save. | |
| GetSettingsUI | Plugin | Gets an UI that configures settings. | |
| GetType | Object | ||
| Load | Plugin | This method raises when load this plugin. | |
| 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. | |
| 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. |
| AttachMapCore | GisEditorWpfMap | Attaches the map core. | |
| DetachMapCore | GisEditorWpfMap | Detaches the map core. | |
| Finalize | Object | ||
| GetLayerListItemContextMenuItemsCore | GetLayerListItemContextMenuParameters | Gets the layer list item context menu items core. | |
| GetLayerListItemCore | Object | Gets the layer list item core. | |
| GetMapContextMenuItemsCore | GetMapContextMenuParameters | Gets the map context menu items core. | |
| GetSettingsCore | Plugin | Gets plugin settings to save. | |
| GetSettingsUICore | Plugin | Gets an UI that configures settings. | |
| LoadCore | Plugin(overriden) | This method raises when load this plugin. | |
| MemberwiseClone | Object | ||
| RefreshCore | GisEditorWpfMap, RefreshArgs | Refreshes the core. | |
| UnloadCore | Plugin(overriden) |
Public Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 ApplicationMenuItems | Collection<RibbonApplicationMenuItem> | Gets the application menu items. | |
| Author | String | Plugin | Gets or sets author information for plugin. |
| Description | String | Plugin | Gets or sets description for plugin. |
| DockWindows | Collection<DockWindow> | Each plugin can have multiple dockable contents. If it returns null, it meamns the plugin doesn't have DOCK window. | |
| 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. |
| IsHighlighted | Boolean | Gets or sets a value indicating whether this instance is highlighted. | |
| 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. |
| RibbonEntries | Collection<RibbonEntry> | Gets the ribbon entries. | |
| SmallIcon | ImageSource | Plugin | Gets or sets small icon path for plugin. |
| StatusBarItems | Collection<Object> | 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 |
|---|
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
AttachMap(GisEditorWpfMap)
Attaches the map.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| wpfMap | GisEditorWpfMap<!– ThinkGeo.MapSuite.WpfDesktopEdition.Extension.GisEditorWpfMap –> | The WPF map. |
<!– ThinkGeo.MapSuite.GisEditor.UIPlugin –> Go Back
DetachMap(GisEditorWpfMap)
Detaches the map.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| wpfMap | GisEditorWpfMap<!– ThinkGeo.MapSuite.WpfDesktopEdition.Extension.GisEditorWpfMap –> | The WPF map. |
<!– ThinkGeo.MapSuite.GisEditor.UIPlugin –> 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(Object)
Gets the layer list item.
Return Value
| Return Type | Description |
|---|---|
| LayerListItem<!– ThinkGeo.MapSuite.GisEditor.LayerListItem –> | a list item in the layer |
Parameters
| Name | Type | Description |
|---|---|---|
| concreteObject | Object<!– System.Object –> | The concrete object. |
<!– ThinkGeo.MapSuite.GisEditor.UIPlugin –> Go Back
GetLayerListItemContextMenuItems(GetLayerListItemContextMenuParameters)
Gets the layer list item context menu items.
Return Value
| Return Type | Description |
|---|---|
| Collection<MenuItem><!– System.Collections.ObjectModel.Collection{System.Windows.Controls.MenuItem} –> | Menu item collection |
Parameters
| Name | Type | Description |
|---|---|---|
| parameters | GetLayerListItemContextMenuParameters<!– ThinkGeo.MapSuite.GisEditor.GetLayerListItemContextMenuParameters –> | The e. |
<!– ThinkGeo.MapSuite.GisEditor.UIPlugin –> Go Back
GetMapContextMenuItems(GetMapContextMenuParameters)
Gets the map context menu items.
Return Value
| Return Type | Description |
|---|---|
| Collection<MenuItem><!– System.Collections.ObjectModel.Collection{System.Windows.Controls.MenuItem} –> | Menu item collection |
Parameters
| Name | Type | Description |
|---|---|---|
| parameters | GetMapContextMenuParameters<!– ThinkGeo.MapSuite.GisEditor.GetMapContextMenuParameters –> | The e. |
<!– ThinkGeo.MapSuite.GisEditor.UIPlugin –> 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
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
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<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| refreshArgs | RefreshArgs<!– ThinkGeo.MapSuite.GisEditor.RefreshArgs –> |
<!– ThinkGeo.MapSuite.GisEditor.UIPlugin –> 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
AttachMapCore(GisEditorWpfMap)
Attaches the map core.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| wpfMap | GisEditorWpfMap<!– ThinkGeo.MapSuite.WpfDesktopEdition.Extension.GisEditorWpfMap –> | The WPF map. |
<!– ThinkGeo.MapSuite.GisEditor.UIPlugin –> Go Back
DetachMapCore(GisEditorWpfMap)
Detaches the map core.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| wpfMap | GisEditorWpfMap<!– ThinkGeo.MapSuite.WpfDesktopEdition.Extension.GisEditorWpfMap –> | The WPF map. |
<!– ThinkGeo.MapSuite.GisEditor.UIPlugin –> Go Back
Finalize()
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
GetLayerListItemContextMenuItemsCore(GetLayerListItemContextMenuParameters)
Gets the layer list item context menu items core.
Return Value
| Return Type | Description |
|---|---|
| Collection<MenuItem><!– System.Collections.ObjectModel.Collection{System.Windows.Controls.MenuItem} –> | Menu item collection |
Parameters
| Name | Type | Description |
|---|---|---|
| parameters | GetLayerListItemContextMenuParameters<!– ThinkGeo.MapSuite.GisEditor.GetLayerListItemContextMenuParameters –> | The e. |
<!– ThinkGeo.MapSuite.GisEditor.UIPlugin –> Go Back
GetLayerListItemCore(Object)
Gets the layer list item core.
Return Value
| Return Type | Description |
|---|---|
| LayerListItem<!– ThinkGeo.MapSuite.GisEditor.LayerListItem –> | a list item in the layer |
Parameters
| Name | Type | Description |
|---|---|---|
| concreteObject | Object<!– System.Object –> | The concrete object. |
<!– ThinkGeo.MapSuite.GisEditor.UIPlugin –> Go Back
GetMapContextMenuItemsCore(GetMapContextMenuParameters)
Gets the map context menu items core.
Return Value
| Return Type | Description |
|---|---|
| Collection<MenuItem><!– System.Collections.ObjectModel.Collection{System.Windows.Controls.MenuItem} –> | Menu item collection |
Parameters
| Name | Type | Description |
|---|---|---|
| parameters | GetMapContextMenuParameters<!– ThinkGeo.MapSuite.GisEditor.GetMapContextMenuParameters –> | The e. |
<!– ThinkGeo.MapSuite.GisEditor.UIPlugin –> 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
LoadCore()
This method raises when load this plugin.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.GisEditor.Plugin(overriden) –> Go Back
MemberwiseClone()
Return Value
| Return Type | Description |
|---|---|
| Object<!– System.Object –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
RefreshCore(GisEditorWpfMap, RefreshArgs)
Refreshes the core.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| currentMap | GisEditorWpfMap<!– ThinkGeo.MapSuite.WpfDesktopEdition.Extension.GisEditorWpfMap –> | The current map. |
| refreshArgs | RefreshArgs<!– ThinkGeo.MapSuite.GisEditor.RefreshArgs –> | The refresh args. |
<!– ThinkGeo.MapSuite.GisEditor.UIPlugin –> Go Back
UnloadCore()
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.GisEditor.Plugin(overriden) –> Go Back
Public Properties
ApplicationMenuItems
Gets the application menu items.
Return Value
| Return Type |
|---|
| Collection<RibbonApplicationMenuItem><!– System.Collections.ObjectModel.Collection{Microsoft.Windows.Controls.Ribbon.RibbonApplicationMenuItem} –> |
<!– ThinkGeo.MapSuite.GisEditor.UIPlugin –> Go Back
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
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<DockWindow><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.GisEditor.DockWindow} –> |
<!– ThinkGeo.MapSuite.GisEditor.UIPlugin –> 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
IsHighlighted
Gets or sets a value indicating whether this instance is highlighted.
Return Value
| Return Type |
|---|
| Boolean<!– System.Boolean –> |
<!– ThinkGeo.MapSuite.GisEditor.UIPlugin –> 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
RibbonEntries
Gets the ribbon entries.
Return Value
| Return Type |
|---|
| Collection<RibbonEntry><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.GisEditor.RibbonEntry} –> |
<!– ThinkGeo.MapSuite.GisEditor.UIPlugin –> 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
StatusBarItems
Use this property to add status bar items on the explorere.
Return Value
| Return Type |
|---|
| Collection<Object><!– System.Collections.ObjectModel.Collection{System.Object} –> |
<!– ThinkGeo.MapSuite.GisEditor.UIPlugin –> Go Back
Protected Properties
Public Events
thinkgeo.mapsuite.giseditor.uiplugin.txt · Last modified: 2017/03/16 21:59 (external edit)