User Tools

Site Tools


thinkgeo.mapsuite.giseditor.controlplugin

ThinkGeo.MapSuite.GisEditor.ControlPlugin

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 represents a control plugin

Inheritance Hierarchy

Members Summary

Public Constructors

Name Parameters DeclaringType Summary

Protected Constructors

Name Parameters DeclaringType Summary
Protected MethodControlPlugin Initializes a new instance of the class.

Public Methods

Name Parameters DeclaringType Summary
Public MethodApplySettings StorableSettings Plugin Applies the settings to this plugin.
Public MethodEquals Object Object
Public MethodGetHashCode Object
Public MethodGetSettings Plugin Gets plugin settings to save.
Public MethodGetSettingsUI Plugin Gets an UI that configures settings.
Public MethodGetType Object
Public MethodGetUI Gets the UI.
Public MethodLoad Plugin This method raises when load this plugin.
Public MethodToString Object
Public MethodUnload Plugin This method raises when unload this plugin.

Protected Methods

Name Parameters DeclaringType Summary
Protected MethodApplySettingsCore StorableSettings Plugin Applies the settings to this plugin.
Protected MethodFinalize Object
Protected MethodGetSettingsCore Plugin Gets plugin settings to save.
Protected MethodGetSettingsUICore Plugin Gets an UI that configures settings.
Protected MethodGetUICore Gets the UI core.
Protected MethodLoadCore Plugin This method raises when load this plugin.
Protected MethodMemberwiseClone Object
Protected MethodUnloadCore Plugin This method raises when unload this plugin.

Public Properties

Name Return DeclaringType Summary
Public PropertyAuthor String Plugin Gets or sets author information for plugin.
Public PropertyDescription String Plugin Gets or sets description for plugin.
Public PropertyId String Plugin Gets the identify of plugin.
Public PropertyIndex Int32 Plugin Gets or sets the index of the plugin.
Public PropertyIsActive Boolean Plugin Gets or sets a value indicating whether this plugin is active.
Public PropertyIsRequired Boolean Plugin Gets or sets a value indicating whether this plugin is required.
Public PropertyLargeIcon ImageSource Plugin Gets or sets large icon for plugin.
Public PropertyName String Plugin Gets or sets the name of plugin.
Public PropertySmallIcon ImageSource Plugin Gets or sets small icon path for plugin.

Protected Properties

Name Return DeclaringType Summary

Public Events

Name Event Arguments DeclaringType Summary

Public Constructors

Protected Constructors

ControlPlugin()

Initializes a new instance of the class.

Parameters

Name Type Description

Go Back

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

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

GetUI()

Gets the UI.

Return Value

Return Type Description
FrameworkElement<!– System.Windows.FrameworkElement –> The framework element

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.GisEditor.ControlPlugin –> 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

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

GetUICore()

Gets the UI core.

Return Value

Return Type Description
FrameworkElement<!– System.Windows.FrameworkElement –> The framework element

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.GisEditor.ControlPlugin –> 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

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

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

Plugins are orded by this property.

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

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<!– 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

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<!– System.Windows.Media.ImageSource –>

<!– ThinkGeo.MapSuite.GisEditor.Plugin –> Go Back

Protected Properties

Public Events

thinkgeo.mapsuite.giseditor.controlplugin.txt · Last modified: 2017/03/16 21:59 (external edit)