====== ThinkGeo.MapSuite.GisEditor.ProjectPlugin ====== {{section>upgrade_map_suite_to_10.0}} This class represents a plugin for project. ===== Inheritance Hierarchy ===== *System.Object **[[ThinkGeo.MapSuite.GisEditor.Plugin]] ***[[ThinkGeo.MapSuite.GisEditor.ProjectPlugin]] ===== Members Summary ===== ==== Public Constructors ==== ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ ==== Protected Constructors ==== ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | {{wiki:ProtectedMethod.gif|Protected Method}}[[#ProjectPlugin()|ProjectPlugin]] | | | 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}}[[#GetOpenProjectIcon()|GetOpenProjectIcon]] | | | Gets the open project icon. | | {{wiki:PublicMethod.gif|Public Method}}[[#GetProjectFullName(Uri)|GetProjectFullName]] | Uri | | Gets the full name of the project. | | {{wiki:PublicMethod.gif|Public Method}}[[#GetProjectSaveAsUri()|GetProjectSaveAsUri]] | | | Gets the project save as URI. | | {{wiki:PublicMethod.gif|Public Method}}[[#GetProjectShortName(Uri)|GetProjectShortName]] | Uri | | Gets the short name of the project. | | {{wiki:PublicMethod.gif|Public Method}}[[#GetSaveProjectIcon()|GetSaveProjectIcon]] | | | Gets the save project icon. | | {{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}}[[#LoadProjectStream(ProjectStreamInfo)|LoadProjectStream]] | [[ThinkGeo.MapSuite.GisEditor.ProjectStreamInfo|ProjectStreamInfo]] | | Loads the project stream. | | {{wiki:PublicMethod.gif|Public Method}}[[#ProjectExists(Uri)|ProjectExists]] | Uri | | Projects the exists. | | {{wiki:PublicMethod.gif|Public Method}}[[#SaveProjectStream(ProjectStreamInfo)|SaveProjectStream]] | [[ThinkGeo.MapSuite.GisEditor.ProjectStreamInfo|ProjectStreamInfo]] | | Saves the project stream. | | {{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}}[[#GetOpenProjectIconCore()|GetOpenProjectIconCore]] | | | Gets the open project icon core. | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetProjectFullNameCore(Uri)|GetProjectFullNameCore]] | Uri | | Gets the project full name core. | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetProjectSaveAsUriCore()|GetProjectSaveAsUriCore]] | | | Gets the project save as URI core. | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetProjectShortNameCore(Uri)|GetProjectShortNameCore]] | Uri | | Gets the project short name core. | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetSaveProjectIconCore()|GetSaveProjectIconCore]] | | | Gets the save project icon 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]] | This method raises when load this plugin. | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#LoadProjectStreamCore(ProjectStreamInfo)|LoadProjectStreamCore]] | [[ThinkGeo.MapSuite.GisEditor.ProjectStreamInfo|ProjectStreamInfo]] | | Loads the project stream core. | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#ProjectExistsCore(Uri)|ProjectExistsCore]] | Uri | | Projects the exists core. | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#SaveProjectStreamCore(ProjectStreamInfo)|SaveProjectStreamCore]] | [[ThinkGeo.MapSuite.GisEditor.ProjectStreamInfo|ProjectStreamInfo]] | | Saves the project stream 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 ^ ===== Public Constructors ===== ===== Protected Constructors ===== ==== ProjectPlugin() ==== 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]] ==== 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]] ==== GetOpenProjectIcon() ==== Gets the open project icon. === Return Value === ^ Return Type ^ Description ^ | ImageSource | An icon for current project plugin | === Parameters === ^ Name ^ Type ^ Description ^ [[#Public Methods|Go Back]] ==== GetProjectFullName(Uri) ==== Gets the full name of the project. === Return Value === ^ Return Type ^ Description ^ | String | The project full name | === Parameters === ^ Name ^ Type ^ Description ^ | projectUri | Uri | The project URI. | [[#Public Methods|Go Back]] ==== GetProjectSaveAsUri() ==== Gets the project save as URI. === Return Value === ^ Return Type ^ Description ^ | [[ThinkGeo.MapSuite.GisEditor.ProjectSaveAsResult|ProjectSaveAsResult]] | An project URI result | === Parameters === ^ Name ^ Type ^ Description ^ [[#Public Methods|Go Back]] ==== GetProjectShortName(Uri) ==== Gets the short name of the project. === Return Value === ^ Return Type ^ Description ^ | String | The project shut name | === Parameters === ^ Name ^ Type ^ Description ^ | projectUri | Uri | The project URI. | [[#Public Methods|Go Back]] ==== GetSaveProjectIcon() ==== Gets the save project icon. === Return Value === ^ Return Type ^ Description ^ | ImageSource | An icon for saving project | === Parameters === ^ Name ^ Type ^ Description ^ [[#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]] ==== LoadProjectStream(ProjectStreamInfo) ==== Loads the project stream. === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ | projectStreamInfo | [[ThinkGeo.MapSuite.GisEditor.ProjectStreamInfo|ProjectStreamInfo]] | The project stream info. | [[#Public Methods|Go Back]] ==== ProjectExists(Uri) ==== Projects the exists. === Return Value === ^ Return Type ^ Description ^ | Boolean | project exists | === Parameters === ^ Name ^ Type ^ Description ^ | projectUri | Uri | The project URI. | [[#Public Methods|Go Back]] ==== SaveProjectStream(ProjectStreamInfo) ==== Saves the project stream. === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ | projectStreamInfo | [[ThinkGeo.MapSuite.GisEditor.ProjectStreamInfo|ProjectStreamInfo]] | The project stream info. | [[#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]] ==== Finalize() ==== === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ [[#Protected Methods|Go Back]] ==== GetOpenProjectIconCore() ==== Gets the open project icon core. === Return Value === ^ Return Type ^ Description ^ | ImageSource | An icon for open project | === Parameters === ^ Name ^ Type ^ Description ^ [[#Protected Methods|Go Back]] ==== GetProjectFullNameCore(Uri) ==== Gets the project full name core. === Return Value === ^ Return Type ^ Description ^ | String | The project full name | === Parameters === ^ Name ^ Type ^ Description ^ | projectUri | Uri | The project URI. | [[#Protected Methods|Go Back]] ==== GetProjectSaveAsUriCore() ==== Gets the project save as URI core. === Return Value === ^ Return Type ^ Description ^ | [[ThinkGeo.MapSuite.GisEditor.ProjectSaveAsResult|ProjectSaveAsResult]] | An project URI result | === Parameters === ^ Name ^ Type ^ Description ^ [[#Protected Methods|Go Back]] ==== GetProjectShortNameCore(Uri) ==== Gets the project short name core. === Return Value === ^ Return Type ^ Description ^ | String | The project short name | === Parameters === ^ Name ^ Type ^ Description ^ | projectUri | Uri | The project URI. | [[#Protected Methods|Go Back]] ==== GetSaveProjectIconCore() ==== Gets the save project icon core. === Return Value === ^ Return Type ^ Description ^ | ImageSource | An icon for saving project | === Parameters === ^ Name ^ Type ^ Description ^ [[#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]] ==== LoadProjectStreamCore(ProjectStreamInfo) ==== Loads the project stream core. === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ | projectStreamInfo | [[ThinkGeo.MapSuite.GisEditor.ProjectStreamInfo|ProjectStreamInfo]] | The project stream info. | [[#Protected Methods|Go Back]] ==== MemberwiseClone() ==== === Return Value === ^ Return Type ^ Description ^ | Object | | === Parameters === ^ Name ^ Type ^ Description ^ [[#Protected Methods|Go Back]] ==== ProjectExistsCore(Uri) ==== Projects the exists core. === Return Value === ^ Return Type ^ Description ^ | Boolean | project exists | === Parameters === ^ Name ^ Type ^ Description ^ | projectUri | Uri | The project URI. | [[#Protected Methods|Go Back]] ==== SaveProjectStreamCore(ProjectStreamInfo) ==== Saves the project stream core. === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ | projectStreamInfo | [[ThinkGeo.MapSuite.GisEditor.ProjectStreamInfo|ProjectStreamInfo]] | The project stream info. | [[#Protected Methods|Go Back]] ==== UnloadCore() ==== This method raises when unload this plugin. === Return Value === ^ Return Type ^ Description ^ | Void | | === Parameters === ^ Name ^ Type ^ Description ^ [[#Protected Methods|Go Back]] ===== Public Properties ===== ==== 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]] ==== 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]] ==== 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]] ==== 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]] ===== Protected Properties ===== ===== Public Events ===== __NOTOC__ [[Category:GisEditorInfrastructure]] [[Category:ThinkGeo.MapSuite.GisEditor]] [[Category:UpdateDocumentation]]