ThinkGeo Cloud
ThinkGeo UI Controls
ThinkGeo Open Source
Help and Support
External Resources
Sidebar
thinkgeo.mapsuite.giseditor.projectplugin
Table of Contents
ThinkGeo.MapSuite.GisEditor.ProjectPlugin
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 plugin for project.
Inheritance Hierarchy
Members Summary
Public Constructors
| Name | Parameters | DeclaringType | Summary |
|---|
Protected Constructors
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 ProjectPlugin | Initializes a new instance of the class. |
Public Methods
| Name | Parameters | DeclaringType | Summary |
|---|---|---|---|
 ApplySettings | StorableSettings | Plugin | Applies the settings to this plugin. |
| Equals | Object | Object | |
| GetHashCode | Object | ||
| GetOpenProjectIcon | Gets the open project icon. | ||
| GetProjectFullName | Uri | Gets the full name of the project. | |
| GetProjectSaveAsUri | Gets the project save as URI. | ||
| GetProjectShortName | Uri | Gets the short name of the project. | |
| GetSaveProjectIcon | Gets the save project icon. | ||
| 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. | |
| LoadProjectStream | ProjectStreamInfo | Loads the project stream. | |
| ProjectExists | Uri | Projects the exists. | |
| SaveProjectStream | ProjectStreamInfo | Saves the project stream. | |
| 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. |
| Finalize | Object | ||
| GetOpenProjectIconCore | Gets the open project icon core. | ||
| GetProjectFullNameCore | Uri | Gets the project full name core. | |
| GetProjectSaveAsUriCore | Gets the project save as URI core. | ||
| GetProjectShortNameCore | Uri | Gets the project short name core. | |
| GetSaveProjectIconCore | Gets the save project icon core. | ||
| GetSettingsCore | Plugin | Gets plugin settings to save. | |
| GetSettingsUICore | Plugin | Gets an UI that configures settings. | |
| LoadCore | Plugin | This method raises when load this plugin. | |
| LoadProjectStreamCore | ProjectStreamInfo | Loads the project stream core. | |
| MemberwiseClone | Object | ||
| ProjectExistsCore | Uri | Projects the exists core. | |
| SaveProjectStreamCore | ProjectStreamInfo | Saves the project stream core. | |
| UnloadCore | Plugin | This method raises when unload this plugin. |
Public Properties
| Name | Return | DeclaringType | Summary |
|---|---|---|---|
 Author | String | Plugin | Gets or sets author information for plugin. |
| Description | String | Plugin | Gets or sets description for plugin. |
| 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. |
| 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. |
| SmallIcon | 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
ProjectPlugin()
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
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
GetOpenProjectIcon()
Gets the open project icon.
Return Value
| Return Type | Description |
|---|---|
| ImageSource<!– System.Windows.Media.ImageSource –> | An icon for current project plugin |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.GisEditor.ProjectPlugin –> Go Back
GetProjectFullName(Uri)
Gets the full name of the project.
Return Value
| Return Type | Description |
|---|---|
| String<!– System.String –> | The project full name |
Parameters
| Name | Type | Description |
|---|---|---|
| projectUri | Uri<!– System.Uri –> | The project URI. |
<!– ThinkGeo.MapSuite.GisEditor.ProjectPlugin –> Go Back
GetProjectSaveAsUri()
Gets the project save as URI.
Return Value
| Return Type | Description |
|---|---|
| ProjectSaveAsResult<!– ThinkGeo.MapSuite.GisEditor.ProjectSaveAsResult –> | An project URI result |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.GisEditor.ProjectPlugin –> Go Back
GetProjectShortName(Uri)
Gets the short name of the project.
Return Value
| Return Type | Description |
|---|---|
| String<!– System.String –> | The project shut name |
Parameters
| Name | Type | Description |
|---|---|---|
| projectUri | Uri<!– System.Uri –> | The project URI. |
<!– ThinkGeo.MapSuite.GisEditor.ProjectPlugin –> Go Back
GetSaveProjectIcon()
Gets the save project icon.
Return Value
| Return Type | Description |
|---|---|
| ImageSource<!– System.Windows.Media.ImageSource –> | An icon for saving project |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.GisEditor.ProjectPlugin –> 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
LoadProjectStream(ProjectStreamInfo)
Loads the project stream.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| projectStreamInfo | ProjectStreamInfo<!– ThinkGeo.MapSuite.GisEditor.ProjectStreamInfo –> | The project stream info. |
<!– ThinkGeo.MapSuite.GisEditor.ProjectPlugin –> Go Back
ProjectExists(Uri)
Projects the exists.
Return Value
| Return Type | Description |
|---|---|
| Boolean<!– System.Boolean –> | project exists |
Parameters
| Name | Type | Description |
|---|---|---|
| projectUri | Uri<!– System.Uri –> | The project URI. |
<!– ThinkGeo.MapSuite.GisEditor.ProjectPlugin –> Go Back
SaveProjectStream(ProjectStreamInfo)
Saves the project stream.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| projectStreamInfo | ProjectStreamInfo<!– ThinkGeo.MapSuite.GisEditor.ProjectStreamInfo –> | The project stream info. |
<!– ThinkGeo.MapSuite.GisEditor.ProjectPlugin –> 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
GetOpenProjectIconCore()
Gets the open project icon core.
Return Value
| Return Type | Description |
|---|---|
| ImageSource<!– System.Windows.Media.ImageSource –> | An icon for open project |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.GisEditor.ProjectPlugin –> Go Back
GetProjectFullNameCore(Uri)
Gets the project full name core.
Return Value
| Return Type | Description |
|---|---|
| String<!– System.String –> | The project full name |
Parameters
| Name | Type | Description |
|---|---|---|
| projectUri | Uri<!– System.Uri –> | The project URI. |
<!– ThinkGeo.MapSuite.GisEditor.ProjectPlugin –> Go Back
GetProjectSaveAsUriCore()
Gets the project save as URI core.
Return Value
| Return Type | Description |
|---|---|
| ProjectSaveAsResult<!– ThinkGeo.MapSuite.GisEditor.ProjectSaveAsResult –> | An project URI result |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.GisEditor.ProjectPlugin –> Go Back
GetProjectShortNameCore(Uri)
Gets the project short name core.
Return Value
| Return Type | Description |
|---|---|
| String<!– System.String –> | The project short name |
Parameters
| Name | Type | Description |
|---|---|---|
| projectUri | Uri<!– System.Uri –> | The project URI. |
<!– ThinkGeo.MapSuite.GisEditor.ProjectPlugin –> Go Back
GetSaveProjectIconCore()
Gets the save project icon core.
Return Value
| Return Type | Description |
|---|---|
| ImageSource<!– System.Windows.Media.ImageSource –> | An icon for saving project |
Parameters
| Name | Type | Description |
|---|
<!– ThinkGeo.MapSuite.GisEditor.ProjectPlugin –> 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 –> Go Back
LoadProjectStreamCore(ProjectStreamInfo)
Loads the project stream core.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| projectStreamInfo | ProjectStreamInfo<!– ThinkGeo.MapSuite.GisEditor.ProjectStreamInfo –> | The project stream info. |
<!– ThinkGeo.MapSuite.GisEditor.ProjectPlugin –> Go Back
MemberwiseClone()
Return Value
| Return Type | Description |
|---|---|
| Object<!– System.Object –> |
Parameters
| Name | Type | Description |
|---|
<!– System.Object –> Go Back
ProjectExistsCore(Uri)
Projects the exists core.
Return Value
| Return Type | Description |
|---|---|
| Boolean<!– System.Boolean –> | project exists |
Parameters
| Name | Type | Description |
|---|---|---|
| projectUri | Uri<!– System.Uri –> | The project URI. |
<!– ThinkGeo.MapSuite.GisEditor.ProjectPlugin –> Go Back
SaveProjectStreamCore(ProjectStreamInfo)
Saves the project stream core.
Return Value
| Return Type | Description |
|---|---|
| Void<!– System.Void –> |
Parameters
| Name | Type | Description |
|---|---|---|
| projectStreamInfo | ProjectStreamInfo<!– ThinkGeo.MapSuite.GisEditor.ProjectStreamInfo –> | The project stream info. |
<!– ThinkGeo.MapSuite.GisEditor.ProjectPlugin –> 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
<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
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
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
Protected Properties
Public Events
thinkgeo.mapsuite.giseditor.projectplugin.txt · Last modified: 2017/03/16 21:59 (external edit)