====== ThinkGeo.MapSuite.GisEditor.TaskPlugin ======

{{section>upgrade_map_suite_to_10.0}}




<!-- Class -->
===== Inheritance Hierarchy =====
*System.Object
**[[ThinkGeo.MapSuite.GisEditor.Plugin]]
***[[ThinkGeo.MapSuite.GisEditor.TaskPlugin]]
===== Members Summary =====
==== Public Constructors ====
^ Name ^ Parameters ^ DeclaringType ^ Summary ^

==== Protected Constructors ====
^ Name ^ Parameters ^ DeclaringType ^ Summary ^
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#TaskPlugin()|TaskPlugin]]   |    |    | 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}}[[#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}}[[#Run()|Run]]   |    |    | Runs this instance.   |
| {{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}}[[#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}}[[#OnUpdatingProgress(UpdatingTaskProgressEventArgs)|OnUpdatingProgress]]   | [[ThinkGeo.MapSuite.GisEditor.UpdatingTaskProgressEventArgs|UpdatingTaskProgressEventArgs]]   |    | Raises the event.   |
| {{wiki:ProtectedMethod.gif|Protected Method}}[[#RunCore()|RunCore]]   |    |    | Runs the core.   |
| {{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}}[[#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}}[[#UpdatingProgress|UpdatingProgress]]   | [[ThinkGeo.MapSuite.GisEditor.UpdatingTaskProgressEventArgs|UpdatingTaskProgressEventArgs]]   |    | Occurs when [[updating|progress]].   |

===== Public Constructors =====
===== Protected Constructors =====
==== TaskPlugin() ====
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<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| settings   | [[ThinkGeo.MapSuite.GisEditor.StorableSettings|StorableSettings]]<!-- ThinkGeo.MapSuite.GisEditor.StorableSettings -->   | The settings to be applied to this plugin.   |

<!-- ThinkGeo.MapSuite.GisEditor.Plugin -->
[[#Public Methods|Go Back]]
==== Equals(Object) ====
=== Return Value ===
^ Return Type ^ Description ^
| Boolean<!-- System.Boolean -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| obj   | Object<!-- System.Object -->   |    |

<!-- System.Object -->
[[#Public Methods|Go Back]]
==== GetHashCode() ====
=== Return Value ===
^ Return Type ^ Description ^
| Int32<!-- System.Int32 -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- System.Object -->
[[#Public Methods|Go Back]]
==== GetSettings() ====
Gets plugin settings to save.
=== Return Value ===
^ Return Type ^ Description ^
| [[ThinkGeo.MapSuite.GisEditor.StorableSettings|StorableSettings]]<!-- ThinkGeo.MapSuite.GisEditor.StorableSettings -->   | Plugin's settings to save.   |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.GisEditor.Plugin -->
[[#Public Methods|Go Back]]
==== GetSettingsUI() ====
Gets an UI that configures settings.
=== Return Value ===
^ Return Type ^ Description ^
| [[ThinkGeo.MapSuite.GisEditor.SettingUserControl|SettingUserControl]]<!-- ThinkGeo.MapSuite.GisEditor.SettingUserControl -->   | A SettingUserControl that configures settings.   |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.GisEditor.Plugin -->
[[#Public Methods|Go Back]]
==== GetType() ====
=== Return Value ===
^ Return Type ^ Description ^
| Type<!-- System.Type -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- System.Object -->
[[#Public Methods|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 -->
[[#Public Methods|Go Back]]
==== Run() ====
Runs this instance.
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.GisEditor.TaskPlugin -->
[[#Public Methods|Go Back]]
==== ToString() ====
=== Return Value ===
^ Return Type ^ Description ^
| String<!-- System.String -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- System.Object -->
[[#Public Methods|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 -->
[[#Public Methods|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   | [[ThinkGeo.MapSuite.GisEditor.StorableSettings|StorableSettings]]<!-- ThinkGeo.MapSuite.GisEditor.StorableSettings -->   | The settings to be applied to this plugin.   |

<!-- ThinkGeo.MapSuite.GisEditor.Plugin -->
[[#Protected Methods|Go Back]]
==== Finalize() ====
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- System.Object -->
[[#Protected Methods|Go Back]]
==== GetSettingsCore() ====
Gets plugin settings to save.
=== Return Value ===
^ Return Type ^ Description ^
| [[ThinkGeo.MapSuite.GisEditor.StorableSettings|StorableSettings]]<!-- ThinkGeo.MapSuite.GisEditor.StorableSettings -->   | Plugin's settings to save.   |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.GisEditor.Plugin -->
[[#Protected Methods|Go Back]]
==== GetSettingsUICore() ====
Gets an UI that configures settings.
=== Return Value ===
^ Return Type ^ Description ^
| [[ThinkGeo.MapSuite.GisEditor.SettingUserControl|SettingUserControl]]<!-- ThinkGeo.MapSuite.GisEditor.SettingUserControl -->   | A SettingUserControl that configures settings.   |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.GisEditor.Plugin -->
[[#Protected Methods|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) -->
[[#Protected Methods|Go Back]]
==== MemberwiseClone() ====
=== Return Value ===
^ Return Type ^ Description ^
| Object<!-- System.Object -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- System.Object -->
[[#Protected Methods|Go Back]]
==== OnUpdatingProgress(UpdatingTaskProgressEventArgs) ====
Raises the event.
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^
| e   | [[ThinkGeo.MapSuite.GisEditor.UpdatingTaskProgressEventArgs|UpdatingTaskProgressEventArgs]]<!-- ThinkGeo.MapSuite.GisEditor.UpdatingTaskProgressEventArgs -->   | The instance containing the event data.   |

<!-- ThinkGeo.MapSuite.GisEditor.TaskPlugin -->
[[#Protected Methods|Go Back]]
==== RunCore() ====
Runs the core.
=== Return Value ===
^ Return Type ^ Description ^
| Void<!-- System.Void -->   |    |

=== Parameters ===
^  Name ^  Type ^  Description ^

<!-- ThinkGeo.MapSuite.GisEditor.TaskPlugin -->
[[#Protected Methods|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 -->
[[#Protected Methods|Go Back]]
===== Public Properties =====
==== Author ====
Gets or sets author information for plugin.
=== Return Value ===
^ Return Type ^
| String<!-- System.String -->   |

<!-- ThinkGeo.MapSuite.GisEditor.Plugin -->
[[#Public Properties|Go Back]]
==== Description ====
Gets or sets description for plugin.
=== Return Value ===
^ Return Type ^
| String<!-- System.String -->   |

<!-- ThinkGeo.MapSuite.GisEditor.Plugin -->
[[#Public Properties|Go Back]]
==== Id ====
Gets the identify of plugin.
=== Return Value ===
^ Return Type ^
| String<!-- System.String -->   |

<!-- ThinkGeo.MapSuite.GisEditor.Plugin -->
[[#Public Properties|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 -->
[[#Public Properties|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 -->
[[#Public Properties|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 -->
[[#Public Properties|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 -->
[[#Public Properties|Go Back]]
==== Name ====
Gets or sets the name of plugin.
=== Return Value ===
^ Return Type ^
| String<!-- System.String -->   |

<!-- ThinkGeo.MapSuite.GisEditor.Plugin -->
[[#Public Properties|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 -->
[[#Public Properties|Go Back]]
===== Protected Properties =====
===== Public Events =====
==== UpdatingProgress ====
Occurs when [[updating|progress]].
=== Event Arguments ===
^ Event Arguments ^
| [[ThinkGeo.MapSuite.GisEditor.UpdatingTaskProgressEventArgs|UpdatingTaskProgressEventArgs]]<!-- ThinkGeo.MapSuite.GisEditor.UpdatingTaskProgressEventArgs -->   |

<!-- ThinkGeo.MapSuite.GisEditor.TaskPlugin -->
[[#Public Events|Go Back]]

__NOTOC__
[[Category:GisEditorInfrastructure]]
[[Category:ThinkGeo.MapSuite.GisEditor]]
[[Category:UpdateDocumentation]]