diff options
Diffstat (limited to '')
37 files changed, 7353 insertions, 71 deletions
diff --git a/OpenSim/Addons/Groups/Properties/AssemblyInfo.cs b/OpenSim/Addons/Groups/Properties/AssemblyInfo.cs index 238c9a6..aa31a14 100644 --- a/OpenSim/Addons/Groups/Properties/AssemblyInfo.cs +++ b/OpenSim/Addons/Groups/Properties/AssemblyInfo.cs | |||
@@ -33,4 +33,4 @@ using Mono.Addins; | |||
33 | [assembly: AssemblyVersion("0.8.1.*")] | 33 | [assembly: AssemblyVersion("0.8.1.*")] |
34 | 34 | ||
35 | [assembly: Addin("OpenSim.Groups", "0.1")] | 35 | [assembly: Addin("OpenSim.Groups", "0.1")] |
36 | [assembly: AddinDependency("OpenSim", "0.5")] | 36 | [assembly: AddinDependency("OpenSim.Region.Framework", "0.8.1")] |
diff --git a/OpenSim/Addons/OfflineIM/Properties/AssemblyInfo.cs b/OpenSim/Addons/OfflineIM/Properties/AssemblyInfo.cs index 91a9400..054e1fb 100644 --- a/OpenSim/Addons/OfflineIM/Properties/AssemblyInfo.cs +++ b/OpenSim/Addons/OfflineIM/Properties/AssemblyInfo.cs | |||
@@ -33,4 +33,4 @@ using Mono.Addins; | |||
33 | [assembly: AssemblyVersion("0.8.1.*")] | 33 | [assembly: AssemblyVersion("0.8.1.*")] |
34 | 34 | ||
35 | [assembly: Addin("OpenSim.OfflineIM", "0.1")] | 35 | [assembly: Addin("OpenSim.OfflineIM", "0.1")] |
36 | [assembly: AddinDependency("OpenSim", "0.5")] | 36 | [assembly: AddinDependency("OpenSim.Region.Framework", "0.8.1")] |
diff --git a/OpenSim/ApplicationPlugins/LoadRegions/LoadRegionsPlugin.cs b/OpenSim/ApplicationPlugins/LoadRegions/LoadRegionsPlugin.cs index 3455411..74d9ae4 100644 --- a/OpenSim/ApplicationPlugins/LoadRegions/LoadRegionsPlugin.cs +++ b/OpenSim/ApplicationPlugins/LoadRegions/LoadRegionsPlugin.cs | |||
@@ -40,9 +40,11 @@ using OpenSim.Region.CoreModules.Scripting.DynamicTexture; | |||
40 | using OpenSim.Region.CoreModules.Scripting.LoadImageURL; | 40 | using OpenSim.Region.CoreModules.Scripting.LoadImageURL; |
41 | using OpenSim.Region.CoreModules.Scripting.XMLRPC; | 41 | using OpenSim.Region.CoreModules.Scripting.XMLRPC; |
42 | using OpenSim.Services.Interfaces; | 42 | using OpenSim.Services.Interfaces; |
43 | using Mono.Addins; | ||
43 | 44 | ||
44 | namespace OpenSim.ApplicationPlugins.LoadRegions | 45 | namespace OpenSim.ApplicationPlugins.LoadRegions |
45 | { | 46 | { |
47 | [Extension(Path="/OpenSim/Startup", Id="LoadRegions", NodeName="Plugin")] | ||
46 | public class LoadRegionsPlugin : IApplicationPlugin, IRegionCreator | 48 | public class LoadRegionsPlugin : IApplicationPlugin, IRegionCreator |
47 | { | 49 | { |
48 | private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType); | 50 | private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType); |
diff --git a/OpenSim/ApplicationPlugins/LoadRegions/Properties/AssemblyInfo.cs b/OpenSim/ApplicationPlugins/LoadRegions/Properties/AssemblyInfo.cs index 89d24ac..d289e78 100644 --- a/OpenSim/ApplicationPlugins/LoadRegions/Properties/AssemblyInfo.cs +++ b/OpenSim/ApplicationPlugins/LoadRegions/Properties/AssemblyInfo.cs | |||
@@ -27,16 +27,17 @@ | |||
27 | 27 | ||
28 | using System.Reflection; | 28 | using System.Reflection; |
29 | using System.Runtime.InteropServices; | 29 | using System.Runtime.InteropServices; |
30 | using Mono.Addins; | ||
30 | 31 | ||
31 | // General information about an assembly is controlled through the following | 32 | // General information about an assembly is controlled through the following |
32 | // set of attributes. Change these attribute values to modify the information | 33 | // set of attributes. Change these attribute values to modify the information |
33 | // associated with an assembly. | 34 | // associated with an assembly. |
34 | 35 | ||
35 | [assembly : AssemblyTitle("OpenSim.Addin")] | 36 | [assembly : AssemblyTitle("OpenSim.ApplicationPlugins.LoadRegions")] |
36 | [assembly : AssemblyDescription("")] | 37 | [assembly : AssemblyDescription("")] |
37 | [assembly : AssemblyConfiguration("")] | 38 | [assembly : AssemblyConfiguration("")] |
38 | [assembly : AssemblyCompany("http://opensimulator.org")] | 39 | [assembly : AssemblyCompany("http://opensimulator.org")] |
39 | [assembly : AssemblyProduct("OpenSim.Addin")] | 40 | [assembly : AssemblyProduct("OpenSim")] |
40 | [assembly : AssemblyCopyright("Copyright © OpenSimulator.org Developers 2007-2009")] | 41 | [assembly : AssemblyCopyright("Copyright © OpenSimulator.org Developers 2007-2009")] |
41 | [assembly : AssemblyTrademark("")] | 42 | [assembly : AssemblyTrademark("")] |
42 | [assembly : AssemblyCulture("")] | 43 | [assembly : AssemblyCulture("")] |
@@ -63,3 +64,6 @@ using System.Runtime.InteropServices; | |||
63 | // [assembly: AssemblyVersion("0.7.6.*")] | 64 | // [assembly: AssemblyVersion("0.7.6.*")] |
64 | 65 | ||
65 | [assembly : AssemblyVersion("0.8.1.*")] | 66 | [assembly : AssemblyVersion("0.8.1.*")] |
67 | |||
68 | [assembly: Addin("OpenSim.ApplicationPlugins.LoadRegions", "0.1")] | ||
69 | [assembly: AddinDependency("OpenSim", "0.8.1")] | ||
diff --git a/OpenSim/ApplicationPlugins/LoadRegions/Resources/LoadRegionsPlugin.addin.xml b/OpenSim/ApplicationPlugins/LoadRegions/Resources/LoadRegionsPlugin.addin.xml deleted file mode 100644 index 37222b7..0000000 --- a/OpenSim/ApplicationPlugins/LoadRegions/Resources/LoadRegionsPlugin.addin.xml +++ /dev/null | |||
@@ -1,11 +0,0 @@ | |||
1 | <Addin id="OpenSim.ApplicationPlugins.LoadRegions" version="0.1"> | ||
2 | <Runtime> | ||
3 | <Import assembly="OpenSim.ApplicationPlugins.LoadRegions.dll"/> | ||
4 | </Runtime> | ||
5 | <Dependencies> | ||
6 | <Addin id="OpenSim" version="0.5" /> | ||
7 | </Dependencies> | ||
8 | <Extension path = "/OpenSim/Startup"> | ||
9 | <Plugin id="LoadRegions" type="OpenSim.ApplicationPlugins.LoadRegions.LoadRegionsPlugin" /> | ||
10 | </Extension> | ||
11 | </Addin> | ||
diff --git a/OpenSim/ApplicationPlugins/RegionModulesController/Properties/AssemblyInfo.cs b/OpenSim/ApplicationPlugins/RegionModulesController/Properties/AssemblyInfo.cs index 0ada5af..edef4d5 100644 --- a/OpenSim/ApplicationPlugins/RegionModulesController/Properties/AssemblyInfo.cs +++ b/OpenSim/ApplicationPlugins/RegionModulesController/Properties/AssemblyInfo.cs | |||
@@ -1,6 +1,7 @@ | |||
1 | using System.Reflection; | 1 | using System.Reflection; |
2 | using System.Runtime.CompilerServices; | 2 | using System.Runtime.CompilerServices; |
3 | using System.Runtime.InteropServices; | 3 | using System.Runtime.InteropServices; |
4 | using Mono.Addins; | ||
4 | 5 | ||
5 | // General Information about an assembly is controlled through the following | 6 | // General Information about an assembly is controlled through the following |
6 | // set of attributes. Change these attribute values to modify the information | 7 | // set of attributes. Change these attribute values to modify the information |
@@ -31,3 +32,5 @@ using System.Runtime.InteropServices; | |||
31 | // | 32 | // |
32 | [assembly: AssemblyVersion("0.8.1.*")] | 33 | [assembly: AssemblyVersion("0.8.1.*")] |
33 | 34 | ||
35 | [assembly: Addin("OpenSim.ApplicationPlugins.RegionModulesController", "0.1")] | ||
36 | [assembly: AddinDependency("OpenSim", "0.8.1")] | ||
diff --git a/OpenSim/ApplicationPlugins/RegionModulesController/RegionModulesControllerPlugin.cs b/OpenSim/ApplicationPlugins/RegionModulesController/RegionModulesControllerPlugin.cs index e03483a..86f71d9 100644 --- a/OpenSim/ApplicationPlugins/RegionModulesController/RegionModulesControllerPlugin.cs +++ b/OpenSim/ApplicationPlugins/RegionModulesController/RegionModulesControllerPlugin.cs | |||
@@ -38,6 +38,7 @@ using OpenSim.Region.Framework.Scenes; | |||
38 | 38 | ||
39 | namespace OpenSim.ApplicationPlugins.RegionModulesController | 39 | namespace OpenSim.ApplicationPlugins.RegionModulesController |
40 | { | 40 | { |
41 | [Extension(Path = "/OpenSim/Startup", Id = "LoadRegions", NodeName = "Plugin")] | ||
41 | public class RegionModulesControllerPlugin : IRegionModulesController, | 42 | public class RegionModulesControllerPlugin : IRegionModulesController, |
42 | IApplicationPlugin | 43 | IApplicationPlugin |
43 | { | 44 | { |
diff --git a/OpenSim/ApplicationPlugins/RegionModulesController/Resources/RegionModulesControllerPlugin.addin.xml b/OpenSim/ApplicationPlugins/RegionModulesController/Resources/RegionModulesControllerPlugin.addin.xml deleted file mode 100644 index a92713b..0000000 --- a/OpenSim/ApplicationPlugins/RegionModulesController/Resources/RegionModulesControllerPlugin.addin.xml +++ /dev/null | |||
@@ -1,13 +0,0 @@ | |||
1 | <Addin id="OpenSim.ApplicationPlugins.RegionModulesController" version="0.1"> | ||
2 | <Runtime> | ||
3 | <Import assembly="OpenSim.ApplicationPlugins.RegionModulesController.dll"/> | ||
4 | </Runtime> | ||
5 | |||
6 | <Dependencies> | ||
7 | <Addin id="OpenSim" version="0.5" /> | ||
8 | </Dependencies> | ||
9 | |||
10 | <Extension path = "/OpenSim/Startup"> | ||
11 | <Plugin id="RegionModulesController" type="OpenSim.ApplicationPlugins.RegionModulesController.RegionModulesControllerPlugin" /> | ||
12 | </Extension> | ||
13 | </Addin> | ||
diff --git a/OpenSim/ApplicationPlugins/RemoteController/Properties/AssemblyInfo.cs b/OpenSim/ApplicationPlugins/RemoteController/Properties/AssemblyInfo.cs index 245288f..7e9f6eb 100644 --- a/OpenSim/ApplicationPlugins/RemoteController/Properties/AssemblyInfo.cs +++ b/OpenSim/ApplicationPlugins/RemoteController/Properties/AssemblyInfo.cs | |||
@@ -1,6 +1,7 @@ | |||
1 | using System.Reflection; | 1 | using System.Reflection; |
2 | using System.Runtime.CompilerServices; | 2 | using System.Runtime.CompilerServices; |
3 | using System.Runtime.InteropServices; | 3 | using System.Runtime.InteropServices; |
4 | using Mono.Addins; | ||
4 | 5 | ||
5 | // General Information about an assembly is controlled through the following | 6 | // General Information about an assembly is controlled through the following |
6 | // set of attributes. Change these attribute values to modify the information | 7 | // set of attributes. Change these attribute values to modify the information |
@@ -31,3 +32,5 @@ using System.Runtime.InteropServices; | |||
31 | // | 32 | // |
32 | [assembly: AssemblyVersion("0.8.1.*")] | 33 | [assembly: AssemblyVersion("0.8.1.*")] |
33 | 34 | ||
35 | [assembly: Addin("OpenSim.ApplicationPlugins.RemoteController", "0.1")] | ||
36 | [assembly: AddinDependency("OpenSim", "0.8.1")] | ||
diff --git a/OpenSim/ApplicationPlugins/RemoteController/RemoteAdminPlugin.cs b/OpenSim/ApplicationPlugins/RemoteController/RemoteAdminPlugin.cs index 1e6e68b..3096323 100644 --- a/OpenSim/ApplicationPlugins/RemoteController/RemoteAdminPlugin.cs +++ b/OpenSim/ApplicationPlugins/RemoteController/RemoteAdminPlugin.cs | |||
@@ -39,6 +39,7 @@ using log4net; | |||
39 | using Nini.Config; | 39 | using Nini.Config; |
40 | using Nwc.XmlRpc; | 40 | using Nwc.XmlRpc; |
41 | using OpenMetaverse; | 41 | using OpenMetaverse; |
42 | using Mono.Addins; | ||
42 | using OpenSim; | 43 | using OpenSim; |
43 | using OpenSim.Framework; | 44 | using OpenSim.Framework; |
44 | using OpenSim.Framework.Communications; | 45 | using OpenSim.Framework.Communications; |
@@ -56,6 +57,7 @@ using RegionInfo = OpenSim.Framework.RegionInfo; | |||
56 | 57 | ||
57 | namespace OpenSim.ApplicationPlugins.RemoteController | 58 | namespace OpenSim.ApplicationPlugins.RemoteController |
58 | { | 59 | { |
60 | [Extension(Path = "/OpenSim/Startup", Id = "LoadRegions", NodeName = "Plugin")] | ||
59 | public class RemoteAdminPlugin : IApplicationPlugin | 61 | public class RemoteAdminPlugin : IApplicationPlugin |
60 | { | 62 | { |
61 | private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType); | 63 | private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType); |
diff --git a/OpenSim/ApplicationPlugins/RemoteController/Resources/RemoteAdminPlugin.addin.xml b/OpenSim/ApplicationPlugins/RemoteController/Resources/RemoteAdminPlugin.addin.xml deleted file mode 100644 index d68f2e4..0000000 --- a/OpenSim/ApplicationPlugins/RemoteController/Resources/RemoteAdminPlugin.addin.xml +++ /dev/null | |||
@@ -1,11 +0,0 @@ | |||
1 | <Addin id="OpenSim.ApplicationPlugins.RemoteController" version="0.1"> | ||
2 | <Runtime> | ||
3 | <Import assembly="OpenSim.ApplicationPlugins.RemoteController.dll"/> | ||
4 | </Runtime> | ||
5 | <Dependencies> | ||
6 | <Addin id="OpenSim" version="0.5" /> | ||
7 | </Dependencies> | ||
8 | <Extension path = "/OpenSim/Startup"> | ||
9 | <Plugin id="RemoteController" type="OpenSim.ApplicationPlugins.RemoteController.RemoteAdminPlugin" /> | ||
10 | </Extension> | ||
11 | </Addin> | ||
diff --git a/OpenSim/Region/Application/IApplicationPlugin.cs b/OpenSim/Region/Application/IApplicationPlugin.cs index 6e6d48c..a3fa66c 100644 --- a/OpenSim/Region/Application/IApplicationPlugin.cs +++ b/OpenSim/Region/Application/IApplicationPlugin.cs | |||
@@ -26,12 +26,14 @@ | |||
26 | */ | 26 | */ |
27 | 27 | ||
28 | using OpenSim.Framework; | 28 | using OpenSim.Framework; |
29 | using Mono.Addins; | ||
29 | 30 | ||
30 | namespace OpenSim | 31 | namespace OpenSim |
31 | { | 32 | { |
32 | /// <summary> | 33 | /// <summary> |
33 | /// OpenSimulator Application Plugin framework interface | 34 | /// OpenSimulator Application Plugin framework interface |
34 | /// </summary> | 35 | /// </summary> |
36 | [TypeExtensionPoint(NodeName="Plugin", NodeType = typeof(PluginExtensionNode), Path="/OpenSim/Startup")] | ||
35 | public interface IApplicationPlugin : IPlugin | 37 | public interface IApplicationPlugin : IPlugin |
36 | { | 38 | { |
37 | /// <summary> | 39 | /// <summary> |
diff --git a/OpenSim/Region/Application/Properties/AssemblyInfo.cs b/OpenSim/Region/Application/Properties/AssemblyInfo.cs new file mode 100644 index 0000000..3e61575 --- /dev/null +++ b/OpenSim/Region/Application/Properties/AssemblyInfo.cs | |||
@@ -0,0 +1,36 @@ | |||
1 | using System.Reflection; | ||
2 | using System.Runtime.CompilerServices; | ||
3 | using System.Runtime.InteropServices; | ||
4 | using Mono.Addins; | ||
5 | |||
6 | // General Information about an assembly is controlled through the following | ||
7 | // set of attributes. Change these attribute values to modify the information | ||
8 | // associated with an assembly. | ||
9 | [assembly: AssemblyTitle("OpenSim")] | ||
10 | [assembly: AssemblyDescription("The executable for for simulator")] | ||
11 | [assembly: AssemblyConfiguration("")] | ||
12 | [assembly: AssemblyCompany("http://opensimulator.org")] | ||
13 | [assembly: AssemblyProduct("OpenSim")] | ||
14 | [assembly: AssemblyCopyright("OpenSimulator developers")] | ||
15 | [assembly: AssemblyTrademark("")] | ||
16 | [assembly: AssemblyCulture("")] | ||
17 | |||
18 | // Setting ComVisible to false makes the types in this assembly not visible | ||
19 | // to COM components. If you need to access a type in this assembly from | ||
20 | // COM, set the ComVisible attribute to true on that type. | ||
21 | [assembly: ComVisible(false)] | ||
22 | |||
23 | // The following GUID is for the ID of the typelib if this project is exposed to COM | ||
24 | [assembly: Guid("f6700ed5-1e6f-44d8-8397-e5eac42b3856")] | ||
25 | |||
26 | // Version information for an assembly consists of the following four values: | ||
27 | // | ||
28 | // Major Version | ||
29 | // Minor Version | ||
30 | // Build Number | ||
31 | // Revision | ||
32 | // | ||
33 | [assembly: AssemblyVersion("0.8.1.*")] | ||
34 | |||
35 | [assembly: AddinRoot("OpenSim", "0.8.1")] | ||
36 | [assembly: ImportAddinAssembly("Opensim.Framework.dll")] | ||
diff --git a/OpenSim/Region/ClientStack/Linden/Caps/BunchOfCaps/BunchOfCapsModule.cs b/OpenSim/Region/ClientStack/Linden/Caps/BunchOfCaps/BunchOfCapsModule.cs index b735dfa..b05af22 100644 --- a/OpenSim/Region/ClientStack/Linden/Caps/BunchOfCaps/BunchOfCapsModule.cs +++ b/OpenSim/Region/ClientStack/Linden/Caps/BunchOfCaps/BunchOfCapsModule.cs | |||
@@ -41,7 +41,7 @@ using OpenSim.Region.Framework.Scenes; | |||
41 | using Caps = OpenSim.Framework.Capabilities.Caps; | 41 | using Caps = OpenSim.Framework.Capabilities.Caps; |
42 | 42 | ||
43 | [assembly: Addin("LindenCaps", "0.1")] | 43 | [assembly: Addin("LindenCaps", "0.1")] |
44 | [assembly: AddinDependency("OpenSim", "0.5")] | 44 | [assembly: AddinDependency("OpenSim.Region.Framework", "0.8.1")] |
45 | namespace OpenSim.Region.ClientStack.Linden | 45 | namespace OpenSim.Region.ClientStack.Linden |
46 | { | 46 | { |
47 | 47 | ||
diff --git a/OpenSim/Region/CoreModules/Asset/FlotsamAssetCache.cs b/OpenSim/Region/CoreModules/Asset/FlotsamAssetCache.cs index 6564b4d..59b30a9 100644 --- a/OpenSim/Region/CoreModules/Asset/FlotsamAssetCache.cs +++ b/OpenSim/Region/CoreModules/Asset/FlotsamAssetCache.cs | |||
@@ -50,7 +50,7 @@ using OpenSim.Services.Interfaces; | |||
50 | 50 | ||
51 | 51 | ||
52 | //[assembly: Addin("FlotsamAssetCache", "1.1")] | 52 | //[assembly: Addin("FlotsamAssetCache", "1.1")] |
53 | //[assembly: AddinDependency("OpenSim", "0.5")] | 53 | //[assembly: AddinDependency("OpenSim", "0.8.1")] |
54 | 54 | ||
55 | namespace OpenSim.Region.CoreModules.Asset | 55 | namespace OpenSim.Region.CoreModules.Asset |
56 | { | 56 | { |
diff --git a/OpenSim/Region/CoreModules/Properties/AssemblyInfo.cs b/OpenSim/Region/CoreModules/Properties/AssemblyInfo.cs index ba453dd..8cafa12 100644 --- a/OpenSim/Region/CoreModules/Properties/AssemblyInfo.cs +++ b/OpenSim/Region/CoreModules/Properties/AssemblyInfo.cs | |||
@@ -34,5 +34,5 @@ using Mono.Addins; | |||
34 | 34 | ||
35 | 35 | ||
36 | [assembly: Addin("OpenSim.Region.CoreModules", "0.1")] | 36 | [assembly: Addin("OpenSim.Region.CoreModules", "0.1")] |
37 | [assembly: AddinDependency("OpenSim", "0.5")] | 37 | [assembly: AddinDependency("OpenSim.Region.Framework", "0.8.1")] |
38 | 38 | ||
diff --git a/OpenSim/Region/DataSnapshot/DataSnapshotManager.cs b/OpenSim/Region/DataSnapshot/DataSnapshotManager.cs index 66f768b..9d3ae5e 100644 --- a/OpenSim/Region/DataSnapshot/DataSnapshotManager.cs +++ b/OpenSim/Region/DataSnapshot/DataSnapshotManager.cs | |||
@@ -43,7 +43,7 @@ using OpenSim.Region.Framework.Interfaces; | |||
43 | using OpenSim.Region.Framework.Scenes; | 43 | using OpenSim.Region.Framework.Scenes; |
44 | 44 | ||
45 | [assembly: Addin("DataSnapshot", "0.1")] | 45 | [assembly: Addin("DataSnapshot", "0.1")] |
46 | [assembly: AddinDependency("OpenSim", "0.5")] | 46 | [assembly: AddinDependency("OpenSim.Region.Framework", "0.8.1")] |
47 | 47 | ||
48 | namespace OpenSim.Region.DataSnapshot | 48 | namespace OpenSim.Region.DataSnapshot |
49 | { | 49 | { |
diff --git a/OpenSim/Region/Framework/Interfaces/IRegionModuleBase.cs b/OpenSim/Region/Framework/Interfaces/IRegionModuleBase.cs index 9b1e4ca..2089bce 100644 --- a/OpenSim/Region/Framework/Interfaces/IRegionModuleBase.cs +++ b/OpenSim/Region/Framework/Interfaces/IRegionModuleBase.cs | |||
@@ -32,6 +32,7 @@ using OpenSim.Region.Framework.Scenes; | |||
32 | 32 | ||
33 | namespace OpenSim.Region.Framework.Interfaces | 33 | namespace OpenSim.Region.Framework.Interfaces |
34 | { | 34 | { |
35 | [TypeExtensionPoint(Path = "/OpenSim/RegionModules", NodeName="RegionModule")] | ||
35 | public interface IRegionModuleBase | 36 | public interface IRegionModuleBase |
36 | { | 37 | { |
37 | /// <value> | 38 | /// <value> |
diff --git a/OpenSim/Region/Framework/Interfaces/IWindModelPlugin.cs b/OpenSim/Region/Framework/Interfaces/IWindModelPlugin.cs index b087c8b..16b6024 100644 --- a/OpenSim/Region/Framework/Interfaces/IWindModelPlugin.cs +++ b/OpenSim/Region/Framework/Interfaces/IWindModelPlugin.cs | |||
@@ -33,8 +33,11 @@ using OpenSim.Framework; | |||
33 | using OpenMetaverse; | 33 | using OpenMetaverse; |
34 | using OpenSim.Region.Framework.Scenes; | 34 | using OpenSim.Region.Framework.Scenes; |
35 | 35 | ||
36 | using Mono.Addins; | ||
37 | |||
36 | namespace OpenSim.Region.Framework.Interfaces | 38 | namespace OpenSim.Region.Framework.Interfaces |
37 | { | 39 | { |
40 | [TypeExtensionPoint(Path = "/OpenSim/WindModule", NodeName = "WindModel")] | ||
38 | public interface IWindModelPlugin : IPlugin | 41 | public interface IWindModelPlugin : IPlugin |
39 | { | 42 | { |
40 | /// <summary> | 43 | /// <summary> |
diff --git a/OpenSim/Region/Framework/Properties/AssemblyInfo.cs b/OpenSim/Region/Framework/Properties/AssemblyInfo.cs index 3692e28..6fe2892 100644 --- a/OpenSim/Region/Framework/Properties/AssemblyInfo.cs +++ b/OpenSim/Region/Framework/Properties/AssemblyInfo.cs | |||
@@ -1,6 +1,7 @@ | |||
1 | using System.Reflection; | 1 | using System.Reflection; |
2 | using System.Runtime.CompilerServices; | 2 | using System.Runtime.CompilerServices; |
3 | using System.Runtime.InteropServices; | 3 | using System.Runtime.InteropServices; |
4 | using Mono.Addins; | ||
4 | 5 | ||
5 | // General Information about an assembly is controlled through the following | 6 | // General Information about an assembly is controlled through the following |
6 | // set of attributes. Change these attribute values to modify the information | 7 | // set of attributes. Change these attribute values to modify the information |
@@ -22,6 +23,7 @@ using System.Runtime.InteropServices; | |||
22 | // The following GUID is for the ID of the typelib if this project is exposed to COM | 23 | // The following GUID is for the ID of the typelib if this project is exposed to COM |
23 | [assembly: Guid("d25e7aed-7f55-4bb8-9970-0d7d978ea8a5")] | 24 | [assembly: Guid("d25e7aed-7f55-4bb8-9970-0d7d978ea8a5")] |
24 | 25 | ||
26 | |||
25 | // Version information for an assembly consists of the following four values: | 27 | // Version information for an assembly consists of the following four values: |
26 | // | 28 | // |
27 | // Major Version | 29 | // Major Version |
@@ -30,4 +32,5 @@ using System.Runtime.InteropServices; | |||
30 | // Revision | 32 | // Revision |
31 | // | 33 | // |
32 | [assembly: AssemblyVersion("0.8.1.*")] | 34 | [assembly: AssemblyVersion("0.8.1.*")] |
35 | [assembly: AddinRoot("OpenSim.Region.Framework", "0.8.1")] | ||
33 | 36 | ||
diff --git a/OpenSim/Region/OptionalModules/Example/BareBonesNonShared/BareBonesNonSharedModule.cs b/OpenSim/Region/OptionalModules/Example/BareBonesNonShared/BareBonesNonSharedModule.cs index 0615036..bbf7168 100644 --- a/OpenSim/Region/OptionalModules/Example/BareBonesNonShared/BareBonesNonSharedModule.cs +++ b/OpenSim/Region/OptionalModules/Example/BareBonesNonShared/BareBonesNonSharedModule.cs | |||
@@ -37,7 +37,7 @@ using OpenSim.Region.Framework.Scenes; | |||
37 | // specify its assembly. Otherwise, the region modules in the assembly will not be picked up when OpenSimulator scans | 37 | // specify its assembly. Otherwise, the region modules in the assembly will not be picked up when OpenSimulator scans |
38 | // the available DLLs | 38 | // the available DLLs |
39 | //[assembly: Addin("MyModule", "1.0")] | 39 | //[assembly: Addin("MyModule", "1.0")] |
40 | //[assembly: AddinDependency("OpenSim", "0.5")] | 40 | //[assembly: AddinDependency("OpenSim", "0.8.1")] |
41 | 41 | ||
42 | namespace OpenSim.Region.OptionalModules.Example.BareBonesNonShared | 42 | namespace OpenSim.Region.OptionalModules.Example.BareBonesNonShared |
43 | { | 43 | { |
diff --git a/OpenSim/Region/OptionalModules/Example/BareBonesShared/BareBonesSharedModule.cs b/OpenSim/Region/OptionalModules/Example/BareBonesShared/BareBonesSharedModule.cs index 811a263..46fea3e 100644 --- a/OpenSim/Region/OptionalModules/Example/BareBonesShared/BareBonesSharedModule.cs +++ b/OpenSim/Region/OptionalModules/Example/BareBonesShared/BareBonesSharedModule.cs | |||
@@ -37,7 +37,7 @@ using OpenSim.Region.Framework.Scenes; | |||
37 | // specify its assembly. Otherwise, the region modules in the assembly will not be picked up when OpenSimulator scans | 37 | // specify its assembly. Otherwise, the region modules in the assembly will not be picked up when OpenSimulator scans |
38 | // the available DLLs | 38 | // the available DLLs |
39 | //[assembly: Addin("MyModule", "1.0")] | 39 | //[assembly: Addin("MyModule", "1.0")] |
40 | //[assembly: AddinDependency("OpenSim", "0.5")] | 40 | //[assembly: AddinDependency("OpenSim", "0.8.1")] |
41 | 41 | ||
42 | namespace OpenSim.Region.OptionalModules.Example.BareBonesShared | 42 | namespace OpenSim.Region.OptionalModules.Example.BareBonesShared |
43 | { | 43 | { |
diff --git a/OpenSim/Region/OptionalModules/Materials/MaterialsModule.cs b/OpenSim/Region/OptionalModules/Materials/MaterialsModule.cs index 7b2a34d..ea582fa 100644 --- a/OpenSim/Region/OptionalModules/Materials/MaterialsModule.cs +++ b/OpenSim/Region/OptionalModules/Materials/MaterialsModule.cs | |||
@@ -50,7 +50,7 @@ using Ionic.Zlib; | |||
50 | // specify its assembly. Otherwise, the region modules in the assembly will not be picked up when OpenSimulator scans | 50 | // specify its assembly. Otherwise, the region modules in the assembly will not be picked up when OpenSimulator scans |
51 | // the available DLLs | 51 | // the available DLLs |
52 | //[assembly: Addin("MaterialsModule", "1.0")] | 52 | //[assembly: Addin("MaterialsModule", "1.0")] |
53 | //[assembly: AddinDependency("OpenSim", "0.5")] | 53 | //[assembly: AddinDependency("OpenSim", "0.8.1")] |
54 | 54 | ||
55 | namespace OpenSim.Region.OptionalModules.Materials | 55 | namespace OpenSim.Region.OptionalModules.Materials |
56 | { | 56 | { |
diff --git a/OpenSim/Region/OptionalModules/Properties/AssemblyInfo.cs b/OpenSim/Region/OptionalModules/Properties/AssemblyInfo.cs index 246fd37..3f53229 100644 --- a/OpenSim/Region/OptionalModules/Properties/AssemblyInfo.cs +++ b/OpenSim/Region/OptionalModules/Properties/AssemblyInfo.cs | |||
@@ -34,4 +34,4 @@ using Mono.Addins; | |||
34 | 34 | ||
35 | 35 | ||
36 | [assembly: Addin("OpenSim.Region.OptionalModules", "0.1")] | 36 | [assembly: Addin("OpenSim.Region.OptionalModules", "0.1")] |
37 | [assembly: AddinDependency("OpenSim", "0.5")] | 37 | [assembly: AddinDependency("OpenSim.Region.Framework", "0.8.1")] |
diff --git a/OpenSim/Region/RegionCombinerModule/Resources/RegionCombinerModule.addin.xml b/OpenSim/Region/RegionCombinerModule/Resources/RegionCombinerModule.addin.xml index 13cb8b6..5891903 100644 --- a/OpenSim/Region/RegionCombinerModule/Resources/RegionCombinerModule.addin.xml +++ b/OpenSim/Region/RegionCombinerModule/Resources/RegionCombinerModule.addin.xml | |||
@@ -4,7 +4,7 @@ | |||
4 | </Runtime> | 4 | </Runtime> |
5 | 5 | ||
6 | <Dependencies> | 6 | <Dependencies> |
7 | <Addin id="OpenSim" version="0.5" /> | 7 | <Addin id="OpenSim" version="0.8.1" /> |
8 | </Dependencies> | 8 | </Dependencies> |
9 | 9 | ||
10 | <Extension path = "/OpenSim/RegionModules"> | 10 | <Extension path = "/OpenSim/RegionModules"> |
diff --git a/OpenSim/Region/ScriptEngine/XEngine/Resources/XEngine.addin.xml b/OpenSim/Region/ScriptEngine/XEngine/Resources/XEngine.addin.xml index 96c9c3a..eb18bf7 100644 --- a/OpenSim/Region/ScriptEngine/XEngine/Resources/XEngine.addin.xml +++ b/OpenSim/Region/ScriptEngine/XEngine/Resources/XEngine.addin.xml | |||
@@ -4,7 +4,7 @@ | |||
4 | </Runtime> | 4 | </Runtime> |
5 | 5 | ||
6 | <Dependencies> | 6 | <Dependencies> |
7 | <Addin id="OpenSim" version="0.5" /> | 7 | <Addin id="OpenSim" version="0.8.1" /> |
8 | </Dependencies> | 8 | </Dependencies> |
9 | 9 | ||
10 | <Extension path = "/OpenSim/RegionModules"> | 10 | <Extension path = "/OpenSim/RegionModules"> |
diff --git a/OpenSim/Region/UserStatistics/WebStatsModule.cs b/OpenSim/Region/UserStatistics/WebStatsModule.cs index b98b762..57a2502 100644 --- a/OpenSim/Region/UserStatistics/WebStatsModule.cs +++ b/OpenSim/Region/UserStatistics/WebStatsModule.cs | |||
@@ -51,7 +51,7 @@ using OSD = OpenMetaverse.StructuredData.OSD; | |||
51 | using OSDMap = OpenMetaverse.StructuredData.OSDMap; | 51 | using OSDMap = OpenMetaverse.StructuredData.OSDMap; |
52 | 52 | ||
53 | [assembly: Addin("WebStats", "1.0")] | 53 | [assembly: Addin("WebStats", "1.0")] |
54 | [assembly: AddinDependency("OpenSim", "0.5")] | 54 | [assembly: AddinDependency("OpenSim.Region.Framework", "0.8.1")] |
55 | 55 | ||
56 | namespace OpenSim.Region.UserStatistics | 56 | namespace OpenSim.Region.UserStatistics |
57 | { | 57 | { |
diff --git a/OpenSim/Services/Connectors/SimianGrid/SimianGrid.cs b/OpenSim/Services/Connectors/SimianGrid/SimianGrid.cs index 9898da9..46fda23 100644 --- a/OpenSim/Services/Connectors/SimianGrid/SimianGrid.cs +++ b/OpenSim/Services/Connectors/SimianGrid/SimianGrid.cs | |||
@@ -40,7 +40,7 @@ using OpenMetaverse; | |||
40 | using OpenMetaverse.StructuredData; | 40 | using OpenMetaverse.StructuredData; |
41 | 41 | ||
42 | [assembly: Addin("SimianGrid", "1.0")] | 42 | [assembly: Addin("SimianGrid", "1.0")] |
43 | [assembly: AddinDependency("OpenSim", "0.5")] | 43 | [assembly: AddinDependency("OpenSim.Region.Framework", "0.8.1")] |
44 | 44 | ||
45 | namespace OpenSim.Services.Connectors.SimianGrid | 45 | namespace OpenSim.Services.Connectors.SimianGrid |
46 | { | 46 | { |
diff --git a/ThirdPartyLicenses/ICSharpCode.SharpZipLib.license.txt b/ThirdPartyLicenses/ICSharpCode.SharpZipLib.license.txt new file mode 100644 index 0000000..c384be4 --- /dev/null +++ b/ThirdPartyLicenses/ICSharpCode.SharpZipLib.license.txt | |||
@@ -0,0 +1,17 @@ | |||
1 | The library is released under the GPL with the following exception: | ||
2 | |||
3 | Linking this library statically or dynamically with other modules is | ||
4 | making a combined work based on this library. Thus, the terms and | ||
5 | conditions of the GNU General Public License cover the whole combination. | ||
6 | |||
7 | As a special exception, the copyright holders of this library give you | ||
8 | permission to link this library with independent modules to produce an | ||
9 | executable, regardless of the license terms of these independent modules, | ||
10 | and to copy and distribute the resulting executable under terms of your | ||
11 | choice, provided that you also meet, for each linked independent module, | ||
12 | the terms and conditions of the license of that module. An independent | ||
13 | module is a module which is not derived from or based on this library. | ||
14 | |||
15 | If you modify this library, you may extend this exception to your | ||
16 | version of the library, but you are not obligated to do so. If you do not | ||
17 | wish to do so, delete this exception statement from your version. | ||
diff --git a/bin/ICSharpCode.SharpZipLib.dll b/bin/ICSharpCode.SharpZipLib.dll new file mode 100644 index 0000000..6c6a5d4 --- /dev/null +++ b/bin/ICSharpCode.SharpZipLib.dll | |||
Binary files differ | |||
diff --git a/bin/Mono.Addins.CecilReflector.dll b/bin/Mono.Addins.CecilReflector.dll index 9ca4631..c01c8bf 100755 --- a/bin/Mono.Addins.CecilReflector.dll +++ b/bin/Mono.Addins.CecilReflector.dll | |||
Binary files differ | |||
diff --git a/bin/Mono.Addins.Setup.dll b/bin/Mono.Addins.Setup.dll index 75773aa..eabbeca 100755 --- a/bin/Mono.Addins.Setup.dll +++ b/bin/Mono.Addins.Setup.dll | |||
Binary files differ | |||
diff --git a/bin/Mono.Addins.Setup.xml b/bin/Mono.Addins.Setup.xml new file mode 100644 index 0000000..f5ce70a --- /dev/null +++ b/bin/Mono.Addins.Setup.xml | |||
@@ -0,0 +1,1140 @@ | |||
1 | <?xml version="1.0"?> | ||
2 | <doc> | ||
3 | <assembly> | ||
4 | <name>Mono.Addins.Setup</name> | ||
5 | </assembly> | ||
6 | <members> | ||
7 | <member name="T:Mono.Addins.Setup.ConsoleAddinInstaller"> | ||
8 | <summary> | ||
9 | An IAddinInstaller implementation which interacts with the user through the console | ||
10 | </summary> | ||
11 | </member> | ||
12 | <member name="M:Mono.Addins.Setup.ConsoleAddinInstaller.#ctor"> | ||
13 | <summary> | ||
14 | Initializes a new instance of the <see cref="T:Mono.Addins.Setup.ConsoleAddinInstaller"/> class. | ||
15 | </summary> | ||
16 | </member> | ||
17 | <member name="P:Mono.Addins.Setup.ConsoleAddinInstaller.UserPrompt"> | ||
18 | <summary> | ||
19 | Gets or sets whether the installer can ask questions to the user | ||
20 | </summary> | ||
21 | </member> | ||
22 | <member name="P:Mono.Addins.Setup.ConsoleAddinInstaller.LogLevel"> | ||
23 | <summary> | ||
24 | Log level (0:normal, 1+:verbose); | ||
25 | </summary> | ||
26 | </member> | ||
27 | <member name="T:Mono.Addins.Setup.Package"> | ||
28 | <summary> | ||
29 | An add-in package | ||
30 | </summary> | ||
31 | </member> | ||
32 | <member name="M:Mono.Addins.Setup.Package.FromRepository(Mono.Addins.Setup.AddinRepositoryEntry)"> | ||
33 | <summary> | ||
34 | Creates a package object for an add-in available in an on-line repository | ||
35 | </summary> | ||
36 | <param name="repAddin"> | ||
37 | An add-in reference | ||
38 | </param> | ||
39 | <returns> | ||
40 | The package | ||
41 | </returns> | ||
42 | </member> | ||
43 | <member name="M:Mono.Addins.Setup.Package.FromFile(System.String)"> | ||
44 | <summary> | ||
45 | Creates a package object for a local package file | ||
46 | </summary> | ||
47 | <param name="file"> | ||
48 | Package file path | ||
49 | </param> | ||
50 | <returns> | ||
51 | The package | ||
52 | </returns> | ||
53 | </member> | ||
54 | <member name="P:Mono.Addins.Setup.Package.Name"> | ||
55 | <summary> | ||
56 | Name of the package | ||
57 | </summary> | ||
58 | </member> | ||
59 | <member name="P:Mono.Addins.Setup.Package.SharedInstall"> | ||
60 | <summary> | ||
61 | Returns true if the package will be installed in the shared directory, | ||
62 | false if it will be installed in the user directory. | ||
63 | </summary> | ||
64 | </member> | ||
65 | <member name="T:Mono.Addins.Setup.AddinRepositoryEntry"> | ||
66 | <summary> | ||
67 | A reference to an add-in available in an on-line repository | ||
68 | </summary> | ||
69 | </member> | ||
70 | <member name="M:Mono.Addins.Setup.AddinRepositoryEntry.BeginDownloadSupportFile(System.String,System.AsyncCallback,System.Object)"> | ||
71 | <summary> | ||
72 | Begins downloading a support file | ||
73 | </summary> | ||
74 | <returns> | ||
75 | Result of the asynchronous operation, to be used when calling EndDownloadSupportFile to | ||
76 | get the download result. | ||
77 | </returns> | ||
78 | <param name='name'> | ||
79 | Name of the file. | ||
80 | </param> | ||
81 | <param name='cb'> | ||
82 | Callback to be called when the download operation ends. | ||
83 | </param> | ||
84 | <param name='state'> | ||
85 | Custom state object provided by the caller. | ||
86 | </param> | ||
87 | <remarks> | ||
88 | This method can be used to get the contents of a support file of an add-in. | ||
89 | A support file is a file referenced in the custom properties of an add-in. | ||
90 | </remarks> | ||
91 | </member> | ||
92 | <member name="M:Mono.Addins.Setup.AddinRepositoryEntry.EndDownloadSupportFile(System.IAsyncResult)"> | ||
93 | <summary> | ||
94 | Gets the result of the asynchronous download of a file | ||
95 | </summary> | ||
96 | <returns> | ||
97 | The downloaded file. | ||
98 | </returns> | ||
99 | <param name='ares'> | ||
100 | The async result object returned by BeginDownloadSupportFile. | ||
101 | </param> | ||
102 | </member> | ||
103 | <member name="P:Mono.Addins.Setup.AddinRepositoryEntry.Addin"> | ||
104 | <summary> | ||
105 | Add-in information | ||
106 | </summary> | ||
107 | </member> | ||
108 | <member name="P:Mono.Addins.Setup.AddinRepositoryEntry.Url"> | ||
109 | <summary> | ||
110 | Url to the add-in package | ||
111 | </summary> | ||
112 | </member> | ||
113 | <member name="P:Mono.Addins.Setup.AddinRepositoryEntry.RepositoryUrl"> | ||
114 | <summary> | ||
115 | The URL of the repository | ||
116 | </summary> | ||
117 | </member> | ||
118 | <member name="P:Mono.Addins.Setup.AddinRepositoryEntry.RepositoryName"> | ||
119 | <summary> | ||
120 | Name of the repository | ||
121 | </summary> | ||
122 | </member> | ||
123 | <member name="T:Mono.Addins.Setup.InstallException"> | ||
124 | <summary> | ||
125 | An installation exception | ||
126 | </summary> | ||
127 | </member> | ||
128 | <member name="M:Mono.Addins.Setup.InstallException.#ctor(System.String)"> | ||
129 | <summary> | ||
130 | Initializes the exception | ||
131 | </summary> | ||
132 | <param name="msg"> | ||
133 | Error message | ||
134 | </param> | ||
135 | </member> | ||
136 | <member name="M:Mono.Addins.Setup.InstallException.#ctor(System.String,System.Exception)"> | ||
137 | <summary> | ||
138 | Initializes the exception | ||
139 | </summary> | ||
140 | <param name="msg"> | ||
141 | Error message | ||
142 | </param> | ||
143 | <param name="ex"> | ||
144 | Inner exception | ||
145 | </param> | ||
146 | </member> | ||
147 | <member name="T:Mono.Addins.Setup.SetupTool"> | ||
148 | <summary> | ||
149 | A command line add-in manager. | ||
150 | </summary> | ||
151 | <remarks> | ||
152 | This class can be used to provide an add-in management command line tool to applications. | ||
153 | </remarks> | ||
154 | </member> | ||
155 | <member name="M:Mono.Addins.Setup.SetupTool.#ctor(Mono.Addins.AddinRegistry)"> | ||
156 | <summary> | ||
157 | Creates a new instance | ||
158 | </summary> | ||
159 | <param name="registry"> | ||
160 | Add-in registry to manage. | ||
161 | </param> | ||
162 | </member> | ||
163 | <member name="M:Mono.Addins.Setup.SetupTool.Run(System.String[],System.Int32)"> | ||
164 | <summary> | ||
165 | Runs the command line tool. | ||
166 | </summary> | ||
167 | <param name="args"> | ||
168 | Array that contains the command line arguments | ||
169 | </param> | ||
170 | <param name="firstArgumentIndex"> | ||
171 | Index of the arguments array that has the first argument for the management tool | ||
172 | </param> | ||
173 | <returns> | ||
174 | 0 if it succeeds. != 0 otherwise | ||
175 | </returns> | ||
176 | </member> | ||
177 | <member name="M:Mono.Addins.Setup.SetupTool.Run(System.String[])"> | ||
178 | <summary> | ||
179 | Runs the command line tool. | ||
180 | </summary> | ||
181 | <param name="args"> | ||
182 | Command line arguments | ||
183 | </param> | ||
184 | <returns> | ||
185 | 0 if it succeeds. != 0 otherwise | ||
186 | </returns> | ||
187 | </member> | ||
188 | <member name="M:Mono.Addins.Setup.SetupTool.AddCommand(System.String,System.String,System.String,System.String,System.String,System.String,Mono.Addins.Setup.SetupCommandHandler)"> | ||
189 | <summary> | ||
190 | Adds a custom command to the add-in manager | ||
191 | </summary> | ||
192 | <param name="category"> | ||
193 | Category under which the command has to be shown in the help text | ||
194 | </param> | ||
195 | <param name="command"> | ||
196 | Name of the command | ||
197 | </param> | ||
198 | <param name="shortName"> | ||
199 | Short name of the command (it's an alias of the normal name) | ||
200 | </param> | ||
201 | <param name="arguments"> | ||
202 | Formal description of the arguments that the command accepts. For example: "[addin-id|addin-file] [--xml] [--all] [--full] [--namespace <namespace>]" | ||
203 | </param> | ||
204 | <param name="description"> | ||
205 | Short description of the command | ||
206 | </param> | ||
207 | <param name="longDescription"> | ||
208 | Long description of the command | ||
209 | </param> | ||
210 | <param name="handler"> | ||
211 | Delegate to be invoked to run the command | ||
212 | </param> | ||
213 | </member> | ||
214 | <member name="M:Mono.Addins.Setup.SetupTool.PrintHelp(System.String[])"> | ||
215 | <summary> | ||
216 | Prints help about the add-in management tool, or about a specific command | ||
217 | </summary> | ||
218 | <param name="parms"> | ||
219 | Optional command name and arguments | ||
220 | </param> | ||
221 | </member> | ||
222 | <member name="P:Mono.Addins.Setup.SetupTool.ApplicationName"> | ||
223 | <summary> | ||
224 | Display name of the host application | ||
225 | </summary> | ||
226 | </member> | ||
227 | <member name="P:Mono.Addins.Setup.SetupTool.ApplicationNamespace"> | ||
228 | <summary> | ||
229 | Default add-in namespace of the application (optional). If set, only add-ins that belong to that namespace | ||
230 | will be shown in add-in lists. | ||
231 | </summary> | ||
232 | </member> | ||
233 | <member name="P:Mono.Addins.Setup.SetupTool.VerboseOutput"> | ||
234 | <summary> | ||
235 | Enables or disables verbose output | ||
236 | </summary> | ||
237 | </member> | ||
238 | <member name="P:Mono.Addins.Setup.SetupTool.VerboseOutputLevel"> | ||
239 | <summary> | ||
240 | Sets or gets the verbose output level (0: normal output, 1:verbose, 2+:extra verbose) | ||
241 | </summary> | ||
242 | </member> | ||
243 | <member name="T:Mono.Addins.Setup.SetupCommandHandler"> | ||
244 | <summary> | ||
245 | A command handler | ||
246 | </summary> | ||
247 | </member> | ||
248 | <member name="T:Mono.Addins.Setup.PackageCollection"> | ||
249 | <summary> | ||
250 | A collection of packages | ||
251 | </summary> | ||
252 | </member> | ||
253 | <member name="M:Mono.Addins.Setup.PackageCollection.#ctor"> | ||
254 | <summary> | ||
255 | Initializes a new instance of the <see cref="T:Mono.Addins.Setup.PackageCollection"/> class. | ||
256 | </summary> | ||
257 | </member> | ||
258 | <member name="M:Mono.Addins.Setup.PackageCollection.#ctor(System.Collections.ICollection)"> | ||
259 | <summary> | ||
260 | Copy constructor | ||
261 | </summary> | ||
262 | <param name="col"> | ||
263 | Collection where to copy from | ||
264 | </param> | ||
265 | </member> | ||
266 | <member name="M:Mono.Addins.Setup.PackageCollection.Add(Mono.Addins.Setup.Package)"> | ||
267 | <summary> | ||
268 | Adds a package | ||
269 | </summary> | ||
270 | <param name="p"> | ||
271 | A package | ||
272 | </param> | ||
273 | </member> | ||
274 | <member name="M:Mono.Addins.Setup.PackageCollection.Contains(Mono.Addins.Setup.Package)"> | ||
275 | <summary> | ||
276 | Checks if a package is present in the collection | ||
277 | </summary> | ||
278 | <param name="p"> | ||
279 | The package | ||
280 | </param> | ||
281 | <returns> | ||
282 | True if the package is preent | ||
283 | </returns> | ||
284 | </member> | ||
285 | <member name="M:Mono.Addins.Setup.PackageCollection.AddRange(System.Collections.ICollection)"> | ||
286 | <summary> | ||
287 | Adds a list of packages to the collection | ||
288 | </summary> | ||
289 | <param name="col"> | ||
290 | The list of packages to add | ||
291 | </param> | ||
292 | </member> | ||
293 | <member name="P:Mono.Addins.Setup.PackageCollection.Item(System.Int32)"> | ||
294 | <summary> | ||
295 | Gets a package | ||
296 | </summary> | ||
297 | <param name="n"> | ||
298 | Package index | ||
299 | </param> | ||
300 | </member> | ||
301 | <member name="T:Mono.Addins.Setup.AddinHeader"> | ||
302 | <summary> | ||
303 | Basic add-in information | ||
304 | </summary> | ||
305 | </member> | ||
306 | <member name="M:Mono.Addins.Setup.AddinHeader.CompareVersionTo(Mono.Addins.Setup.AddinHeader)"> | ||
307 | <summary> | ||
308 | Compares the versions of two add-ins | ||
309 | </summary> | ||
310 | <param name="other"> | ||
311 | Another add-in | ||
312 | </param> | ||
313 | <returns> | ||
314 | Result of comparison | ||
315 | </returns> | ||
316 | </member> | ||
317 | <member name="P:Mono.Addins.Setup.AddinHeader.Id"> | ||
318 | <summary> | ||
319 | Full identifier of the add-in | ||
320 | </summary> | ||
321 | </member> | ||
322 | <member name="P:Mono.Addins.Setup.AddinHeader.Name"> | ||
323 | <summary> | ||
324 | Display name of the add-in | ||
325 | </summary> | ||
326 | </member> | ||
327 | <member name="P:Mono.Addins.Setup.AddinHeader.Namespace"> | ||
328 | <summary> | ||
329 | Namespace of the add-in | ||
330 | </summary> | ||
331 | </member> | ||
332 | <member name="P:Mono.Addins.Setup.AddinHeader.Version"> | ||
333 | <summary> | ||
334 | Version of the add-in | ||
335 | </summary> | ||
336 | </member> | ||
337 | <member name="P:Mono.Addins.Setup.AddinHeader.BaseVersion"> | ||
338 | <summary> | ||
339 | Version with which this add-in is compatible | ||
340 | </summary> | ||
341 | </member> | ||
342 | <member name="P:Mono.Addins.Setup.AddinHeader.Author"> | ||
343 | <summary> | ||
344 | Add-in author | ||
345 | </summary> | ||
346 | </member> | ||
347 | <member name="P:Mono.Addins.Setup.AddinHeader.Copyright"> | ||
348 | <summary> | ||
349 | Add-in copyright | ||
350 | </summary> | ||
351 | </member> | ||
352 | <member name="P:Mono.Addins.Setup.AddinHeader.Url"> | ||
353 | <summary> | ||
354 | Web page URL with more information about the add-in | ||
355 | </summary> | ||
356 | </member> | ||
357 | <member name="P:Mono.Addins.Setup.AddinHeader.Description"> | ||
358 | <summary> | ||
359 | Description of the add-in | ||
360 | </summary> | ||
361 | </member> | ||
362 | <member name="P:Mono.Addins.Setup.AddinHeader.Category"> | ||
363 | <summary> | ||
364 | Category of the add-in | ||
365 | </summary> | ||
366 | </member> | ||
367 | <member name="P:Mono.Addins.Setup.AddinHeader.Dependencies"> | ||
368 | <summary> | ||
369 | Dependencies of the add-in | ||
370 | </summary> | ||
371 | </member> | ||
372 | <member name="P:Mono.Addins.Setup.AddinHeader.OptionalDependencies"> | ||
373 | <summary> | ||
374 | Optional dependencies of the add-in | ||
375 | </summary> | ||
376 | </member> | ||
377 | <member name="P:Mono.Addins.Setup.AddinHeader.Properties"> | ||
378 | <summary> | ||
379 | Custom properties specified in the add-in header | ||
380 | </summary> | ||
381 | </member> | ||
382 | <member name="T:Mono.Addins.Setup.RepositoryRegistry"> | ||
383 | <summary> | ||
384 | A registry of on-line repositories | ||
385 | </summary> | ||
386 | <remarks> | ||
387 | This class can be used to manage on-line repository subscriptions. | ||
388 | </remarks> | ||
389 | </member> | ||
390 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.RegisterRepository(Mono.Addins.IProgressStatus,System.String)"> | ||
391 | <summary> | ||
392 | Subscribes to an on-line repository | ||
393 | </summary> | ||
394 | <param name="monitor"> | ||
395 | Progress monitor where to show progress status and log | ||
396 | </param> | ||
397 | <param name="url"> | ||
398 | URL of the repository | ||
399 | </param> | ||
400 | <returns> | ||
401 | A repository reference | ||
402 | </returns> | ||
403 | <remarks> | ||
404 | The repository index is not downloaded by default. It can be downloaded | ||
405 | by calling UpdateRepository. | ||
406 | </remarks> | ||
407 | </member> | ||
408 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.RegisterRepository(Mono.Addins.IProgressStatus,System.String,System.Boolean)"> | ||
409 | <summary> | ||
410 | Subscribes to an on-line repository | ||
411 | </summary> | ||
412 | <param name="monitor"> | ||
413 | Progress monitor where to show progress status and log | ||
414 | </param> | ||
415 | <param name="url"> | ||
416 | URL of the repository | ||
417 | </param> | ||
418 | <param name="updateNow"> | ||
419 | When set to True, the repository index will be downloaded. | ||
420 | </param> | ||
421 | <returns> | ||
422 | A repository reference | ||
423 | </returns> | ||
424 | </member> | ||
425 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.RemoveRepository(System.String)"> | ||
426 | <summary> | ||
427 | Removes an on-line repository subscription. | ||
428 | </summary> | ||
429 | <param name="url"> | ||
430 | URL of the repository. | ||
431 | </param> | ||
432 | </member> | ||
433 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.SetRepositoryEnabled(System.String,System.Boolean)"> | ||
434 | <summary> | ||
435 | Enables or disables a repository | ||
436 | </summary> | ||
437 | <param name='url'> | ||
438 | URL of the repository | ||
439 | </param> | ||
440 | <param name='enabled'> | ||
441 | 'true' if the repository has to be enabled. | ||
442 | </param> | ||
443 | <remarks> | ||
444 | Disabled repositories are ignored when calling UpdateAllRepositories. | ||
445 | </remarks> | ||
446 | </member> | ||
447 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.ContainsRepository(System.String)"> | ||
448 | <summary> | ||
449 | Checks if a repository is already subscribed. | ||
450 | </summary> | ||
451 | <param name="url"> | ||
452 | URL of the repository | ||
453 | </param> | ||
454 | <returns> | ||
455 | True if the repository is already subscribed. | ||
456 | </returns> | ||
457 | </member> | ||
458 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetRepositories"> | ||
459 | <summary> | ||
460 | Gets a list of subscribed repositories | ||
461 | </summary> | ||
462 | <returns> | ||
463 | A list of repositories. | ||
464 | </returns> | ||
465 | </member> | ||
466 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.UpdateAllRepositories(Mono.Addins.IProgressStatus)"> | ||
467 | <summary> | ||
468 | Updates the add-in index of all subscribed repositories. | ||
469 | </summary> | ||
470 | <param name="monitor"> | ||
471 | Progress monitor where to show progress status and log | ||
472 | </param> | ||
473 | </member> | ||
474 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.UpdateRepository(Mono.Addins.IProgressStatus,System.String)"> | ||
475 | <summary> | ||
476 | Updates the add-in index of the provided repository | ||
477 | </summary> | ||
478 | <param name="statusMonitor"> | ||
479 | Progress monitor where to show progress status and log | ||
480 | </param> | ||
481 | <param name="url"> | ||
482 | URL of the repository | ||
483 | </param> | ||
484 | </member> | ||
485 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableUpdates"> | ||
486 | <summary> | ||
487 | Gets a list of available add-in updates. | ||
488 | </summary> | ||
489 | <returns> | ||
490 | A list of add-in references. | ||
491 | </returns> | ||
492 | <remarks> | ||
493 | The list is generated by looking at the add-ins currently installed and checking if there is any | ||
494 | add-in with a newer version number in any of the subscribed repositories. This method uses cached | ||
495 | information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories | ||
496 | before using this method to ensure that the latest information is available. | ||
497 | </remarks> | ||
498 | </member> | ||
499 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableUpdates(Mono.Addins.Setup.RepositorySearchFlags)"> | ||
500 | <summary> | ||
501 | Gets a list of available add-in updates. | ||
502 | </summary> | ||
503 | <param name="flags"> | ||
504 | Search flags | ||
505 | </param> | ||
506 | <returns> | ||
507 | A list of add-in references. | ||
508 | </returns> | ||
509 | <remarks> | ||
510 | The list is generated by looking at the add-ins currently installed and checking if there is any | ||
511 | add-in with a newer version number in any of the subscribed repositories. This method uses cached | ||
512 | information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories | ||
513 | before using this method to ensure that the latest information is available. | ||
514 | </remarks> | ||
515 | </member> | ||
516 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableUpdates(System.String)"> | ||
517 | <summary> | ||
518 | Gets a list of available add-in updates in a specific repository. | ||
519 | </summary> | ||
520 | <param name="repositoryUrl"> | ||
521 | The repository URL | ||
522 | </param> | ||
523 | <returns> | ||
524 | A list of add-in references. | ||
525 | </returns> | ||
526 | <remarks> | ||
527 | The list is generated by looking at the add-ins currently installed and checking if there is any | ||
528 | add-in with a newer version number in the provided repository. This method uses cached | ||
529 | information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories | ||
530 | before using this method to ensure that the latest information is available. | ||
531 | </remarks> | ||
532 | </member> | ||
533 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddinUpdates(System.String)"> | ||
534 | <summary> | ||
535 | Gets a list of available updates for an add-in. | ||
536 | </summary> | ||
537 | <param name="id"> | ||
538 | Identifier of the add-in. | ||
539 | </param> | ||
540 | <returns> | ||
541 | List of updates for the specified add-in. | ||
542 | </returns> | ||
543 | <remarks> | ||
544 | The list is generated by checking if there is any | ||
545 | add-in with a newer version number in any of the subscribed repositories. This method uses cached | ||
546 | information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories | ||
547 | before using this method to ensure that the latest information is available. | ||
548 | </remarks> | ||
549 | </member> | ||
550 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddinUpdates(System.String,Mono.Addins.Setup.RepositorySearchFlags)"> | ||
551 | <summary> | ||
552 | Gets a list of available updates for an add-in. | ||
553 | </summary> | ||
554 | <param name="id"> | ||
555 | Identifier of the add-in. | ||
556 | </param> | ||
557 | <param name='flags'> | ||
558 | Search flags. | ||
559 | </param> | ||
560 | <returns> | ||
561 | List of updates for the specified add-in. | ||
562 | </returns> | ||
563 | <remarks> | ||
564 | The list is generated by checking if there is any | ||
565 | add-in with a newer version number in any of the subscribed repositories. This method uses cached | ||
566 | information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories | ||
567 | before using this method to ensure that the latest information is available. | ||
568 | </remarks> | ||
569 | </member> | ||
570 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddinUpdates(System.String,System.String)"> | ||
571 | <summary> | ||
572 | Gets a list of available updates for an add-in in a specific repository | ||
573 | </summary> | ||
574 | <param name="repositoryUrl"> | ||
575 | Identifier of the add-in. | ||
576 | </param> | ||
577 | <param name="id"> | ||
578 | Identifier of the add-in. | ||
579 | </param> | ||
580 | <returns> | ||
581 | List of updates for the specified add-in. | ||
582 | </returns> | ||
583 | <remarks> | ||
584 | The list is generated by checking if there is any | ||
585 | add-in with a newer version number in the provided repository. This method uses cached | ||
586 | information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories | ||
587 | before using this method to ensure that the latest information is available. | ||
588 | </remarks> | ||
589 | </member> | ||
590 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddinUpdates(System.String,System.String,Mono.Addins.Setup.RepositorySearchFlags)"> | ||
591 | <summary> | ||
592 | Gets a list of available updates for an add-in in a specific repository | ||
593 | </summary> | ||
594 | <param name="repositoryUrl"> | ||
595 | Identifier of the add-in. | ||
596 | </param> | ||
597 | <param name="id"> | ||
598 | Identifier of the add-in. | ||
599 | </param> | ||
600 | <param name='flags'> | ||
601 | Search flags. | ||
602 | </param> | ||
603 | <returns> | ||
604 | List of updates for the specified add-in. | ||
605 | </returns> | ||
606 | <remarks> | ||
607 | The list is generated by checking if there is any | ||
608 | add-in with a newer version number in the provided repository. This method uses cached | ||
609 | information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories | ||
610 | before using this method to ensure that the latest information is available. | ||
611 | </remarks> | ||
612 | </member> | ||
613 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddins"> | ||
614 | <summary> | ||
615 | Gets a list of all available add-ins | ||
616 | </summary> | ||
617 | <returns> | ||
618 | A list of add-ins | ||
619 | </returns> | ||
620 | <remarks> | ||
621 | This method uses cached | ||
622 | information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories | ||
623 | before using this method to ensure that the latest information is available. | ||
624 | </remarks> | ||
625 | </member> | ||
626 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddins(Mono.Addins.Setup.RepositorySearchFlags)"> | ||
627 | <summary> | ||
628 | Gets a list of all available add-ins | ||
629 | </summary> | ||
630 | <returns> | ||
631 | The available addins. | ||
632 | </returns> | ||
633 | <param name='flags'> | ||
634 | Search flags. | ||
635 | </param> | ||
636 | <remarks> | ||
637 | This method uses cached | ||
638 | information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories | ||
639 | before using this method to ensure that the latest information is available. | ||
640 | </remarks> | ||
641 | </member> | ||
642 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddins(System.String)"> | ||
643 | <summary> | ||
644 | Gets a list of all available add-ins in a repository | ||
645 | </summary> | ||
646 | <param name="repositoryUrl"> | ||
647 | A repository URL | ||
648 | </param> | ||
649 | <returns> | ||
650 | A list of add-ins | ||
651 | </returns> | ||
652 | <remarks> | ||
653 | This method uses cached | ||
654 | information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories | ||
655 | before using this method to ensure that the latest information is available. | ||
656 | </remarks> | ||
657 | </member> | ||
658 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddins(System.String,Mono.Addins.Setup.RepositorySearchFlags)"> | ||
659 | <summary> | ||
660 | Gets a list of all available add-ins in a repository | ||
661 | </summary> | ||
662 | <param name="repositoryUrl"> | ||
663 | A repository URL | ||
664 | </param> | ||
665 | <param name='flags'> | ||
666 | Search flags. | ||
667 | </param> | ||
668 | <returns> | ||
669 | A list of add-ins | ||
670 | </returns> | ||
671 | <remarks> | ||
672 | This method uses cached | ||
673 | information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories | ||
674 | before using this method to ensure that the latest information is available. | ||
675 | </remarks> | ||
676 | </member> | ||
677 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddin(System.String,System.String)"> | ||
678 | <summary> | ||
679 | Checks if an add-in is available to be installed | ||
680 | </summary> | ||
681 | <param name="id"> | ||
682 | Identifier of the add-in | ||
683 | </param> | ||
684 | <param name="version"> | ||
685 | Version of the add-in (optional, it can be null) | ||
686 | </param> | ||
687 | <returns> | ||
688 | A list of add-ins | ||
689 | </returns> | ||
690 | <remarks> | ||
691 | List of references to add-ins available in on-line repositories. This method uses cached | ||
692 | information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories | ||
693 | before using this method to ensure that the latest information is available. | ||
694 | </remarks> | ||
695 | </member> | ||
696 | <member name="M:Mono.Addins.Setup.RepositoryRegistry.GetAvailableAddin(System.String,System.String,System.String)"> | ||
697 | <summary> | ||
698 | Checks if an add-in is available to be installed from a repository | ||
699 | </summary> | ||
700 | <param name="repositoryUrl"> | ||
701 | A repository URL | ||
702 | </param> | ||
703 | <param name="id"> | ||
704 | Identifier of the add-in | ||
705 | </param> | ||
706 | <param name="version"> | ||
707 | Version of the add-in (optional, it can be null) | ||
708 | </param> | ||
709 | <returns> | ||
710 | A list of add-ins | ||
711 | </returns> | ||
712 | <remarks> | ||
713 | List of references to add-ins available in the repository. This method uses cached | ||
714 | information from on-line repositories. Make sure you call UpdateRepository or UpdateAllRepositories | ||
715 | before using this method to ensure that the latest information is available. | ||
716 | </remarks> | ||
717 | </member> | ||
718 | <member name="T:Mono.Addins.Setup.RepositorySearchFlags"> | ||
719 | <summary> | ||
720 | Repository search flags. | ||
721 | </summary> | ||
722 | </member> | ||
723 | <member name="F:Mono.Addins.Setup.RepositorySearchFlags.None"> | ||
724 | <summary> | ||
725 | No special search options | ||
726 | </summary> | ||
727 | </member> | ||
728 | <member name="F:Mono.Addins.Setup.RepositorySearchFlags.LatestVersionsOnly"> | ||
729 | <summary> | ||
730 | Only the latest version of every add-in is included in the search | ||
731 | </summary> | ||
732 | </member> | ||
733 | <member name="T:Mono.Addins.Setup.AddinRepository"> | ||
734 | <summary> | ||
735 | An on-line add-in repository | ||
736 | </summary> | ||
737 | </member> | ||
738 | <member name="P:Mono.Addins.Setup.AddinRepository.File"> | ||
739 | <summary> | ||
740 | Path to the cached add-in repository file | ||
741 | </summary> | ||
742 | </member> | ||
743 | <member name="P:Mono.Addins.Setup.AddinRepository.Url"> | ||
744 | <summary> | ||
745 | Url of the repository | ||
746 | </summary> | ||
747 | </member> | ||
748 | <member name="P:Mono.Addins.Setup.AddinRepository.Name"> | ||
749 | <summary> | ||
750 | Do not use. Use Title instead. | ||
751 | </summary> | ||
752 | </member> | ||
753 | <member name="P:Mono.Addins.Setup.AddinRepository.Title"> | ||
754 | <summary> | ||
755 | Title of the repository | ||
756 | </summary> | ||
757 | </member> | ||
758 | <member name="P:Mono.Addins.Setup.AddinRepository.LastModified"> | ||
759 | <summary> | ||
760 | Last change timestamp | ||
761 | </summary> | ||
762 | </member> | ||
763 | <member name="P:Mono.Addins.Setup.AddinRepository.Enabled"> | ||
764 | <summary> | ||
765 | Gets a value indicating whether this <see cref="T:Mono.Addins.Setup.AddinRepository"/> is enabled. | ||
766 | </summary> | ||
767 | <value> | ||
768 | <c>true</c> if enabled; otherwise, <c>false</c>. | ||
769 | </value> | ||
770 | </member> | ||
771 | <member name="T:Mono.Addins.Setup.WebRequestHelper"> | ||
772 | <summary> | ||
773 | Helper for making web requests with support for authenticated proxies. | ||
774 | </summary> | ||
775 | </member> | ||
776 | <member name="M:Mono.Addins.Setup.WebRequestHelper.SetRequestHandler(System.Func{System.Func{System.Net.HttpWebRequest},System.Action{System.Net.HttpWebRequest},System.Threading.CancellationToken,System.Net.HttpWebResponse})"> | ||
777 | <summary> | ||
778 | Sets a custom request handler that can handle requests for authenticated proxy servers. | ||
779 | </summary> | ||
780 | <param name="handler">The custom request handler.</param> | ||
781 | </member> | ||
782 | <member name="M:Mono.Addins.Setup.WebRequestHelper.GetResponseAsync(System.Func{System.Net.HttpWebRequest},System.Action{System.Net.HttpWebRequest},System.Threading.CancellationToken)"> | ||
783 | <summary> | ||
784 | Gets the web response, using the request handler to handle proxy authentication | ||
785 | if necessary. | ||
786 | </summary> | ||
787 | <returns>The response.</returns> | ||
788 | <param name="createRequest">Callback for creating the request.</param> | ||
789 | <param name="prepareRequest">Callback for preparing the request, e.g. writing the request stream.</param> | ||
790 | <param name="token">Cancellation token.</param> | ||
791 | <remarks> | ||
792 | Keeps sending requests until a response code that doesn't require authentication happens or if the request | ||
793 | requires authentication and the user has stopped trying to enter them (i.e. they hit cancel when they are prompted). | ||
794 | </remarks> | ||
795 | </member> | ||
796 | <member name="M:Mono.Addins.Setup.WebRequestHelper.GetResponse(System.Func{System.Net.HttpWebRequest},System.Action{System.Net.HttpWebRequest},System.Threading.CancellationToken)"> | ||
797 | <summary> | ||
798 | Gets the web response, using the request handler to handle proxy authentication | ||
799 | if necessary. | ||
800 | </summary> | ||
801 | <returns>The response.</returns> | ||
802 | <param name="createRequest">Callback for creating the request.</param> | ||
803 | <param name="prepareRequest">Callback for preparing the request, e.g. writing the request stream.</param> | ||
804 | <param name="token">Cancellation token.</param> | ||
805 | <remarks> | ||
806 | Keeps sending requests until a response code that doesn't require authentication happens or if the request | ||
807 | requires authentication and the user has stopped trying to enter them (i.e. they hit cancel when they are prompted). | ||
808 | </remarks> | ||
809 | </member> | ||
810 | <member name="M:Mono.Addins.Setup.WebRequestHelper.IsCannotReachInternetError(System.Net.WebExceptionStatus)"> | ||
811 | <summary> | ||
812 | Determines whether an error code is likely to have been caused by internet reachability problems. | ||
813 | </summary> | ||
814 | </member> | ||
815 | <member name="T:Mono.Addins.Setup.SetupService"> | ||
816 | <summary> | ||
817 | Provides tools for managing add-ins | ||
818 | </summary> | ||
819 | <remarks> | ||
820 | This class can be used to manage the add-ins of an application. It allows installing and uninstalling | ||
821 | add-ins, taking into account add-in dependencies. It provides methods for installing add-ins from on-line | ||
822 | repositories and tools for generating those repositories. | ||
823 | </remarks> | ||
824 | </member> | ||
825 | <member name="M:Mono.Addins.Setup.SetupService.#ctor"> | ||
826 | <summary> | ||
827 | Initializes a new instance | ||
828 | </summary> | ||
829 | <remarks> | ||
830 | If the add-in manager is initialized (AddinManager.Initialize has been called), then this instance | ||
831 | will manage the add-in registry of the initialized engine. | ||
832 | </remarks> | ||
833 | </member> | ||
834 | <member name="M:Mono.Addins.Setup.SetupService.#ctor(Mono.Addins.AddinRegistry)"> | ||
835 | <summary> | ||
836 | Initializes a new instance | ||
837 | </summary> | ||
838 | <param name="registry"> | ||
839 | Add-in registry to manage | ||
840 | </param> | ||
841 | </member> | ||
842 | <member name="M:Mono.Addins.Setup.SetupService.ResolveDependencies(Mono.Addins.IProgressStatus,Mono.Addins.Setup.AddinRepositoryEntry[],Mono.Addins.Setup.PackageCollection@,Mono.Addins.Setup.PackageCollection@,Mono.Addins.Description.DependencyCollection@)"> | ||
843 | <summary> | ||
844 | Resolves add-in dependencies. | ||
845 | </summary> | ||
846 | <param name="statusMonitor"> | ||
847 | Progress monitor where to show progress status | ||
848 | </param> | ||
849 | <param name="addins"> | ||
850 | List of add-ins to check | ||
851 | </param> | ||
852 | <param name="resolved"> | ||
853 | Packages that need to be installed. | ||
854 | </param> | ||
855 | <param name="toUninstall"> | ||
856 | Packages that need to be uninstalled. | ||
857 | </param> | ||
858 | <param name="unresolved"> | ||
859 | Add-in dependencies that could not be resolved. | ||
860 | </param> | ||
861 | <returns> | ||
862 | True if all dependencies could be resolved. | ||
863 | </returns> | ||
864 | <remarks> | ||
865 | This method can be used to get a list of all packages that have to be installed in order to install | ||
866 | an add-in or set of add-ins. The list of packages to install will include the package that provides the | ||
867 | add-in, and all packages that provide the add-in dependencies. In some cases, packages may need to | ||
868 | be installed (for example, when an installed add-in needs to be upgraded). | ||
869 | </remarks> | ||
870 | </member> | ||
871 | <member name="M:Mono.Addins.Setup.SetupService.ResolveDependencies(Mono.Addins.IProgressStatus,Mono.Addins.Setup.PackageCollection,Mono.Addins.Setup.PackageCollection@,Mono.Addins.Description.DependencyCollection@)"> | ||
872 | <summary> | ||
873 | Resolves add-in dependencies. | ||
874 | </summary> | ||
875 | <param name="statusMonitor"> | ||
876 | Progress monitor where to show progress status | ||
877 | </param> | ||
878 | <param name="packages"> | ||
879 | Packages that need to be installed. | ||
880 | </param> | ||
881 | <param name="toUninstall"> | ||
882 | Packages that need to be uninstalled. | ||
883 | </param> | ||
884 | <param name="unresolved"> | ||
885 | Add-in dependencies that could not be resolved. | ||
886 | </param> | ||
887 | <returns> | ||
888 | True if all dependencies could be resolved. | ||
889 | </returns> | ||
890 | <remarks> | ||
891 | This method can be used to get a list of all packages that have to be installed in order to satisfy | ||
892 | the dependencies of a package or set of packages. The 'packages' argument must have the list of packages | ||
893 | to be resolved. When resolving dependencies, if there is any additional package that needs to be installed, | ||
894 | it will be added to the same 'packages' collection. In some cases, packages may need to | ||
895 | be installed (for example, when an installed add-in needs to be upgraded). Those packages will be added | ||
896 | to the 'toUninstall' collection. Packages that could not be resolved are added to the 'unresolved' | ||
897 | collection. | ||
898 | </remarks> | ||
899 | </member> | ||
900 | <member name="M:Mono.Addins.Setup.SetupService.Install(Mono.Addins.IProgressStatus,System.String[])"> | ||
901 | <summary> | ||
902 | Installs add-in packages | ||
903 | </summary> | ||
904 | <param name="statusMonitor"> | ||
905 | Progress monitor where to show progress status | ||
906 | </param> | ||
907 | <param name="files"> | ||
908 | Paths to the packages to install | ||
909 | </param> | ||
910 | <returns> | ||
911 | True if the installation succeeded | ||
912 | </returns> | ||
913 | </member> | ||
914 | <member name="M:Mono.Addins.Setup.SetupService.Install(Mono.Addins.IProgressStatus,Mono.Addins.Setup.AddinRepositoryEntry[])"> | ||
915 | <summary> | ||
916 | Installs add-in packages from on-line repositories | ||
917 | </summary> | ||
918 | <param name="statusMonitor"> | ||
919 | Progress monitor where to show progress status | ||
920 | </param> | ||
921 | <param name="addins"> | ||
922 | References to the add-ins to be installed | ||
923 | </param> | ||
924 | <returns> | ||
925 | True if the installation succeeded | ||
926 | </returns> | ||
927 | </member> | ||
928 | <member name="M:Mono.Addins.Setup.SetupService.Install(Mono.Addins.IProgressStatus,Mono.Addins.Setup.PackageCollection)"> | ||
929 | <summary> | ||
930 | Installs add-in packages | ||
931 | </summary> | ||
932 | <param name="statusMonitor"> | ||
933 | Progress monitor where to show progress status | ||
934 | </param> | ||
935 | <param name="packages"> | ||
936 | Packages to install | ||
937 | </param> | ||
938 | <returns> | ||
939 | True if the installation succeeded | ||
940 | </returns> | ||
941 | </member> | ||
942 | <member name="M:Mono.Addins.Setup.SetupService.Uninstall(Mono.Addins.IProgressStatus,System.String)"> | ||
943 | <summary> | ||
944 | Uninstalls an add-in. | ||
945 | </summary> | ||
946 | <param name="statusMonitor"> | ||
947 | Progress monitor where to show progress status | ||
948 | </param> | ||
949 | <param name="id"> | ||
950 | Full identifier of the add-in to uninstall. | ||
951 | </param> | ||
952 | </member> | ||
953 | <member name="M:Mono.Addins.Setup.SetupService.Uninstall(Mono.Addins.IProgressStatus,System.Collections.Generic.IEnumerable{System.String})"> | ||
954 | <summary> | ||
955 | Uninstalls a set of add-ins | ||
956 | </summary> | ||
957 | <param name='statusMonitor'> | ||
958 | Progress monitor where to show progress status | ||
959 | </param> | ||
960 | <param name='ids'> | ||
961 | Full identifiers of the add-ins to uninstall. | ||
962 | </param> | ||
963 | </member> | ||
964 | <member name="M:Mono.Addins.Setup.SetupService.GetAddinHeader(Mono.Addins.Addin)"> | ||
965 | <summary> | ||
966 | Gets information about an add-in | ||
967 | </summary> | ||
968 | <param name="addin"> | ||
969 | The add-in | ||
970 | </param> | ||
971 | <returns> | ||
972 | Add-in header data | ||
973 | </returns> | ||
974 | </member> | ||
975 | <member name="M:Mono.Addins.Setup.SetupService.GetDependentAddins(System.String,System.Boolean)"> | ||
976 | <summary> | ||
977 | Gets a list of add-ins which depend on an add-in | ||
978 | </summary> | ||
979 | <param name="id"> | ||
980 | Full identifier of an add-in. | ||
981 | </param> | ||
982 | <param name="recursive"> | ||
983 | When set to True, dependencies will be gathered recursivelly | ||
984 | </param> | ||
985 | <returns> | ||
986 | List of dependent add-ins. | ||
987 | </returns> | ||
988 | <remarks> | ||
989 | This methods returns a list of add-ins which have the add-in identified by 'id' as a direct | ||
990 | (or indirect if recursive=True) dependency. | ||
991 | </remarks> | ||
992 | </member> | ||
993 | <member name="M:Mono.Addins.Setup.SetupService.BuildPackage(Mono.Addins.IProgressStatus,System.String,System.String[])"> | ||
994 | <summary> | ||
995 | Packages an add-in | ||
996 | </summary> | ||
997 | <param name="statusMonitor"> | ||
998 | Progress monitor where to show progress status | ||
999 | </param> | ||
1000 | <param name="targetDirectory"> | ||
1001 | Directory where to generate the package | ||
1002 | </param> | ||
1003 | <param name="filePaths"> | ||
1004 | Paths to the add-ins to be packaged. Paths can be either the main assembly of an add-in, or an add-in | ||
1005 | manifest (.addin or .addin.xml). | ||
1006 | </param> | ||
1007 | <remarks> | ||
1008 | This method can be used to create a package for an add-in, which can then be pushed to an on-line | ||
1009 | repository. The package will include the main assembly or manifest of the add-in and any external | ||
1010 | file declared in the add-in metadata. | ||
1011 | </remarks> | ||
1012 | </member> | ||
1013 | <member name="M:Mono.Addins.Setup.SetupService.BuildRepository(Mono.Addins.IProgressStatus,System.String)"> | ||
1014 | <summary> | ||
1015 | Generates an on-line repository | ||
1016 | </summary> | ||
1017 | <param name="statusMonitor"> | ||
1018 | Progress monitor where to show progress status | ||
1019 | </param> | ||
1020 | <param name="path"> | ||
1021 | Path to the directory that contains the add-ins and that is going to be published | ||
1022 | </param> | ||
1023 | <remarks> | ||
1024 | This method generates the index files required to publish a directory as an online repository | ||
1025 | of add-ins. | ||
1026 | </remarks> | ||
1027 | </member> | ||
1028 | <member name="M:Mono.Addins.Setup.SetupService.GetExtensibleApplication(System.String)"> | ||
1029 | <summary> | ||
1030 | Gets a reference to an extensible application | ||
1031 | </summary> | ||
1032 | <param name="name"> | ||
1033 | Name of the application | ||
1034 | </param> | ||
1035 | <returns> | ||
1036 | The Application object. Null if not found. | ||
1037 | </returns> | ||
1038 | </member> | ||
1039 | <member name="M:Mono.Addins.Setup.SetupService.GetExtensibleApplication(System.String,System.Collections.Generic.IEnumerable{System.String})"> | ||
1040 | <summary> | ||
1041 | Gets a reference to an extensible application | ||
1042 | </summary> | ||
1043 | <param name="name"> | ||
1044 | Name of the application | ||
1045 | </param> | ||
1046 | <param name="searchPaths"> | ||
1047 | Custom paths where to look for the application. | ||
1048 | </param> | ||
1049 | <returns> | ||
1050 | The Application object. Null if not found. | ||
1051 | </returns> | ||
1052 | </member> | ||
1053 | <member name="M:Mono.Addins.Setup.SetupService.GetExtensibleApplications"> | ||
1054 | <summary> | ||
1055 | Gets a lis of all known extensible applications | ||
1056 | </summary> | ||
1057 | <returns> | ||
1058 | A list of applications. | ||
1059 | </returns> | ||
1060 | </member> | ||
1061 | <member name="M:Mono.Addins.Setup.SetupService.GetExtensibleApplications(System.Collections.Generic.IEnumerable{System.String})"> | ||
1062 | <summary> | ||
1063 | Gets a lis of all known extensible applications | ||
1064 | </summary> | ||
1065 | <param name="searchPaths"> | ||
1066 | Custom paths where to look for applications. | ||
1067 | </param> | ||
1068 | <returns> | ||
1069 | A list of applications. | ||
1070 | </returns> | ||
1071 | </member> | ||
1072 | <member name="P:Mono.Addins.Setup.SetupService.Registry"> | ||
1073 | <summary> | ||
1074 | The add-in registry being managed | ||
1075 | </summary> | ||
1076 | </member> | ||
1077 | <member name="P:Mono.Addins.Setup.SetupService.ApplicationNamespace"> | ||
1078 | <summary> | ||
1079 | Default add-in namespace of the application (optional). If set, only add-ins that belong to that namespace | ||
1080 | will be shown in add-in lists. | ||
1081 | </summary> | ||
1082 | </member> | ||
1083 | <member name="P:Mono.Addins.Setup.SetupService.InstallDirectory"> | ||
1084 | <summary> | ||
1085 | Directory where to install add-ins. If not specified, the 'addins' subdirectory of the | ||
1086 | registry location is used. | ||
1087 | </summary> | ||
1088 | </member> | ||
1089 | <member name="P:Mono.Addins.Setup.SetupService.Repositories"> | ||
1090 | <summary> | ||
1091 | Returns a RepositoryRegistry which can be used to manage on-line repository references | ||
1092 | </summary> | ||
1093 | </member> | ||
1094 | <member name="T:Mono.Addins.Setup.Application"> | ||
1095 | <summary> | ||
1096 | A registered extensible application | ||
1097 | </summary> | ||
1098 | </member> | ||
1099 | <member name="P:Mono.Addins.Setup.Application.Registry"> | ||
1100 | <summary> | ||
1101 | Add-in registry of the application | ||
1102 | </summary> | ||
1103 | </member> | ||
1104 | <member name="P:Mono.Addins.Setup.Application.Description"> | ||
1105 | <summary> | ||
1106 | Description of the application | ||
1107 | </summary> | ||
1108 | </member> | ||
1109 | <member name="P:Mono.Addins.Setup.Application.Name"> | ||
1110 | <summary> | ||
1111 | Name of the application | ||
1112 | </summary> | ||
1113 | </member> | ||
1114 | <member name="P:Mono.Addins.Setup.Application.RegistryPath"> | ||
1115 | <summary> | ||
1116 | Path to the add-in registry | ||
1117 | </summary> | ||
1118 | </member> | ||
1119 | <member name="P:Mono.Addins.Setup.Application.StartupPath"> | ||
1120 | <summary> | ||
1121 | Path to the directory that contains the main executable assembly of the application | ||
1122 | </summary> | ||
1123 | </member> | ||
1124 | <member name="P:Mono.Addins.Setup.Application.TestCommand"> | ||
1125 | <summary> | ||
1126 | Command to be used to execute the application in add-in development mode. | ||
1127 | </summary> | ||
1128 | </member> | ||
1129 | <member name="P:Mono.Addins.Setup.Application.AddinsPath"> | ||
1130 | <summary> | ||
1131 | Path to the default add-ins directory for the aplpication | ||
1132 | </summary> | ||
1133 | </member> | ||
1134 | <member name="P:Mono.Addins.Setup.Application.AddinCachePath"> | ||
1135 | <summary> | ||
1136 | Path to the add-in cache for the application | ||
1137 | </summary> | ||
1138 | </member> | ||
1139 | </members> | ||
1140 | </doc> | ||
diff --git a/bin/Mono.Addins.dll b/bin/Mono.Addins.dll index 326ed1d..3026991 100755 --- a/bin/Mono.Addins.dll +++ b/bin/Mono.Addins.dll | |||
Binary files differ | |||
diff --git a/bin/Mono.Addins.xml b/bin/Mono.Addins.xml new file mode 100644 index 0000000..b9bdd4c --- /dev/null +++ b/bin/Mono.Addins.xml | |||
@@ -0,0 +1,6120 @@ | |||
1 | <?xml version="1.0"?> | ||
2 | <doc> | ||
3 | <assembly> | ||
4 | <name>Mono.Addins</name> | ||
5 | </assembly> | ||
6 | <members> | ||
7 | <member name="T:Mono.Addins.Localization.IAddinLocalizer"> | ||
8 | <summary> | ||
9 | An add-in localizer. | ||
10 | </summary> | ||
11 | <remarks> | ||
12 | Add-in localizers which want to provide support for localization of plural forms | ||
13 | can additionally implement <see cref="T:Mono.Addins.Localization.IPluralAddinLocalizer"/>. | ||
14 | </remarks> | ||
15 | </member> | ||
16 | <member name="M:Mono.Addins.Localization.IAddinLocalizer.GetString(System.String)"> | ||
17 | <summary> | ||
18 | Gets a localized message. | ||
19 | </summary> | ||
20 | <returns> | ||
21 | The localized message. | ||
22 | </returns> | ||
23 | <param name='msgid'> | ||
24 | The message identifier. | ||
25 | </param> | ||
26 | </member> | ||
27 | <member name="T:Mono.Addins.Description.ExtensionNodeDescriptionCollection"> | ||
28 | <summary> | ||
29 | A collection of extension nodes | ||
30 | </summary> | ||
31 | </member> | ||
32 | <member name="T:Mono.Addins.Description.ObjectDescriptionCollection`1"> | ||
33 | <summary> | ||
34 | Base class for add-in description collections. | ||
35 | </summary> | ||
36 | </member> | ||
37 | <member name="T:Mono.Addins.Description.ObjectDescriptionCollection"> | ||
38 | <summary> | ||
39 | Base class for add-in description collections. | ||
40 | </summary> | ||
41 | </member> | ||
42 | <member name="M:Mono.Addins.Description.ObjectDescriptionCollection.#ctor"> | ||
43 | <summary> | ||
44 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.ObjectDescriptionCollection"/> class. | ||
45 | </summary> | ||
46 | </member> | ||
47 | <member name="M:Mono.Addins.Description.ObjectDescriptionCollection.Add(Mono.Addins.Description.ObjectDescription)"> | ||
48 | <summary> | ||
49 | Add an object. | ||
50 | </summary> | ||
51 | <param name='ep'> | ||
52 | The object. | ||
53 | </param> | ||
54 | </member> | ||
55 | <member name="M:Mono.Addins.Description.ObjectDescriptionCollection.AddRange(Mono.Addins.Description.ObjectDescriptionCollection)"> | ||
56 | <summary> | ||
57 | Adds a collection of objects. | ||
58 | </summary> | ||
59 | <param name='collection'> | ||
60 | The objects to add. | ||
61 | </param> | ||
62 | </member> | ||
63 | <member name="M:Mono.Addins.Description.ObjectDescriptionCollection.Insert(System.Int32,Mono.Addins.Description.ObjectDescription)"> | ||
64 | <summary> | ||
65 | Insert an object. | ||
66 | </summary> | ||
67 | <param name='index'> | ||
68 | Insertion index. | ||
69 | </param> | ||
70 | <param name='ep'> | ||
71 | The object. | ||
72 | </param> | ||
73 | </member> | ||
74 | <member name="M:Mono.Addins.Description.ObjectDescriptionCollection.Remove(Mono.Addins.Description.ObjectDescription)"> | ||
75 | <summary> | ||
76 | Removes an object. | ||
77 | </summary> | ||
78 | <param name='ep'> | ||
79 | Object to remove. | ||
80 | </param> | ||
81 | </member> | ||
82 | <member name="M:Mono.Addins.Description.ObjectDescriptionCollection.Contains(Mono.Addins.Description.ObjectDescription)"> | ||
83 | <summary> | ||
84 | Checks if an object is present in the collection. | ||
85 | </summary> | ||
86 | <param name='ob'> | ||
87 | Objecect to check. | ||
88 | </param> | ||
89 | </member> | ||
90 | <member name="T:Mono.Addins.NodeElementCollection"> | ||
91 | <summary> | ||
92 | A collection of NodeElement objects | ||
93 | </summary> | ||
94 | </member> | ||
95 | <member name="P:Mono.Addins.NodeElementCollection.Item(System.Int32)"> | ||
96 | <summary> | ||
97 | Gets the <see cref="T:Mono.Addins.NodeElement"/> at the specified index | ||
98 | </summary> | ||
99 | <param name="n"> | ||
100 | Index | ||
101 | </param> | ||
102 | </member> | ||
103 | <member name="M:Mono.Addins.Description.ExtensionNodeDescriptionCollection.#ctor"> | ||
104 | <summary> | ||
105 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.ExtensionNodeDescriptionCollection"/> class. | ||
106 | </summary> | ||
107 | </member> | ||
108 | <member name="P:Mono.Addins.Description.ExtensionNodeDescriptionCollection.Item(System.Int32)"> | ||
109 | <summary> | ||
110 | Gets the <see cref="T:Mono.Addins.Description.ExtensionNodeDescription"/> at the specified index. | ||
111 | </summary> | ||
112 | <param name="n"> | ||
113 | The index. | ||
114 | </param> | ||
115 | </member> | ||
116 | <member name="P:Mono.Addins.Description.ExtensionNodeDescriptionCollection.Item(System.String)"> | ||
117 | <summary> | ||
118 | Gets the <see cref="T:Mono.Addins.Description.ExtensionNodeDescription"/> with the specified identifier. | ||
119 | </summary> | ||
120 | <param name="id"> | ||
121 | Identifier. | ||
122 | </param> | ||
123 | </member> | ||
124 | <member name="T:Mono.Addins.ExtensionPointAttribute"> | ||
125 | <summary> | ||
126 | Declares an extension point. | ||
127 | </summary> | ||
128 | </member> | ||
129 | <member name="M:Mono.Addins.ExtensionPointAttribute.#ctor"> | ||
130 | <summary> | ||
131 | Initializes a new instance | ||
132 | </summary> | ||
133 | </member> | ||
134 | <member name="M:Mono.Addins.ExtensionPointAttribute.#ctor(System.String)"> | ||
135 | <summary> | ||
136 | Initializes a new instance | ||
137 | </summary> | ||
138 | <param name="path"> | ||
139 | Extension path that identifies the extension point | ||
140 | </param> | ||
141 | </member> | ||
142 | <member name="M:Mono.Addins.ExtensionPointAttribute.#ctor(System.String,System.Type)"> | ||
143 | <summary> | ||
144 | Initializes a new instance | ||
145 | </summary> | ||
146 | <param name="path"> | ||
147 | Extension path that identifies the extension point | ||
148 | </param> | ||
149 | <param name="nodeType"> | ||
150 | Type of the extension node to be created for extensions | ||
151 | </param> | ||
152 | </member> | ||
153 | <member name="M:Mono.Addins.ExtensionPointAttribute.#ctor(System.String,System.String,System.Type)"> | ||
154 | <summary> | ||
155 | Initializes a new instance | ||
156 | </summary> | ||
157 | <param name="path"> | ||
158 | Extension path that identifies the extension point | ||
159 | </param> | ||
160 | <param name="nodeName"> | ||
161 | Element name to be used when defining an extension in an XML manifest. | ||
162 | </param> | ||
163 | <param name="nodeType"> | ||
164 | Type of the extension node to be created for extensions | ||
165 | </param> | ||
166 | </member> | ||
167 | <member name="P:Mono.Addins.ExtensionPointAttribute.Path"> | ||
168 | <summary> | ||
169 | Extension path that identifies the extension point | ||
170 | </summary> | ||
171 | </member> | ||
172 | <member name="P:Mono.Addins.ExtensionPointAttribute.Description"> | ||
173 | <summary> | ||
174 | Long description of the extension point. | ||
175 | </summary> | ||
176 | </member> | ||
177 | <member name="P:Mono.Addins.ExtensionPointAttribute.NodeType"> | ||
178 | <summary> | ||
179 | Type of the extension node to be created for extensions | ||
180 | </summary> | ||
181 | </member> | ||
182 | <member name="P:Mono.Addins.ExtensionPointAttribute.ObjectType"> | ||
183 | <summary> | ||
184 | Expected extension object type (when nodes are of type TypeExtensionNode) | ||
185 | </summary> | ||
186 | </member> | ||
187 | <member name="P:Mono.Addins.ExtensionPointAttribute.NodeName"> | ||
188 | <summary> | ||
189 | Element name to be used when defining an extension in an XML manifest. The default name is "Type". | ||
190 | </summary> | ||
191 | </member> | ||
192 | <member name="P:Mono.Addins.ExtensionPointAttribute.Name"> | ||
193 | <summary> | ||
194 | Display name of the extension point. | ||
195 | </summary> | ||
196 | </member> | ||
197 | <member name="P:Mono.Addins.ExtensionPointAttribute.ExtensionAttributeType"> | ||
198 | <summary> | ||
199 | Type of the custom attribute to be used to specify metadata for the extension point | ||
200 | </summary> | ||
201 | </member> | ||
202 | <member name="T:Mono.Addins.AddinUrlAttribute"> | ||
203 | <summary> | ||
204 | Addin URL attribute. | ||
205 | </summary> | ||
206 | </member> | ||
207 | <member name="M:Mono.Addins.AddinUrlAttribute.#ctor(System.String)"> | ||
208 | <summary> | ||
209 | Initializes the attribute | ||
210 | </summary> | ||
211 | <param name="url"> | ||
212 | Url of the add-in | ||
213 | </param> | ||
214 | </member> | ||
215 | <member name="P:Mono.Addins.AddinUrlAttribute.Url"> | ||
216 | <summary> | ||
217 | Url of the add-in | ||
218 | </summary> | ||
219 | </member> | ||
220 | <member name="T:Mono.Addins.ExtensionNodeChildAttribute"> | ||
221 | <summary> | ||
222 | Declares allowed children of an extension node type. | ||
223 | </summary> | ||
224 | <remarks> | ||
225 | This attribute allows declaring the type of children that an extension node can have. | ||
226 | </remarks> | ||
227 | </member> | ||
228 | <member name="M:Mono.Addins.ExtensionNodeChildAttribute.#ctor(System.String)"> | ||
229 | <summary> | ||
230 | Initializes a new instance | ||
231 | </summary> | ||
232 | <param name="nodeName"> | ||
233 | Name of the allowed child extension node. | ||
234 | </param> | ||
235 | </member> | ||
236 | <member name="M:Mono.Addins.ExtensionNodeChildAttribute.#ctor(System.Type)"> | ||
237 | <summary> | ||
238 | Initializes a new instance | ||
239 | </summary> | ||
240 | <param name="extensionNodeType"> | ||
241 | Type of the allowed child extension node. | ||
242 | </param> | ||
243 | </member> | ||
244 | <member name="M:Mono.Addins.ExtensionNodeChildAttribute.#ctor(System.Type,System.String)"> | ||
245 | <summary> | ||
246 | Initializes a new instance | ||
247 | </summary> | ||
248 | <param name="extensionNodeType"> | ||
249 | Type of the allowed child extension node. | ||
250 | </param> | ||
251 | <param name="nodeName"> | ||
252 | Name of the allowed child extension node. | ||
253 | </param> | ||
254 | </member> | ||
255 | <member name="P:Mono.Addins.ExtensionNodeChildAttribute.NodeName"> | ||
256 | <summary> | ||
257 | Name of the allowed child extension node. | ||
258 | </summary> | ||
259 | </member> | ||
260 | <member name="P:Mono.Addins.ExtensionNodeChildAttribute.ExtensionNodeType"> | ||
261 | <summary> | ||
262 | Type of the allowed child extension node. | ||
263 | </summary> | ||
264 | </member> | ||
265 | <member name="T:Mono.Addins.AddinManager"> | ||
266 | <summary> | ||
267 | Provides access to add-in and extension model management operations. | ||
268 | </summary> | ||
269 | </member> | ||
270 | <member name="M:Mono.Addins.AddinManager.Initialize"> | ||
271 | <summary> | ||
272 | Initializes the add-in engine. | ||
273 | </summary> | ||
274 | <remarks> | ||
275 | The add-in engine needs to be initialized before doing any add-in operation. | ||
276 | When initialized with this method, it will look for add-ins in the global add-in registry. | ||
277 | </remarks> | ||
278 | </member> | ||
279 | <member name="M:Mono.Addins.AddinManager.Initialize(System.String)"> | ||
280 | <summary> | ||
281 | Initializes the add-in engine. | ||
282 | </summary> | ||
283 | <param name="configDir"> | ||
284 | Location of the add-in registry. | ||
285 | </param> | ||
286 | <remarks> | ||
287 | The add-in engine needs to be initialized before doing any add-in operation. | ||
288 | Configuration information about the add-in registry will be stored in the | ||
289 | provided location. The add-in engine will look for add-ins in an 'addins' | ||
290 | subdirectory of the provided directory. | ||
291 | |||
292 | When specifying a path, it is possible to use a special folder name as root. | ||
293 | For example: [Personal]/.config/MyApp. In this case, [Personal] will be replaced | ||
294 | by the location of the Environment.SpecialFolder.Personal folder. Any value | ||
295 | of the Environment.SpecialFolder enumeration can be used (always between square | ||
296 | brackets) | ||
297 | </remarks> | ||
298 | </member> | ||
299 | <member name="M:Mono.Addins.AddinManager.Initialize(System.String,System.String)"> | ||
300 | <summary> | ||
301 | Initializes the add-in engine. | ||
302 | </summary> | ||
303 | <param name='configDir'> | ||
304 | Location of the add-in registry. | ||
305 | </param> | ||
306 | <param name='addinsDir'> | ||
307 | Add-ins directory. If the path is relative, it is considered to be relative | ||
308 | to the configDir directory. | ||
309 | </param> | ||
310 | <remarks> | ||
311 | The add-in engine needs to be initialized before doing any add-in operation. | ||
312 | Configuration information about the add-in registry will be stored in the | ||
313 | provided location. The add-in engine will look for add-ins in the provided | ||
314 | 'addinsDir' directory. | ||
315 | |||
316 | When specifying a path, it is possible to use a special folder name as root. | ||
317 | For example: [Personal]/.config/MyApp. In this case, [Personal] will be replaced | ||
318 | by the location of the Environment.SpecialFolder.Personal folder. Any value | ||
319 | of the Environment.SpecialFolder enumeration can be used (always between square | ||
320 | brackets) | ||
321 | </remarks> | ||
322 | </member> | ||
323 | <member name="M:Mono.Addins.AddinManager.Initialize(System.String,System.String,System.String)"> | ||
324 | <summary> | ||
325 | Initializes the add-in engine. | ||
326 | </summary> | ||
327 | <param name='configDir'> | ||
328 | Location of the add-in registry. | ||
329 | </param> | ||
330 | <param name='addinsDir'> | ||
331 | Add-ins directory. If the path is relative, it is considered to be relative | ||
332 | to the configDir directory. | ||
333 | </param> | ||
334 | <param name='databaseDir'> | ||
335 | Location of the add-in database. If the path is relative, it is considered to be relative | ||
336 | to the configDir directory. | ||
337 | </param> | ||
338 | <remarks> | ||
339 | The add-in engine needs to be initialized before doing any add-in operation. | ||
340 | Configuration information about the add-in registry will be stored in the | ||
341 | provided location. The add-in engine will look for add-ins in the provided | ||
342 | 'addinsDir' directory. Cached information about add-ins will be stored in | ||
343 | the 'databaseDir' directory. | ||
344 | |||
345 | When specifying a path, it is possible to use a special folder name as root. | ||
346 | For example: [Personal]/.config/MyApp. In this case, [Personal] will be replaced | ||
347 | by the location of the Environment.SpecialFolder.Personal folder. Any value | ||
348 | of the Environment.SpecialFolder enumeration can be used (always between square | ||
349 | brackets) | ||
350 | </remarks> | ||
351 | </member> | ||
352 | <member name="M:Mono.Addins.AddinManager.Shutdown"> | ||
353 | <summary> | ||
354 | Finalizes an add-in engine. | ||
355 | </summary> | ||
356 | </member> | ||
357 | <member name="M:Mono.Addins.AddinManager.InitializeDefaultLocalizer(Mono.Addins.Localization.IAddinLocalizer)"> | ||
358 | <summary> | ||
359 | Sets the default localizer to be used for this add-in engine | ||
360 | </summary> | ||
361 | <param name="localizer"> | ||
362 | The add-in localizer | ||
363 | </param> | ||
364 | </member> | ||
365 | <member name="M:Mono.Addins.AddinManager.CheckInstalled(System.String,System.String[])"> | ||
366 | <summary> | ||
367 | Checks if the provided add-ins are installed, and requests the installation of those | ||
368 | which aren't. | ||
369 | </summary> | ||
370 | <param name="message"> | ||
371 | Message to show to the user when new add-ins have to be installed. | ||
372 | </param> | ||
373 | <param name="addinIds"> | ||
374 | List of IDs of the add-ins to be checked. | ||
375 | </param> | ||
376 | <remarks> | ||
377 | This method checks if the specified add-ins are installed. | ||
378 | If some of the add-ins are not installed, it will use | ||
379 | the installer assigned to the DefaultAddinInstaller property | ||
380 | to install them. If the installation fails, or if DefaultAddinInstaller | ||
381 | is not set, an exception will be thrown. | ||
382 | </remarks> | ||
383 | </member> | ||
384 | <member name="M:Mono.Addins.AddinManager.IsAddinLoaded(System.String)"> | ||
385 | <summary> | ||
386 | Checks if an add-in has been loaded. | ||
387 | </summary> | ||
388 | <param name="id"> | ||
389 | Full identifier of the add-in. | ||
390 | </param> | ||
391 | <returns> | ||
392 | True if the add-in is loaded. | ||
393 | </returns> | ||
394 | </member> | ||
395 | <member name="M:Mono.Addins.AddinManager.LoadAddin(Mono.Addins.IProgressStatus,System.String)"> | ||
396 | <summary> | ||
397 | Forces the loading of an add-in. | ||
398 | </summary> | ||
399 | <param name="statusMonitor"> | ||
400 | Status monitor to keep track of the loading process. | ||
401 | </param> | ||
402 | <param name="id"> | ||
403 | Full identifier of the add-in to load. | ||
404 | </param> | ||
405 | <remarks> | ||
406 | This method loads all assemblies that belong to an add-in in memory. | ||
407 | All add-ins on which the specified add-in depends will also be loaded. | ||
408 | Notice that in general add-ins don't need to be explicitely loaded using | ||
409 | this method, since the add-in engine will load them on demand. | ||
410 | </remarks> | ||
411 | </member> | ||
412 | <member name="M:Mono.Addins.AddinManager.CreateExtensionContext"> | ||
413 | <summary> | ||
414 | Creates a new extension context. | ||
415 | </summary> | ||
416 | <returns> | ||
417 | The new extension context. | ||
418 | </returns> | ||
419 | <remarks> | ||
420 | Extension contexts can be used to query the extension model using particular condition values. | ||
421 | </remarks> | ||
422 | </member> | ||
423 | <member name="M:Mono.Addins.AddinManager.GetExtensionNode(System.String)"> | ||
424 | <summary> | ||
425 | Returns the extension node in a path | ||
426 | </summary> | ||
427 | <param name="path"> | ||
428 | Location of the node. | ||
429 | </param> | ||
430 | <returns> | ||
431 | The node, or null if not found. | ||
432 | </returns> | ||
433 | </member> | ||
434 | <member name="M:Mono.Addins.AddinManager.GetExtensionNode``1(System.String)"> | ||
435 | <summary> | ||
436 | Returns the extension node in a path | ||
437 | </summary> | ||
438 | <param name="path"> | ||
439 | Location of the node. | ||
440 | </param> | ||
441 | <returns> | ||
442 | The node, or null if not found. | ||
443 | </returns> | ||
444 | </member> | ||
445 | <member name="M:Mono.Addins.AddinManager.GetExtensionNodes(System.String)"> | ||
446 | <summary> | ||
447 | Gets extension nodes registered in a path. | ||
448 | </summary> | ||
449 | <param name="path"> | ||
450 | An extension path.> | ||
451 | </param> | ||
452 | <returns> | ||
453 | All nodes registered in the provided path. | ||
454 | </returns> | ||
455 | </member> | ||
456 | <member name="M:Mono.Addins.AddinManager.GetExtensionNodes(System.String,System.Type)"> | ||
457 | <summary> | ||
458 | Gets extension nodes registered in a path. | ||
459 | </summary> | ||
460 | <param name="path"> | ||
461 | An extension path. | ||
462 | </param> | ||
463 | <param name="expectedNodeType"> | ||
464 | Expected node type. | ||
465 | </param> | ||
466 | <returns> | ||
467 | A list of nodes | ||
468 | </returns> | ||
469 | <remarks> | ||
470 | This method returns all nodes registered under the provided path. | ||
471 | It will throw a InvalidOperationException if the type of one of | ||
472 | the registered nodes is not assignable to the provided type. | ||
473 | </remarks> | ||
474 | </member> | ||
475 | <member name="M:Mono.Addins.AddinManager.GetExtensionNodes``1(System.String)"> | ||
476 | <summary> | ||
477 | Gets extension nodes registered in a path. | ||
478 | </summary> | ||
479 | <param name="path"> | ||
480 | An extension path. | ||
481 | </param> | ||
482 | <returns> | ||
483 | A list of nodes | ||
484 | </returns> | ||
485 | <remarks> | ||
486 | This method returns all nodes registered under the provided path. | ||
487 | It will throw a InvalidOperationException if the type of one of | ||
488 | the registered nodes is not assignable to the provided type. | ||
489 | </remarks> | ||
490 | </member> | ||
491 | <member name="M:Mono.Addins.AddinManager.GetExtensionNodes(System.Type)"> | ||
492 | <summary> | ||
493 | Gets extension nodes for a type extension point | ||
494 | </summary> | ||
495 | <param name="instanceType"> | ||
496 | Type defining the extension point | ||
497 | </param> | ||
498 | <returns> | ||
499 | A list of nodes | ||
500 | </returns> | ||
501 | <remarks> | ||
502 | This method returns all extension nodes bound to the provided type. | ||
503 | </remarks> | ||
504 | </member> | ||
505 | <member name="M:Mono.Addins.AddinManager.GetExtensionNodes(System.Type,System.Type)"> | ||
506 | <summary> | ||
507 | Gets extension nodes for a type extension point | ||
508 | </summary> | ||
509 | <param name="instanceType"> | ||
510 | Type defining the extension point | ||
511 | </param> | ||
512 | <param name="expectedNodeType"> | ||
513 | Expected extension node type | ||
514 | </param> | ||
515 | <returns> | ||
516 | A list of nodes | ||
517 | </returns> | ||
518 | <remarks> | ||
519 | This method returns all nodes registered for the provided type. | ||
520 | It will throw a InvalidOperationException if the type of one of | ||
521 | the registered nodes is not assignable to the provided node type. | ||
522 | </remarks> | ||
523 | </member> | ||
524 | <member name="M:Mono.Addins.AddinManager.GetExtensionNodes``1(System.Type)"> | ||
525 | <summary> | ||
526 | Gets extension nodes for a type extension point | ||
527 | </summary> | ||
528 | <param name="instanceType"> | ||
529 | Type defining the extension point | ||
530 | </param> | ||
531 | <returns> | ||
532 | A list of nodes | ||
533 | </returns> | ||
534 | <remarks> | ||
535 | This method returns all nodes registered for the provided type. | ||
536 | It will throw a InvalidOperationException if the type of one of | ||
537 | the registered nodes is not assignable to the specified node type argument. | ||
538 | </remarks> | ||
539 | </member> | ||
540 | <member name="M:Mono.Addins.AddinManager.GetExtensionObjects(System.Type)"> | ||
541 | <summary> | ||
542 | Gets extension objects registered for a type extension point. | ||
543 | </summary> | ||
544 | <param name="instanceType"> | ||
545 | Type defining the extension point | ||
546 | </param> | ||
547 | <returns> | ||
548 | A list of objects | ||
549 | </returns> | ||
550 | </member> | ||
551 | <member name="M:Mono.Addins.AddinManager.GetExtensionObjects``1"> | ||
552 | <summary> | ||
553 | Gets extension objects registered for a type extension point. | ||
554 | </summary> | ||
555 | <returns> | ||
556 | A list of objects | ||
557 | </returns> | ||
558 | <remarks> | ||
559 | The type argument of this generic method is the type that defines | ||
560 | the extension point. | ||
561 | </remarks> | ||
562 | </member> | ||
563 | <member name="M:Mono.Addins.AddinManager.GetExtensionObjects(System.Type,System.Boolean)"> | ||
564 | <summary> | ||
565 | Gets extension objects registered for a type extension point. | ||
566 | </summary> | ||
567 | <param name="instanceType"> | ||
568 | Type defining the extension point | ||
569 | </param> | ||
570 | <param name="reuseCachedInstance"> | ||
571 | When set to True, it will return instances created in previous calls. | ||
572 | </param> | ||
573 | <returns> | ||
574 | A list of extension objects. | ||
575 | </returns> | ||
576 | </member> | ||
577 | <member name="M:Mono.Addins.AddinManager.GetExtensionObjects``1(System.Boolean)"> | ||
578 | <summary> | ||
579 | Gets extension objects registered for a type extension point. | ||
580 | </summary> | ||
581 | <param name="reuseCachedInstance"> | ||
582 | When set to True, it will return instances created in previous calls. | ||
583 | </param> | ||
584 | <returns> | ||
585 | A list of extension objects. | ||
586 | </returns> | ||
587 | <remarks> | ||
588 | The type argument of this generic method is the type that defines | ||
589 | the extension point. | ||
590 | </remarks> | ||
591 | </member> | ||
592 | <member name="M:Mono.Addins.AddinManager.GetExtensionObjects(System.String)"> | ||
593 | <summary> | ||
594 | Gets extension objects registered in a path | ||
595 | </summary> | ||
596 | <param name="path"> | ||
597 | An extension path. | ||
598 | </param> | ||
599 | <returns> | ||
600 | An array of objects registered in the path. | ||
601 | </returns> | ||
602 | <remarks> | ||
603 | This method can only be used if all nodes in the provided extension path | ||
604 | are of type Mono.Addins.TypeExtensionNode. The returned array is composed | ||
605 | by all objects created by calling the TypeExtensionNode.CreateInstance() | ||
606 | method for each node. | ||
607 | </remarks> | ||
608 | </member> | ||
609 | <member name="M:Mono.Addins.AddinManager.GetExtensionObjects(System.String,System.Boolean)"> | ||
610 | <summary> | ||
611 | Gets extension objects registered in a path. | ||
612 | </summary> | ||
613 | <param name="path"> | ||
614 | An extension path. | ||
615 | </param> | ||
616 | <param name="reuseCachedInstance"> | ||
617 | When set to True, it will return instances created in previous calls. | ||
618 | </param> | ||
619 | <returns> | ||
620 | An array of objects registered in the path. | ||
621 | </returns> | ||
622 | <remarks> | ||
623 | This method can only be used if all nodes in the provided extension path | ||
624 | are of type Mono.Addins.TypeExtensionNode. The returned array is composed | ||
625 | by all objects created by calling the TypeExtensionNode.CreateInstance() | ||
626 | method for each node (or TypeExtensionNode.GetInstance() if | ||
627 | reuseCachedInstance is set to true) | ||
628 | </remarks> | ||
629 | </member> | ||
630 | <member name="M:Mono.Addins.AddinManager.GetExtensionObjects(System.String,System.Type)"> | ||
631 | <summary> | ||
632 | Gets extension objects registered in a path. | ||
633 | </summary> | ||
634 | <param name="path"> | ||
635 | An extension path. | ||
636 | </param> | ||
637 | <param name="arrayElementType"> | ||
638 | Type of the return array elements. | ||
639 | </param> | ||
640 | <returns> | ||
641 | An array of objects registered in the path. | ||
642 | </returns> | ||
643 | <remarks> | ||
644 | This method can only be used if all nodes in the provided extension path | ||
645 | are of type Mono.Addins.TypeExtensionNode. The returned array is composed | ||
646 | by all objects created by calling the TypeExtensionNode.CreateInstance() | ||
647 | method for each node. | ||
648 | |||
649 | An InvalidOperationException exception is thrown if one of the found | ||
650 | objects is not a subclass of the provided type. | ||
651 | </remarks> | ||
652 | </member> | ||
653 | <member name="M:Mono.Addins.AddinManager.GetExtensionObjects``1(System.String)"> | ||
654 | <summary> | ||
655 | Gets extension objects registered in a path. | ||
656 | </summary> | ||
657 | <param name="path"> | ||
658 | An extension path. | ||
659 | </param> | ||
660 | <returns> | ||
661 | An array of objects registered in the path. | ||
662 | </returns> | ||
663 | <remarks> | ||
664 | This method can only be used if all nodes in the provided extension path | ||
665 | are of type Mono.Addins.TypeExtensionNode. The returned array is composed | ||
666 | by all objects created by calling the TypeExtensionNode.CreateInstance() | ||
667 | method for each node. | ||
668 | |||
669 | An InvalidOperationException exception is thrown if one of the found | ||
670 | objects is not a subclass of the provided type. | ||
671 | </remarks> | ||
672 | </member> | ||
673 | <member name="M:Mono.Addins.AddinManager.GetExtensionObjects(System.String,System.Type,System.Boolean)"> | ||
674 | <summary> | ||
675 | Gets extension objects registered in a path. | ||
676 | </summary> | ||
677 | <param name="path"> | ||
678 | An extension path. | ||
679 | </param> | ||
680 | <param name="arrayElementType"> | ||
681 | Type of the return array elements. | ||
682 | </param> | ||
683 | <param name="reuseCachedInstance"> | ||
684 | When set to True, it will return instances created in previous calls. | ||
685 | </param> | ||
686 | <returns> | ||
687 | An array of objects registered in the path. | ||
688 | </returns> | ||
689 | <remarks> | ||
690 | This method can only be used if all nodes in the provided extension path | ||
691 | are of type Mono.Addins.TypeExtensionNode. The returned array is composed | ||
692 | by all objects created by calling the TypeExtensionNode.CreateInstance() | ||
693 | method for each node (or TypeExtensionNode.GetInstance() if | ||
694 | reuseCachedInstance is set to true). | ||
695 | |||
696 | An InvalidOperationException exception is thrown if one of the found | ||
697 | objects is not a subclass of the provided type. | ||
698 | </remarks> | ||
699 | </member> | ||
700 | <member name="M:Mono.Addins.AddinManager.GetExtensionObjects``1(System.String,System.Boolean)"> | ||
701 | <summary> | ||
702 | Gets extension objects registered in a path. | ||
703 | </summary> | ||
704 | <param name="path"> | ||
705 | An extension path. | ||
706 | </param> | ||
707 | <param name="reuseCachedInstance"> | ||
708 | When set to True, it will return instances created in previous calls. | ||
709 | </param> | ||
710 | <returns> | ||
711 | An array of objects registered in the path. | ||
712 | </returns> | ||
713 | <remarks> | ||
714 | This method can only be used if all nodes in the provided extension path | ||
715 | are of type Mono.Addins.TypeExtensionNode. The returned array is composed | ||
716 | by all objects created by calling the TypeExtensionNode.CreateInstance() | ||
717 | method for each node (or TypeExtensionNode.GetInstance() if | ||
718 | reuseCachedInstance is set to true). | ||
719 | |||
720 | An InvalidOperationException exception is thrown if one of the found | ||
721 | objects is not a subclass of the provided type. | ||
722 | </remarks> | ||
723 | </member> | ||
724 | <member name="M:Mono.Addins.AddinManager.AddExtensionNodeHandler(System.String,Mono.Addins.ExtensionNodeEventHandler)"> | ||
725 | <summary> | ||
726 | Register a listener of extension node changes. | ||
727 | </summary> | ||
728 | <param name="path"> | ||
729 | Path of the node. | ||
730 | </param> | ||
731 | <param name="handler"> | ||
732 | A handler method. | ||
733 | </param> | ||
734 | <remarks> | ||
735 | Hosts can call this method to be subscribed to an extension change | ||
736 | event for a specific path. The event will be fired once for every | ||
737 | individual node change. The event arguments include the change type | ||
738 | (Add or Remove) and the extension node added or removed. | ||
739 | |||
740 | NOTE: The handler will be called for all nodes existing in the path at the moment of registration. | ||
741 | </remarks> | ||
742 | </member> | ||
743 | <member name="M:Mono.Addins.AddinManager.RemoveExtensionNodeHandler(System.String,Mono.Addins.ExtensionNodeEventHandler)"> | ||
744 | <summary> | ||
745 | Unregister a listener of extension node changes. | ||
746 | </summary> | ||
747 | <param name="path"> | ||
748 | Path of the node. | ||
749 | </param> | ||
750 | <param name="handler"> | ||
751 | A handler method. | ||
752 | </param> | ||
753 | <remarks> | ||
754 | This method unregisters a delegate from the node change event of a path. | ||
755 | </remarks> | ||
756 | </member> | ||
757 | <member name="M:Mono.Addins.AddinManager.AddExtensionNodeHandler(System.Type,Mono.Addins.ExtensionNodeEventHandler)"> | ||
758 | <summary> | ||
759 | Register a listener of extension node changes. | ||
760 | </summary> | ||
761 | <param name="instanceType"> | ||
762 | Type defining the extension point | ||
763 | </param> | ||
764 | <param name="handler"> | ||
765 | A handler method. | ||
766 | </param> | ||
767 | <remarks> | ||
768 | Hosts can call this method to be subscribed to an extension change | ||
769 | event for a specific type extension point. The event will be fired once for every | ||
770 | individual node change. The event arguments include the change type | ||
771 | (Add or Remove) and the extension node added or removed. | ||
772 | |||
773 | NOTE: The handler will be called for all nodes existing in the path at the moment of registration. | ||
774 | </remarks> | ||
775 | </member> | ||
776 | <member name="M:Mono.Addins.AddinManager.RemoveExtensionNodeHandler(System.Type,Mono.Addins.ExtensionNodeEventHandler)"> | ||
777 | <summary> | ||
778 | Unregister a listener of extension node changes. | ||
779 | </summary> | ||
780 | <param name="instanceType"> | ||
781 | Type defining the extension point | ||
782 | </param> | ||
783 | <param name="handler"> | ||
784 | A handler method. | ||
785 | </param> | ||
786 | </member> | ||
787 | <member name="P:Mono.Addins.AddinManager.IsInitialized"> | ||
788 | <summary> | ||
789 | Gets whether the add-in engine has been initialized. | ||
790 | </summary> | ||
791 | </member> | ||
792 | <member name="P:Mono.Addins.AddinManager.DefaultInstaller"> | ||
793 | <summary> | ||
794 | Gets the default add-in installer | ||
795 | </summary> | ||
796 | <remarks> | ||
797 | The default installer is used by the CheckInstalled method to request | ||
798 | the installation of missing add-ins. | ||
799 | </remarks> | ||
800 | </member> | ||
801 | <member name="P:Mono.Addins.AddinManager.DefaultLocalizer"> | ||
802 | <summary> | ||
803 | Gets the default localizer for this add-in engine | ||
804 | </summary> | ||
805 | </member> | ||
806 | <member name="P:Mono.Addins.AddinManager.CurrentLocalizer"> | ||
807 | <summary> | ||
808 | Gets the localizer for the add-in that is invoking this property | ||
809 | </summary> | ||
810 | </member> | ||
811 | <member name="P:Mono.Addins.AddinManager.CurrentAddin"> | ||
812 | <summary> | ||
813 | Gets a reference to the RuntimeAddin object for the add-in that is invoking this property | ||
814 | </summary> | ||
815 | </member> | ||
816 | <member name="P:Mono.Addins.AddinManager.AddinEngine"> | ||
817 | <summary> | ||
818 | Gets the default add-in engine | ||
819 | </summary> | ||
820 | </member> | ||
821 | <member name="P:Mono.Addins.AddinManager.Registry"> | ||
822 | <summary> | ||
823 | Gets the add-in registry bound to the default add-in engine | ||
824 | </summary> | ||
825 | </member> | ||
826 | <member name="E:Mono.Addins.AddinManager.ExtensionChanged"> | ||
827 | <summary> | ||
828 | Extension change event. | ||
829 | </summary> | ||
830 | <remarks> | ||
831 | This event is fired when any extension point in the add-in system changes. | ||
832 | The event args object provides the path of the changed extension, although | ||
833 | it does not provide information about what changed. Hosts subscribing to | ||
834 | this event should get the new list of nodes using a query method such as | ||
835 | AddinManager.GetExtensionNodes() and then update whatever needs to be updated. | ||
836 | </remarks> | ||
837 | </member> | ||
838 | <member name="E:Mono.Addins.AddinManager.AddinLoadError"> | ||
839 | <summary> | ||
840 | Add-in loading error event. | ||
841 | </summary> | ||
842 | <remarks> | ||
843 | This event is fired when there is an error when loading the extension | ||
844 | of an add-in, or any other kind of error that may happen when querying extension points. | ||
845 | </remarks> | ||
846 | </member> | ||
847 | <member name="E:Mono.Addins.AddinManager.AddinLoaded"> | ||
848 | <summary> | ||
849 | Add-in loaded event. | ||
850 | </summary> | ||
851 | <remarks> | ||
852 | Fired after loading an add-in in memory. | ||
853 | </remarks> | ||
854 | </member> | ||
855 | <member name="E:Mono.Addins.AddinManager.AddinUnloaded"> | ||
856 | <summary> | ||
857 | Add-in unload event. | ||
858 | </summary> | ||
859 | <remarks> | ||
860 | Fired when an add-in is unloaded from memory. It may happen an add-in is disabled or uninstalled. | ||
861 | </remarks> | ||
862 | </member> | ||
863 | <member name="T:Mono.Addins.Description.ExtensionNodeDescription"> | ||
864 | <summary> | ||
865 | An extension node definition. | ||
866 | </summary> | ||
867 | </member> | ||
868 | <member name="T:Mono.Addins.Description.ObjectDescription"> | ||
869 | <summary> | ||
870 | Base class for add-in description definitions. | ||
871 | </summary> | ||
872 | </member> | ||
873 | <member name="P:Mono.Addins.Description.ObjectDescription.Parent"> | ||
874 | <summary> | ||
875 | Gets the parent object. | ||
876 | </summary> | ||
877 | <value> | ||
878 | The parent object. | ||
879 | </value> | ||
880 | </member> | ||
881 | <member name="P:Mono.Addins.Description.ObjectDescription.ParentAddinDescription"> | ||
882 | <summary> | ||
883 | Gets the parent add-in description. | ||
884 | </summary> | ||
885 | <value> | ||
886 | The parent add-in description. | ||
887 | </value> | ||
888 | </member> | ||
889 | <member name="T:Mono.Addins.NodeElement"> | ||
890 | <summary> | ||
891 | An extension node element. | ||
892 | </summary> | ||
893 | <remarks> | ||
894 | A raw representation of an extension node. Contains the basic information | ||
895 | needed to create ExtensionNode instances. | ||
896 | </remarks> | ||
897 | </member> | ||
898 | <member name="M:Mono.Addins.NodeElement.GetAttribute(System.String)"> | ||
899 | <summary> | ||
900 | Gets element attributes. | ||
901 | </summary> | ||
902 | <param name="key"> | ||
903 | Name of the attribute | ||
904 | </param> | ||
905 | <returns> | ||
906 | The value of the attribute | ||
907 | </returns> | ||
908 | </member> | ||
909 | <member name="P:Mono.Addins.NodeElement.NodeName"> | ||
910 | <summary> | ||
911 | Name of the node element. | ||
912 | </summary> | ||
913 | </member> | ||
914 | <member name="P:Mono.Addins.NodeElement.Attributes"> | ||
915 | <summary> | ||
916 | Gets all attributes defined in the element. | ||
917 | </summary> | ||
918 | </member> | ||
919 | <member name="P:Mono.Addins.NodeElement.ChildNodes"> | ||
920 | <summary> | ||
921 | Gets child nodes of this node | ||
922 | </summary> | ||
923 | </member> | ||
924 | <member name="M:Mono.Addins.Description.ExtensionNodeDescription.#ctor(System.String)"> | ||
925 | <summary> | ||
926 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.ExtensionNodeDescription"/> class. | ||
927 | </summary> | ||
928 | <param name="nodeName"> | ||
929 | Node name. | ||
930 | </param> | ||
931 | </member> | ||
932 | <member name="M:Mono.Addins.Description.ExtensionNodeDescription.GetNodeType"> | ||
933 | <summary> | ||
934 | Gets the type of the node. | ||
935 | </summary> | ||
936 | <returns> | ||
937 | The node type. | ||
938 | </returns> | ||
939 | <remarks> | ||
940 | This method only works when the add-in description to which the node belongs has been | ||
941 | loaded from an add-in registry. | ||
942 | </remarks> | ||
943 | </member> | ||
944 | <member name="M:Mono.Addins.Description.ExtensionNodeDescription.GetParentPath"> | ||
945 | <summary> | ||
946 | Gets the extension path under which this node is registered | ||
947 | </summary> | ||
948 | <returns> | ||
949 | The parent path. | ||
950 | </returns> | ||
951 | <remarks> | ||
952 | For example, if the id of the node is 'ThisNode', and the node is a child of another node with id 'ParentNode', and | ||
953 | that parent node is defined in an extension with the path '/Core/MainExtension', then the parent path is 'Core/MainExtension/ParentNode'. | ||
954 | </remarks> | ||
955 | </member> | ||
956 | <member name="M:Mono.Addins.Description.ExtensionNodeDescription.GetAttribute(System.String)"> | ||
957 | <summary> | ||
958 | Gets the value of an attribute. | ||
959 | </summary> | ||
960 | <returns> | ||
961 | The value of the attribute, or an empty string if the attribute is not defined. | ||
962 | </returns> | ||
963 | <param name='key'> | ||
964 | Name of the attribute. | ||
965 | </param> | ||
966 | </member> | ||
967 | <member name="M:Mono.Addins.Description.ExtensionNodeDescription.SetAttribute(System.String,System.String)"> | ||
968 | <summary> | ||
969 | Sets the value of an attribute. | ||
970 | </summary> | ||
971 | <param name='key'> | ||
972 | Name of the attribute | ||
973 | </param> | ||
974 | <param name='value'> | ||
975 | The value. | ||
976 | </param> | ||
977 | </member> | ||
978 | <member name="M:Mono.Addins.Description.ExtensionNodeDescription.RemoveAttribute(System.String)"> | ||
979 | <summary> | ||
980 | Removes an attribute. | ||
981 | </summary> | ||
982 | <param name='name'> | ||
983 | Name of the attribute to remove. | ||
984 | </param> | ||
985 | </member> | ||
986 | <member name="P:Mono.Addins.Description.ExtensionNodeDescription.NodeName"> | ||
987 | <summary> | ||
988 | Gets or sets the name of the node. | ||
989 | </summary> | ||
990 | <value> | ||
991 | The name of the node. | ||
992 | </value> | ||
993 | </member> | ||
994 | <member name="P:Mono.Addins.Description.ExtensionNodeDescription.Id"> | ||
995 | <summary> | ||
996 | Gets or sets the identifier of the node. | ||
997 | </summary> | ||
998 | <value> | ||
999 | The identifier. | ||
1000 | </value> | ||
1001 | </member> | ||
1002 | <member name="P:Mono.Addins.Description.ExtensionNodeDescription.InsertAfter"> | ||
1003 | <summary> | ||
1004 | Gets or sets the identifier of the node after which this node has to be inserted | ||
1005 | </summary> | ||
1006 | <value> | ||
1007 | The identifier of the reference node | ||
1008 | </value> | ||
1009 | </member> | ||
1010 | <member name="P:Mono.Addins.Description.ExtensionNodeDescription.InsertBefore"> | ||
1011 | <summary> | ||
1012 | Gets or sets the identifier of the node before which this node has to be inserted | ||
1013 | </summary> | ||
1014 | <value> | ||
1015 | The identifier of the reference node | ||
1016 | </value> | ||
1017 | </member> | ||
1018 | <member name="P:Mono.Addins.Description.ExtensionNodeDescription.IsCondition"> | ||
1019 | <summary> | ||
1020 | Gets a value indicating whether this node is a condition. | ||
1021 | </summary> | ||
1022 | <value> | ||
1023 | <c>true</c> if this node is a condition; otherwise, <c>false</c>. | ||
1024 | </value> | ||
1025 | </member> | ||
1026 | <member name="P:Mono.Addins.Description.ExtensionNodeDescription.Attributes"> | ||
1027 | <summary> | ||
1028 | Gets the attributes of the node. | ||
1029 | </summary> | ||
1030 | <value> | ||
1031 | The attributes. | ||
1032 | </value> | ||
1033 | </member> | ||
1034 | <member name="P:Mono.Addins.Description.ExtensionNodeDescription.ChildNodes"> | ||
1035 | <summary> | ||
1036 | Gets the child nodes. | ||
1037 | </summary> | ||
1038 | <value> | ||
1039 | The child nodes. | ||
1040 | </value> | ||
1041 | </member> | ||
1042 | <member name="T:Mono.Addins.Description.ExtensionNodeType"> | ||
1043 | <summary> | ||
1044 | An extension node type definition. | ||
1045 | </summary> | ||
1046 | </member> | ||
1047 | <member name="T:Mono.Addins.Description.ExtensionNodeSet"> | ||
1048 | <summary> | ||
1049 | An extension node set definition. | ||
1050 | </summary> | ||
1051 | <remarks> | ||
1052 | Node sets allow grouping a set of extension node declarations and give an identifier to that group | ||
1053 | (the node set). Once a node set is declared, it can be referenced from several extension points | ||
1054 | which use the same extension node structure. Extension node sets also allow declaring recursive | ||
1055 | extension nodes, that is, extension nodes with a tree structure. | ||
1056 | </remarks> | ||
1057 | </member> | ||
1058 | <member name="M:Mono.Addins.Description.ExtensionNodeSet.CopyFrom(Mono.Addins.Description.ExtensionNodeSet)"> | ||
1059 | <summary> | ||
1060 | Copies data from another node set | ||
1061 | </summary> | ||
1062 | <param name='nset'> | ||
1063 | Node set from which to copy | ||
1064 | </param> | ||
1065 | </member> | ||
1066 | <member name="M:Mono.Addins.Description.ExtensionNodeSet.#ctor"> | ||
1067 | <summary> | ||
1068 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.ExtensionNodeSet"/> class. | ||
1069 | </summary> | ||
1070 | </member> | ||
1071 | <member name="M:Mono.Addins.Description.ExtensionNodeSet.GetAllowedNodeTypes"> | ||
1072 | <summary> | ||
1073 | Gets all the allowed node types. | ||
1074 | </summary> | ||
1075 | <returns> | ||
1076 | The allowed node types. | ||
1077 | </returns> | ||
1078 | <remarks> | ||
1079 | Gets all allowed node types, including those defined in included node sets. | ||
1080 | This method only works for descriptions loaded from a registry. | ||
1081 | </remarks> | ||
1082 | </member> | ||
1083 | <member name="P:Mono.Addins.Description.ExtensionNodeSet.Id"> | ||
1084 | <summary> | ||
1085 | Gets or sets the identifier of the node set. | ||
1086 | </summary> | ||
1087 | <value> | ||
1088 | The identifier. | ||
1089 | </value> | ||
1090 | </member> | ||
1091 | <member name="P:Mono.Addins.Description.ExtensionNodeSet.NodeTypes"> | ||
1092 | <summary> | ||
1093 | Gets the node types allowed in this node set. | ||
1094 | </summary> | ||
1095 | <value> | ||
1096 | The node types. | ||
1097 | </value> | ||
1098 | </member> | ||
1099 | <member name="P:Mono.Addins.Description.ExtensionNodeSet.NodeSets"> | ||
1100 | <summary> | ||
1101 | Gets a list of other node sets included in this node set. | ||
1102 | </summary> | ||
1103 | <value> | ||
1104 | The node sets. | ||
1105 | </value> | ||
1106 | </member> | ||
1107 | <member name="M:Mono.Addins.Description.ExtensionNodeType.#ctor"> | ||
1108 | <summary> | ||
1109 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.ExtensionNodeType"/> class. | ||
1110 | </summary> | ||
1111 | </member> | ||
1112 | <member name="M:Mono.Addins.Description.ExtensionNodeType.CopyFrom(Mono.Addins.Description.ExtensionNodeType)"> | ||
1113 | <summary> | ||
1114 | Copies data from another node set | ||
1115 | </summary> | ||
1116 | </member> | ||
1117 | <member name="P:Mono.Addins.Description.ExtensionNodeType.TypeName"> | ||
1118 | <summary> | ||
1119 | Type that implements the extension node. | ||
1120 | </summary> | ||
1121 | <value> | ||
1122 | The full name of the type. | ||
1123 | </value> | ||
1124 | </member> | ||
1125 | <member name="P:Mono.Addins.Description.ExtensionNodeType.NodeName"> | ||
1126 | <summary> | ||
1127 | Element name to be used when defining an extension in an XML manifest. The default name is "Type". | ||
1128 | </summary> | ||
1129 | <value> | ||
1130 | The name of the node. | ||
1131 | </value> | ||
1132 | </member> | ||
1133 | <member name="P:Mono.Addins.Description.ExtensionNodeType.ObjectTypeName"> | ||
1134 | <summary> | ||
1135 | Type of the object that the extension creates (only valid for TypeNodeExtension). | ||
1136 | </summary> | ||
1137 | </member> | ||
1138 | <member name="P:Mono.Addins.Description.ExtensionNodeType.ExtensionAttributeTypeName"> | ||
1139 | <summary> | ||
1140 | Name of the custom attribute that can be used to declare nodes of this type | ||
1141 | </summary> | ||
1142 | </member> | ||
1143 | <member name="P:Mono.Addins.Description.ExtensionNodeType.Description"> | ||
1144 | <summary> | ||
1145 | Long description of the node type | ||
1146 | </summary> | ||
1147 | </member> | ||
1148 | <member name="P:Mono.Addins.Description.ExtensionNodeType.Attributes"> | ||
1149 | <summary> | ||
1150 | Attributes supported by the extension node type. | ||
1151 | </summary> | ||
1152 | </member> | ||
1153 | <member name="T:Mono.Addins.Description.AddinDescription"> | ||
1154 | <summary> | ||
1155 | An add-in description | ||
1156 | </summary> | ||
1157 | <remarks> | ||
1158 | This class represent an add-in manifest. It has properties for getting | ||
1159 | all information, and methods for loading and saving files. | ||
1160 | </remarks> | ||
1161 | </member> | ||
1162 | <member name="M:Mono.Addins.Description.AddinDescription.AddExtensionPoint(System.String)"> | ||
1163 | <summary> | ||
1164 | Adds an extension point. | ||
1165 | </summary> | ||
1166 | <returns> | ||
1167 | The extension point. | ||
1168 | </returns> | ||
1169 | <param name='path'> | ||
1170 | Path that identifies the new extension point. | ||
1171 | </param> | ||
1172 | </member> | ||
1173 | <member name="M:Mono.Addins.Description.AddinDescription.Save(System.String)"> | ||
1174 | <summary> | ||
1175 | Saves the add-in description. | ||
1176 | </summary> | ||
1177 | <param name='fileName'> | ||
1178 | File name where to save this instance | ||
1179 | </param> | ||
1180 | <remarks> | ||
1181 | Saves the add-in description to the specified file and sets the FileName property. | ||
1182 | </remarks> | ||
1183 | </member> | ||
1184 | <member name="M:Mono.Addins.Description.AddinDescription.Save"> | ||
1185 | <summary> | ||
1186 | Saves the add-in description. | ||
1187 | </summary> | ||
1188 | <exception cref="T:System.InvalidOperationException"> | ||
1189 | It is thrown if FileName is not set | ||
1190 | </exception> | ||
1191 | <remarks> | ||
1192 | The description is saved to the file specified in the FileName property. | ||
1193 | </remarks> | ||
1194 | </member> | ||
1195 | <member name="M:Mono.Addins.Description.AddinDescription.SaveToXml"> | ||
1196 | <summary> | ||
1197 | Generates an XML representation of the add-in description | ||
1198 | </summary> | ||
1199 | <returns> | ||
1200 | An XML manifest. | ||
1201 | </returns> | ||
1202 | </member> | ||
1203 | <member name="M:Mono.Addins.Description.AddinDescription.Read(System.String)"> | ||
1204 | <summary> | ||
1205 | Load an add-in description from a file | ||
1206 | </summary> | ||
1207 | <param name='configFile'> | ||
1208 | The file. | ||
1209 | </param> | ||
1210 | </member> | ||
1211 | <member name="M:Mono.Addins.Description.AddinDescription.Read(System.IO.Stream,System.String)"> | ||
1212 | <summary> | ||
1213 | Load an add-in description from a stream | ||
1214 | </summary> | ||
1215 | <param name='stream'> | ||
1216 | The stream | ||
1217 | </param> | ||
1218 | <param name='basePath'> | ||
1219 | The path to be used to resolve relative file paths. | ||
1220 | </param> | ||
1221 | </member> | ||
1222 | <member name="M:Mono.Addins.Description.AddinDescription.Read(System.IO.TextReader,System.String)"> | ||
1223 | <summary> | ||
1224 | Load an add-in description from a text reader | ||
1225 | </summary> | ||
1226 | <param name='reader'> | ||
1227 | The text reader | ||
1228 | </param> | ||
1229 | <param name='basePath'> | ||
1230 | The path to be used to resolve relative file paths. | ||
1231 | </param> | ||
1232 | </member> | ||
1233 | <member name="M:Mono.Addins.Description.AddinDescription.Verify"> | ||
1234 | <summary> | ||
1235 | Verify this instance. | ||
1236 | </summary> | ||
1237 | <remarks> | ||
1238 | This method checks all the definitions in the description and returns a list of errors. | ||
1239 | If the returned list is empty, it means that the description is valid. | ||
1240 | </remarks> | ||
1241 | </member> | ||
1242 | <member name="P:Mono.Addins.Description.AddinDescription.AddinFile"> | ||
1243 | <summary> | ||
1244 | Gets or sets the path to the main addin file. | ||
1245 | </summary> | ||
1246 | <value> | ||
1247 | The addin file. | ||
1248 | </value> | ||
1249 | <remarks> | ||
1250 | The add-in file can be either the main assembly of an add-in or an xml manifest. | ||
1251 | </remarks> | ||
1252 | </member> | ||
1253 | <member name="P:Mono.Addins.Description.AddinDescription.AddinId"> | ||
1254 | <summary> | ||
1255 | Gets the addin identifier. | ||
1256 | </summary> | ||
1257 | <value> | ||
1258 | The addin identifier. | ||
1259 | </value> | ||
1260 | </member> | ||
1261 | <member name="P:Mono.Addins.Description.AddinDescription.LocalId"> | ||
1262 | <summary> | ||
1263 | Gets or sets the local identifier. | ||
1264 | </summary> | ||
1265 | <value> | ||
1266 | The local identifier. | ||
1267 | </value> | ||
1268 | </member> | ||
1269 | <member name="P:Mono.Addins.Description.AddinDescription.Namespace"> | ||
1270 | <summary> | ||
1271 | Gets or sets the namespace. | ||
1272 | </summary> | ||
1273 | <value> | ||
1274 | The namespace. | ||
1275 | </value> | ||
1276 | </member> | ||
1277 | <member name="P:Mono.Addins.Description.AddinDescription.Name"> | ||
1278 | <summary> | ||
1279 | Gets or sets the display name of the add-in. | ||
1280 | </summary> | ||
1281 | <value> | ||
1282 | The name. | ||
1283 | </value> | ||
1284 | </member> | ||
1285 | <member name="P:Mono.Addins.Description.AddinDescription.Version"> | ||
1286 | <summary> | ||
1287 | Gets or sets the version. | ||
1288 | </summary> | ||
1289 | <value> | ||
1290 | The version. | ||
1291 | </value> | ||
1292 | </member> | ||
1293 | <member name="P:Mono.Addins.Description.AddinDescription.CompatVersion"> | ||
1294 | <summary> | ||
1295 | Gets or sets the version of the add-in with which this add-in is backwards compatible. | ||
1296 | </summary> | ||
1297 | <value> | ||
1298 | The compat version. | ||
1299 | </value> | ||
1300 | </member> | ||
1301 | <member name="P:Mono.Addins.Description.AddinDescription.Author"> | ||
1302 | <summary> | ||
1303 | Gets or sets the author. | ||
1304 | </summary> | ||
1305 | <value> | ||
1306 | The author. | ||
1307 | </value> | ||
1308 | </member> | ||
1309 | <member name="P:Mono.Addins.Description.AddinDescription.Url"> | ||
1310 | <summary> | ||
1311 | Gets or sets the Url where more information about the add-in can be found. | ||
1312 | </summary> | ||
1313 | <value> | ||
1314 | The URL. | ||
1315 | </value> | ||
1316 | </member> | ||
1317 | <member name="P:Mono.Addins.Description.AddinDescription.Copyright"> | ||
1318 | <summary> | ||
1319 | Gets or sets the copyright. | ||
1320 | </summary> | ||
1321 | <value> | ||
1322 | The copyright. | ||
1323 | </value> | ||
1324 | </member> | ||
1325 | <member name="P:Mono.Addins.Description.AddinDescription.Description"> | ||
1326 | <summary> | ||
1327 | Gets or sets the description of the add-in. | ||
1328 | </summary> | ||
1329 | <value> | ||
1330 | The description. | ||
1331 | </value> | ||
1332 | </member> | ||
1333 | <member name="P:Mono.Addins.Description.AddinDescription.Category"> | ||
1334 | <summary> | ||
1335 | Gets or sets the category of the add-in. | ||
1336 | </summary> | ||
1337 | <value> | ||
1338 | The category. | ||
1339 | </value> | ||
1340 | </member> | ||
1341 | <member name="P:Mono.Addins.Description.AddinDescription.BasePath"> | ||
1342 | <summary> | ||
1343 | Gets the base path for locating external files relative to the add-in. | ||
1344 | </summary> | ||
1345 | <value> | ||
1346 | The base path. | ||
1347 | </value> | ||
1348 | </member> | ||
1349 | <member name="P:Mono.Addins.Description.AddinDescription.IsRoot"> | ||
1350 | <summary> | ||
1351 | Gets or sets a value indicating whether this instance is an add-in root. | ||
1352 | </summary> | ||
1353 | <value> | ||
1354 | <c>true</c> if this instance is an add-in root; otherwise, <c>false</c>. | ||
1355 | </value> | ||
1356 | </member> | ||
1357 | <member name="P:Mono.Addins.Description.AddinDescription.EnabledByDefault"> | ||
1358 | <summary> | ||
1359 | Gets or sets a value indicating whether this add-in is enabled by default. | ||
1360 | </summary> | ||
1361 | <value> | ||
1362 | <c>true</c> if enabled by default; otherwise, <c>false</c>. | ||
1363 | </value> | ||
1364 | </member> | ||
1365 | <member name="P:Mono.Addins.Description.AddinDescription.Flags"> | ||
1366 | <summary> | ||
1367 | Gets or sets the add-in flags. | ||
1368 | </summary> | ||
1369 | <value> | ||
1370 | The flags. | ||
1371 | </value> | ||
1372 | </member> | ||
1373 | <member name="P:Mono.Addins.Description.AddinDescription.CanDisable"> | ||
1374 | <summary> | ||
1375 | Gets a value indicating whether this add-in can be disabled. | ||
1376 | </summary> | ||
1377 | <value> | ||
1378 | <c>true</c> if this add-in can be disabled; otherwise, <c>false</c>. | ||
1379 | </value> | ||
1380 | </member> | ||
1381 | <member name="P:Mono.Addins.Description.AddinDescription.CanUninstall"> | ||
1382 | <summary> | ||
1383 | Gets a value indicating whether this add-in can be uninstalled. | ||
1384 | </summary> | ||
1385 | <value> | ||
1386 | <c>true</c> if this instance can be uninstalled; otherwise, <c>false</c>. | ||
1387 | </value> | ||
1388 | </member> | ||
1389 | <member name="P:Mono.Addins.Description.AddinDescription.IsHidden"> | ||
1390 | <summary> | ||
1391 | Gets a value indicating whether this add-in is hidden. | ||
1392 | </summary> | ||
1393 | <value> | ||
1394 | <c>true</c> if this add-in is hidden; otherwise, <c>false</c>. | ||
1395 | </value> | ||
1396 | </member> | ||
1397 | <member name="P:Mono.Addins.Description.AddinDescription.AllFiles"> | ||
1398 | <summary> | ||
1399 | Gets all external files | ||
1400 | </summary> | ||
1401 | <value> | ||
1402 | All files. | ||
1403 | </value> | ||
1404 | <remarks> | ||
1405 | External files are data files and assemblies explicitly referenced in the Runtime section of the add-in manifest. | ||
1406 | </remarks> | ||
1407 | </member> | ||
1408 | <member name="P:Mono.Addins.Description.AddinDescription.AllIgnorePaths"> | ||
1409 | <summary> | ||
1410 | Gets all paths to be ignored by the add-in scanner. | ||
1411 | </summary> | ||
1412 | <value> | ||
1413 | All paths to be ignored. | ||
1414 | </value> | ||
1415 | </member> | ||
1416 | <member name="P:Mono.Addins.Description.AddinDescription.MainModule"> | ||
1417 | <summary> | ||
1418 | Gets the main module. | ||
1419 | </summary> | ||
1420 | <value> | ||
1421 | The main module. | ||
1422 | </value> | ||
1423 | </member> | ||
1424 | <member name="P:Mono.Addins.Description.AddinDescription.OptionalModules"> | ||
1425 | <summary> | ||
1426 | Gets the optional modules. | ||
1427 | </summary> | ||
1428 | <value> | ||
1429 | The optional modules. | ||
1430 | </value> | ||
1431 | <remarks> | ||
1432 | Optional modules can be used to declare extensions which will be registered only if some specified | ||
1433 | add-in dependencies can be satisfied. Dependencies specified in optional modules are 'soft dependencies', | ||
1434 | which means that they don't need to be satisfied in order to load the add-in. | ||
1435 | </remarks> | ||
1436 | </member> | ||
1437 | <member name="P:Mono.Addins.Description.AddinDescription.AllModules"> | ||
1438 | <summary> | ||
1439 | Gets all modules (including the main module and all optional modules) | ||
1440 | </summary> | ||
1441 | <value> | ||
1442 | All modules. | ||
1443 | </value> | ||
1444 | </member> | ||
1445 | <member name="P:Mono.Addins.Description.AddinDescription.ExtensionNodeSets"> | ||
1446 | <summary> | ||
1447 | Gets the extension node sets. | ||
1448 | </summary> | ||
1449 | <value> | ||
1450 | The extension node sets. | ||
1451 | </value> | ||
1452 | </member> | ||
1453 | <member name="P:Mono.Addins.Description.AddinDescription.ExtensionPoints"> | ||
1454 | <summary> | ||
1455 | Gets the extension points. | ||
1456 | </summary> | ||
1457 | <value> | ||
1458 | The extension points. | ||
1459 | </value> | ||
1460 | </member> | ||
1461 | <member name="P:Mono.Addins.Description.AddinDescription.ConditionTypes"> | ||
1462 | <summary> | ||
1463 | Gets the condition types. | ||
1464 | </summary> | ||
1465 | <value> | ||
1466 | The condition types. | ||
1467 | </value> | ||
1468 | </member> | ||
1469 | <member name="P:Mono.Addins.Description.AddinDescription.Localizer"> | ||
1470 | <summary> | ||
1471 | Gets or sets the add-in localizer. | ||
1472 | </summary> | ||
1473 | <value> | ||
1474 | The description of the add-in localizer for this add-in. | ||
1475 | </value> | ||
1476 | </member> | ||
1477 | <member name="P:Mono.Addins.Description.AddinDescription.Properties"> | ||
1478 | <summary> | ||
1479 | Custom properties specified in the add-in header | ||
1480 | </summary> | ||
1481 | </member> | ||
1482 | <member name="P:Mono.Addins.Description.AddinDescription.FileName"> | ||
1483 | <summary> | ||
1484 | Gets or sets file where this description is stored | ||
1485 | </summary> | ||
1486 | <value> | ||
1487 | The file path. | ||
1488 | </value> | ||
1489 | </member> | ||
1490 | <member name="T:Mono.Addins.AddinFlagsAttribute"> | ||
1491 | <summary> | ||
1492 | Addin flags attribute. | ||
1493 | </summary> | ||
1494 | </member> | ||
1495 | <member name="M:Mono.Addins.AddinFlagsAttribute.#ctor(Mono.Addins.Description.AddinFlags)"> | ||
1496 | <summary> | ||
1497 | Initializes the attribute | ||
1498 | </summary> | ||
1499 | <param name="flags"> | ||
1500 | Add-in flags | ||
1501 | </param> | ||
1502 | </member> | ||
1503 | <member name="P:Mono.Addins.AddinFlagsAttribute.Flags"> | ||
1504 | <summary> | ||
1505 | Add-in flags | ||
1506 | </summary> | ||
1507 | </member> | ||
1508 | <member name="T:Mono.Addins.AddinEventHandler"> | ||
1509 | <summary> | ||
1510 | Delegate to be used in add-in engine events | ||
1511 | </summary> | ||
1512 | </member> | ||
1513 | <member name="T:Mono.Addins.AddinEventArgs"> | ||
1514 | <summary> | ||
1515 | Provides information about an add-in engine event. | ||
1516 | </summary> | ||
1517 | </member> | ||
1518 | <member name="M:Mono.Addins.AddinEventArgs.#ctor(System.String)"> | ||
1519 | <summary> | ||
1520 | Initializes a new instance of the <see cref="T:Mono.Addins.AddinEventArgs"/> class. | ||
1521 | </summary> | ||
1522 | <param name="addinId"> | ||
1523 | Add-in identifier. | ||
1524 | </param> | ||
1525 | </member> | ||
1526 | <member name="P:Mono.Addins.AddinEventArgs.AddinId"> | ||
1527 | <summary> | ||
1528 | Identifier of the add-in that generated the event. | ||
1529 | </summary> | ||
1530 | </member> | ||
1531 | <member name="T:Mono.Addins.NodeAttribute"> | ||
1532 | <summary> | ||
1533 | Attribute of a NodeElement. | ||
1534 | </summary> | ||
1535 | </member> | ||
1536 | <member name="P:Mono.Addins.NodeAttribute.Name"> | ||
1537 | <summary> | ||
1538 | Name of the attribute. | ||
1539 | </summary> | ||
1540 | </member> | ||
1541 | <member name="P:Mono.Addins.NodeAttribute.Value"> | ||
1542 | <summary> | ||
1543 | Value of the attribute. | ||
1544 | </summary> | ||
1545 | </member> | ||
1546 | <member name="T:Mono.Addins.Database.IAssemblyLocator"> | ||
1547 | <summary> | ||
1548 | Allows finding assemblies in the file system | ||
1549 | </summary> | ||
1550 | </member> | ||
1551 | <member name="M:Mono.Addins.Database.IAssemblyLocator.GetAssemblyLocation(System.String)"> | ||
1552 | <summary> | ||
1553 | Locates an assembly | ||
1554 | </summary> | ||
1555 | <returns> | ||
1556 | The full path to the assembly, or null if not found | ||
1557 | </returns> | ||
1558 | <param name='fullName'> | ||
1559 | Full name of the assembly | ||
1560 | </param> | ||
1561 | </member> | ||
1562 | <member name="T:Mono.Addins.Description.AddinProperty"> | ||
1563 | <summary> | ||
1564 | An add-in property. | ||
1565 | </summary> | ||
1566 | </member> | ||
1567 | <member name="P:Mono.Addins.Description.AddinProperty.Name"> | ||
1568 | <summary> | ||
1569 | Name of the property | ||
1570 | </summary> | ||
1571 | </member> | ||
1572 | <member name="P:Mono.Addins.Description.AddinProperty.Locale"> | ||
1573 | <summary> | ||
1574 | Locale of the property. It is null if the property is not localized. | ||
1575 | </summary> | ||
1576 | </member> | ||
1577 | <member name="P:Mono.Addins.Description.AddinProperty.Value"> | ||
1578 | <summary> | ||
1579 | Value of the property. | ||
1580 | </summary> | ||
1581 | </member> | ||
1582 | <member name="T:Mono.Addins.Localization.IAddinLocalizerFactory"> | ||
1583 | <summary> | ||
1584 | A localizer factory. | ||
1585 | </summary> | ||
1586 | </member> | ||
1587 | <member name="M:Mono.Addins.Localization.IAddinLocalizerFactory.CreateLocalizer(Mono.Addins.RuntimeAddin,Mono.Addins.NodeElement)"> | ||
1588 | <summary> | ||
1589 | Creates a localizer for an add-in. | ||
1590 | </summary> | ||
1591 | <returns> | ||
1592 | The localizer. | ||
1593 | </returns> | ||
1594 | <param name='addin'> | ||
1595 | The add-in for which to create the localizer. | ||
1596 | </param> | ||
1597 | <param name='element'> | ||
1598 | Localizer parameters. | ||
1599 | </param> | ||
1600 | </member> | ||
1601 | <member name="T:Mono.Addins.Description.Dependency"> | ||
1602 | <summary> | ||
1603 | Definition of an add-in dependency. | ||
1604 | </summary> | ||
1605 | </member> | ||
1606 | <member name="P:Mono.Addins.Description.Dependency.Name"> | ||
1607 | <summary> | ||
1608 | Gets the display name of the dependency. | ||
1609 | </summary> | ||
1610 | <value> | ||
1611 | The name. | ||
1612 | </value> | ||
1613 | </member> | ||
1614 | <member name="T:Mono.Addins.Description.ExtensionNodeSetCollection"> | ||
1615 | <summary> | ||
1616 | A collection of node sets. | ||
1617 | </summary> | ||
1618 | </member> | ||
1619 | <member name="M:Mono.Addins.Description.ExtensionNodeSetCollection.#ctor"> | ||
1620 | <summary> | ||
1621 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.ExtensionNodeSetCollection"/> class. | ||
1622 | </summary> | ||
1623 | </member> | ||
1624 | <member name="P:Mono.Addins.Description.ExtensionNodeSetCollection.Item(System.Int32)"> | ||
1625 | <summary> | ||
1626 | Gets the <see cref="T:Mono.Addins.Description.ExtensionNodeSet"/> at the specified index. | ||
1627 | </summary> | ||
1628 | <param name="n"> | ||
1629 | The index. | ||
1630 | </param> | ||
1631 | </member> | ||
1632 | <member name="P:Mono.Addins.Description.ExtensionNodeSetCollection.Item(System.String)"> | ||
1633 | <summary> | ||
1634 | Gets the <see cref="T:Mono.Addins.Description.ExtensionNodeSet"/> with the specified id. | ||
1635 | </summary> | ||
1636 | <param name="id"> | ||
1637 | Identifier. | ||
1638 | </param> | ||
1639 | </member> | ||
1640 | <member name="T:Mono.Addins.AddinEngine"> | ||
1641 | <summary> | ||
1642 | An add-in engine. | ||
1643 | </summary> | ||
1644 | <remarks> | ||
1645 | This class allows hosting several independent add-in engines in a single application domain. | ||
1646 | In general, applications use the AddinManager class to query and manage extensions. This class is static, | ||
1647 | so the API is easily accessible. However, some kind applications may need to use several isolated | ||
1648 | add-in engines, and in this case the AddinManager class can't be used, because it is bound to a single | ||
1649 | add-in engine. Those applications can instead create several instances of the AddinEngine class. Each | ||
1650 | add-in engine can be independently initialized with different add-in registries and extension models. | ||
1651 | </remarks> | ||
1652 | </member> | ||
1653 | <member name="T:Mono.Addins.ExtensionContext"> | ||
1654 | <summary> | ||
1655 | An extension context. | ||
1656 | </summary> | ||
1657 | <remarks> | ||
1658 | Extension contexts can be used to query the extension tree | ||
1659 | using particular condition values. Extension points which | ||
1660 | declare the availability of a condition type can only be | ||
1661 | queryed using an extension context which provides an | ||
1662 | evaluator for that condition. | ||
1663 | </remarks> | ||
1664 | </member> | ||
1665 | <member name="M:Mono.Addins.ExtensionContext.RegisterCondition(System.String,Mono.Addins.ConditionType)"> | ||
1666 | <summary> | ||
1667 | Registers a new condition in the extension context. | ||
1668 | </summary> | ||
1669 | <param name="id"> | ||
1670 | Identifier of the condition. | ||
1671 | </param> | ||
1672 | <param name="type"> | ||
1673 | Condition evaluator. | ||
1674 | </param> | ||
1675 | <remarks> | ||
1676 | The registered condition will be particular to this extension context. | ||
1677 | Any event that might be fired as a result of changes in the condition will | ||
1678 | only be fired in this context. | ||
1679 | </remarks> | ||
1680 | </member> | ||
1681 | <member name="M:Mono.Addins.ExtensionContext.RegisterCondition(System.String,System.Type)"> | ||
1682 | <summary> | ||
1683 | Registers a new condition in the extension context. | ||
1684 | </summary> | ||
1685 | <param name="id"> | ||
1686 | Identifier of the condition. | ||
1687 | </param> | ||
1688 | <param name="type"> | ||
1689 | Type of the condition evaluator. Must be a subclass of Mono.Addins.ConditionType. | ||
1690 | </param> | ||
1691 | <remarks> | ||
1692 | The registered condition will be particular to this extension context. Any event | ||
1693 | that might be fired as a result of changes in the condition will only be fired in this context. | ||
1694 | </remarks> | ||
1695 | </member> | ||
1696 | <member name="M:Mono.Addins.ExtensionContext.GetExtensionNode(System.String)"> | ||
1697 | <summary> | ||
1698 | Returns the extension node in a path | ||
1699 | </summary> | ||
1700 | <param name="path"> | ||
1701 | Location of the node. | ||
1702 | </param> | ||
1703 | <returns> | ||
1704 | The node, or null if not found. | ||
1705 | </returns> | ||
1706 | </member> | ||
1707 | <member name="M:Mono.Addins.ExtensionContext.GetExtensionNode``1(System.String)"> | ||
1708 | <summary> | ||
1709 | Returns the extension node in a path | ||
1710 | </summary> | ||
1711 | <param name="path"> | ||
1712 | Location of the node. | ||
1713 | </param> | ||
1714 | <returns> | ||
1715 | The node, or null if not found. | ||
1716 | </returns> | ||
1717 | </member> | ||
1718 | <member name="M:Mono.Addins.ExtensionContext.GetExtensionNodes(System.String)"> | ||
1719 | <summary> | ||
1720 | Gets extension nodes registered in a path. | ||
1721 | </summary> | ||
1722 | <param name="path"> | ||
1723 | An extension path.> | ||
1724 | </param> | ||
1725 | <returns> | ||
1726 | All nodes registered in the provided path. | ||
1727 | </returns> | ||
1728 | </member> | ||
1729 | <member name="M:Mono.Addins.ExtensionContext.GetExtensionNodes``1(System.String)"> | ||
1730 | <summary> | ||
1731 | Gets extension nodes registered in a path. | ||
1732 | </summary> | ||
1733 | <param name="path"> | ||
1734 | An extension path. | ||
1735 | </param> | ||
1736 | <returns> | ||
1737 | A list of nodes | ||
1738 | </returns> | ||
1739 | <remarks> | ||
1740 | This method returns all nodes registered under the provided path. | ||
1741 | It will throw a InvalidOperationException if the type of one of | ||
1742 | the registered nodes is not assignable to the provided type. | ||
1743 | </remarks> | ||
1744 | </member> | ||
1745 | <member name="M:Mono.Addins.ExtensionContext.GetExtensionNodes(System.Type)"> | ||
1746 | <summary> | ||
1747 | Gets extension nodes for a type extension point | ||
1748 | </summary> | ||
1749 | <param name="instanceType"> | ||
1750 | Type defining the extension point | ||
1751 | </param> | ||
1752 | <returns> | ||
1753 | A list of nodes | ||
1754 | </returns> | ||
1755 | <remarks> | ||
1756 | This method returns all extension nodes bound to the provided type. | ||
1757 | </remarks> | ||
1758 | </member> | ||
1759 | <member name="M:Mono.Addins.ExtensionContext.GetExtensionNodes(System.Type,System.Type)"> | ||
1760 | <summary> | ||
1761 | Gets extension nodes for a type extension point | ||
1762 | </summary> | ||
1763 | <param name="instanceType"> | ||
1764 | Type defining the extension point | ||
1765 | </param> | ||
1766 | <param name="expectedNodeType"> | ||
1767 | Expected extension node type | ||
1768 | </param> | ||
1769 | <returns> | ||
1770 | A list of nodes | ||
1771 | </returns> | ||
1772 | <remarks> | ||
1773 | This method returns all nodes registered for the provided type. | ||
1774 | It will throw a InvalidOperationException if the type of one of | ||
1775 | the registered nodes is not assignable to the provided node type. | ||
1776 | </remarks> | ||
1777 | </member> | ||
1778 | <member name="M:Mono.Addins.ExtensionContext.GetExtensionNodes``1(System.Type)"> | ||
1779 | <summary> | ||
1780 | Gets extension nodes for a type extension point | ||
1781 | </summary> | ||
1782 | <param name="instanceType"> | ||
1783 | Type defining the extension point | ||
1784 | </param> | ||
1785 | <returns> | ||
1786 | A list of nodes | ||
1787 | </returns> | ||
1788 | <remarks> | ||
1789 | This method returns all nodes registered for the provided type. | ||
1790 | It will throw a InvalidOperationException if the type of one of | ||
1791 | the registered nodes is not assignable to the specified node type argument. | ||
1792 | </remarks> | ||
1793 | </member> | ||
1794 | <member name="M:Mono.Addins.ExtensionContext.GetExtensionNodes(System.String,System.Type)"> | ||
1795 | <summary> | ||
1796 | Gets extension nodes registered in a path. | ||
1797 | </summary> | ||
1798 | <param name="path"> | ||
1799 | An extension path. | ||
1800 | </param> | ||
1801 | <param name="expectedNodeType"> | ||
1802 | Expected node type. | ||
1803 | </param> | ||
1804 | <returns> | ||
1805 | A list of nodes | ||
1806 | </returns> | ||
1807 | <remarks> | ||
1808 | This method returns all nodes registered under the provided path. | ||
1809 | It will throw a InvalidOperationException if the type of one of | ||
1810 | the registered nodes is not assignable to the provided type. | ||
1811 | </remarks> | ||
1812 | </member> | ||
1813 | <member name="M:Mono.Addins.ExtensionContext.GetExtensionObjects(System.Type)"> | ||
1814 | <summary> | ||
1815 | Gets extension objects registered for a type extension point. | ||
1816 | </summary> | ||
1817 | <param name="instanceType"> | ||
1818 | Type defining the extension point | ||
1819 | </param> | ||
1820 | <returns> | ||
1821 | A list of objects | ||
1822 | </returns> | ||
1823 | </member> | ||
1824 | <member name="M:Mono.Addins.ExtensionContext.GetExtensionObjects``1"> | ||
1825 | <summary> | ||
1826 | Gets extension objects registered for a type extension point. | ||
1827 | </summary> | ||
1828 | <returns> | ||
1829 | A list of objects | ||
1830 | </returns> | ||
1831 | <remarks> | ||
1832 | The type argument of this generic method is the type that defines | ||
1833 | the extension point. | ||
1834 | </remarks> | ||
1835 | </member> | ||
1836 | <member name="M:Mono.Addins.ExtensionContext.GetExtensionObjects(System.Type,System.Boolean)"> | ||
1837 | <summary> | ||
1838 | Gets extension objects registered for a type extension point. | ||
1839 | </summary> | ||
1840 | <param name="instanceType"> | ||
1841 | Type defining the extension point | ||
1842 | </param> | ||
1843 | <param name="reuseCachedInstance"> | ||
1844 | When set to True, it will return instances created in previous calls. | ||
1845 | </param> | ||
1846 | <returns> | ||
1847 | A list of extension objects. | ||
1848 | </returns> | ||
1849 | </member> | ||
1850 | <member name="M:Mono.Addins.ExtensionContext.GetExtensionObjects``1(System.Boolean)"> | ||
1851 | <summary> | ||
1852 | Gets extension objects registered for a type extension point. | ||
1853 | </summary> | ||
1854 | <param name="reuseCachedInstance"> | ||
1855 | When set to True, it will return instances created in previous calls. | ||
1856 | </param> | ||
1857 | <returns> | ||
1858 | A list of extension objects. | ||
1859 | </returns> | ||
1860 | <remarks> | ||
1861 | The type argument of this generic method is the type that defines | ||
1862 | the extension point. | ||
1863 | </remarks> | ||
1864 | </member> | ||
1865 | <member name="M:Mono.Addins.ExtensionContext.GetExtensionObjects(System.String)"> | ||
1866 | <summary> | ||
1867 | Gets extension objects registered in a path | ||
1868 | </summary> | ||
1869 | <param name="path"> | ||
1870 | An extension path. | ||
1871 | </param> | ||
1872 | <returns> | ||
1873 | An array of objects registered in the path. | ||
1874 | </returns> | ||
1875 | <remarks> | ||
1876 | This method can only be used if all nodes in the provided extension path | ||
1877 | are of type Mono.Addins.TypeExtensionNode. The returned array is composed | ||
1878 | by all objects created by calling the TypeExtensionNode.CreateInstance() | ||
1879 | method for each node. | ||
1880 | </remarks> | ||
1881 | </member> | ||
1882 | <member name="M:Mono.Addins.ExtensionContext.GetExtensionObjects(System.String,System.Boolean)"> | ||
1883 | <summary> | ||
1884 | Gets extension objects registered in a path. | ||
1885 | </summary> | ||
1886 | <param name="path"> | ||
1887 | An extension path. | ||
1888 | </param> | ||
1889 | <param name="reuseCachedInstance"> | ||
1890 | When set to True, it will return instances created in previous calls. | ||
1891 | </param> | ||
1892 | <returns> | ||
1893 | An array of objects registered in the path. | ||
1894 | </returns> | ||
1895 | <remarks> | ||
1896 | This method can only be used if all nodes in the provided extension path | ||
1897 | are of type Mono.Addins.TypeExtensionNode. The returned array is composed | ||
1898 | by all objects created by calling the TypeExtensionNode.CreateInstance() | ||
1899 | method for each node (or TypeExtensionNode.GetInstance() if | ||
1900 | reuseCachedInstance is set to true) | ||
1901 | </remarks> | ||
1902 | </member> | ||
1903 | <member name="M:Mono.Addins.ExtensionContext.GetExtensionObjects(System.String,System.Type)"> | ||
1904 | <summary> | ||
1905 | Gets extension objects registered in a path. | ||
1906 | </summary> | ||
1907 | <param name="path"> | ||
1908 | An extension path. | ||
1909 | </param> | ||
1910 | <param name="arrayElementType"> | ||
1911 | Type of the return array elements. | ||
1912 | </param> | ||
1913 | <returns> | ||
1914 | An array of objects registered in the path. | ||
1915 | </returns> | ||
1916 | <remarks> | ||
1917 | This method can only be used if all nodes in the provided extension path | ||
1918 | are of type Mono.Addins.TypeExtensionNode. The returned array is composed | ||
1919 | by all objects created by calling the TypeExtensionNode.CreateInstance() | ||
1920 | method for each node. | ||
1921 | |||
1922 | An InvalidOperationException exception is thrown if one of the found | ||
1923 | objects is not a subclass of the provided type. | ||
1924 | </remarks> | ||
1925 | </member> | ||
1926 | <member name="M:Mono.Addins.ExtensionContext.GetExtensionObjects``1(System.String)"> | ||
1927 | <summary> | ||
1928 | Gets extension objects registered in a path. | ||
1929 | </summary> | ||
1930 | <param name="path"> | ||
1931 | An extension path. | ||
1932 | </param> | ||
1933 | <returns> | ||
1934 | An array of objects registered in the path. | ||
1935 | </returns> | ||
1936 | <remarks> | ||
1937 | This method can only be used if all nodes in the provided extension path | ||
1938 | are of type Mono.Addins.TypeExtensionNode. The returned array is composed | ||
1939 | by all objects created by calling the TypeExtensionNode.CreateInstance() | ||
1940 | method for each node. | ||
1941 | |||
1942 | An InvalidOperationException exception is thrown if one of the found | ||
1943 | objects is not a subclass of the provided type. | ||
1944 | </remarks> | ||
1945 | </member> | ||
1946 | <member name="M:Mono.Addins.ExtensionContext.GetExtensionObjects``1(System.String,System.Boolean)"> | ||
1947 | <summary> | ||
1948 | Gets extension objects registered in a path. | ||
1949 | </summary> | ||
1950 | <param name="path"> | ||
1951 | An extension path. | ||
1952 | </param> | ||
1953 | <param name="reuseCachedInstance"> | ||
1954 | When set to True, it will return instances created in previous calls. | ||
1955 | </param> | ||
1956 | <returns> | ||
1957 | An array of objects registered in the path. | ||
1958 | </returns> | ||
1959 | <remarks> | ||
1960 | This method can only be used if all nodes in the provided extension path | ||
1961 | are of type Mono.Addins.TypeExtensionNode. The returned array is composed | ||
1962 | by all objects created by calling the TypeExtensionNode.CreateInstance() | ||
1963 | method for each node (or TypeExtensionNode.GetInstance() if | ||
1964 | reuseCachedInstance is set to true). | ||
1965 | |||
1966 | An InvalidOperationException exception is thrown if one of the found | ||
1967 | objects is not a subclass of the provided type. | ||
1968 | </remarks> | ||
1969 | </member> | ||
1970 | <member name="M:Mono.Addins.ExtensionContext.GetExtensionObjects(System.String,System.Type,System.Boolean)"> | ||
1971 | <summary> | ||
1972 | Gets extension objects registered in a path. | ||
1973 | </summary> | ||
1974 | <param name="path"> | ||
1975 | An extension path. | ||
1976 | </param> | ||
1977 | <param name="arrayElementType"> | ||
1978 | Type of the return array elements. | ||
1979 | </param> | ||
1980 | <param name="reuseCachedInstance"> | ||
1981 | When set to True, it will return instances created in previous calls. | ||
1982 | </param> | ||
1983 | <returns> | ||
1984 | An array of objects registered in the path. | ||
1985 | </returns> | ||
1986 | <remarks> | ||
1987 | This method can only be used if all nodes in the provided extension path | ||
1988 | are of type Mono.Addins.TypeExtensionNode. The returned array is composed | ||
1989 | by all objects created by calling the TypeExtensionNode.CreateInstance() | ||
1990 | method for each node (or TypeExtensionNode.GetInstance() if | ||
1991 | reuseCachedInstance is set to true). | ||
1992 | |||
1993 | An InvalidOperationException exception is thrown if one of the found | ||
1994 | objects is not a subclass of the provided type. | ||
1995 | </remarks> | ||
1996 | </member> | ||
1997 | <member name="M:Mono.Addins.ExtensionContext.AddExtensionNodeHandler(System.String,Mono.Addins.ExtensionNodeEventHandler)"> | ||
1998 | <summary> | ||
1999 | Register a listener of extension node changes. | ||
2000 | </summary> | ||
2001 | <param name="path"> | ||
2002 | Path of the node. | ||
2003 | </param> | ||
2004 | <param name="handler"> | ||
2005 | A handler method. | ||
2006 | </param> | ||
2007 | <remarks> | ||
2008 | Hosts can call this method to be subscribed to an extension change | ||
2009 | event for a specific path. The event will be fired once for every | ||
2010 | individual node change. The event arguments include the change type | ||
2011 | (Add or Remove) and the extension node added or removed. | ||
2012 | |||
2013 | NOTE: The handler will be called for all nodes existing in the path at the moment of registration. | ||
2014 | </remarks> | ||
2015 | </member> | ||
2016 | <member name="M:Mono.Addins.ExtensionContext.RemoveExtensionNodeHandler(System.String,Mono.Addins.ExtensionNodeEventHandler)"> | ||
2017 | <summary> | ||
2018 | Unregister a listener of extension node changes. | ||
2019 | </summary> | ||
2020 | <param name="path"> | ||
2021 | Path of the node. | ||
2022 | </param> | ||
2023 | <param name="handler"> | ||
2024 | A handler method. | ||
2025 | </param> | ||
2026 | <remarks> | ||
2027 | This method unregisters a delegate from the node change event of a path. | ||
2028 | </remarks> | ||
2029 | </member> | ||
2030 | <member name="M:Mono.Addins.ExtensionContext.AddExtensionNodeHandler(System.Type,Mono.Addins.ExtensionNodeEventHandler)"> | ||
2031 | <summary> | ||
2032 | Register a listener of extension node changes. | ||
2033 | </summary> | ||
2034 | <param name="instanceType"> | ||
2035 | Type defining the extension point | ||
2036 | </param> | ||
2037 | <param name="handler"> | ||
2038 | A handler method. | ||
2039 | </param> | ||
2040 | <remarks> | ||
2041 | Hosts can call this method to be subscribed to an extension change | ||
2042 | event for a specific type extension point. The event will be fired once for every | ||
2043 | individual node change. The event arguments include the change type | ||
2044 | (Add or Remove) and the extension node added or removed. | ||
2045 | |||
2046 | NOTE: The handler will be called for all nodes existing in the path at the moment of registration. | ||
2047 | </remarks> | ||
2048 | </member> | ||
2049 | <member name="M:Mono.Addins.ExtensionContext.RemoveExtensionNodeHandler(System.Type,Mono.Addins.ExtensionNodeEventHandler)"> | ||
2050 | <summary> | ||
2051 | Unregister a listener of extension node changes. | ||
2052 | </summary> | ||
2053 | <param name="instanceType"> | ||
2054 | Type defining the extension point | ||
2055 | </param> | ||
2056 | <param name="handler"> | ||
2057 | A handler method. | ||
2058 | </param> | ||
2059 | </member> | ||
2060 | <member name="E:Mono.Addins.ExtensionContext.ExtensionChanged"> | ||
2061 | <summary> | ||
2062 | Extension change event. | ||
2063 | </summary> | ||
2064 | <remarks> | ||
2065 | This event is fired when any extension point in the add-in system changes. | ||
2066 | The event args object provides the path of the changed extension, although | ||
2067 | it does not provide information about what changed. Hosts subscribing to | ||
2068 | this event should get the new list of nodes using a query method such as | ||
2069 | AddinManager.GetExtensionNodes() and then update whatever needs to be updated. | ||
2070 | </remarks> | ||
2071 | </member> | ||
2072 | <member name="M:Mono.Addins.AddinEngine.#ctor"> | ||
2073 | <summary> | ||
2074 | Initializes a new instance of the <see cref="T:Mono.Addins.AddinEngine"/> class. | ||
2075 | </summary> | ||
2076 | </member> | ||
2077 | <member name="M:Mono.Addins.AddinEngine.Initialize(System.String)"> | ||
2078 | <summary> | ||
2079 | Initializes the add-in engine | ||
2080 | </summary> | ||
2081 | <param name="configDir"> | ||
2082 | Location of the add-in registry. | ||
2083 | </param> | ||
2084 | <remarks>The add-in engine needs to be initialized before doing any add-in operation. | ||
2085 | When initialized with this method, it will look for add-in in the add-in registry | ||
2086 | located in the specified path. | ||
2087 | </remarks> | ||
2088 | </member> | ||
2089 | <member name="M:Mono.Addins.AddinEngine.Initialize(System.String,System.String)"> | ||
2090 | <summary> | ||
2091 | Initializes the add-in engine. | ||
2092 | </summary> | ||
2093 | <param name='configDir'> | ||
2094 | Location of the add-in registry. | ||
2095 | </param> | ||
2096 | <param name='addinsDir'> | ||
2097 | Add-ins directory. If the path is relative, it is considered to be relative | ||
2098 | to the configDir directory. | ||
2099 | </param> | ||
2100 | <remarks> | ||
2101 | The add-in engine needs to be initialized before doing any add-in operation. | ||
2102 | Configuration information about the add-in registry will be stored in the | ||
2103 | provided location. The add-in engine will look for add-ins in the provided | ||
2104 | 'addinsDir' directory. | ||
2105 | |||
2106 | When specifying a path, it is possible to use a special folder name as root. | ||
2107 | For example: [Personal]/.config/MyApp. In this case, [Personal] will be replaced | ||
2108 | by the location of the Environment.SpecialFolder.Personal folder. Any value | ||
2109 | of the Environment.SpecialFolder enumeration can be used (always between square | ||
2110 | brackets) | ||
2111 | </remarks> | ||
2112 | </member> | ||
2113 | <member name="M:Mono.Addins.AddinEngine.Initialize(System.String,System.String,System.String)"> | ||
2114 | <summary> | ||
2115 | Initializes the add-in engine. | ||
2116 | </summary> | ||
2117 | <param name='configDir'> | ||
2118 | Location of the add-in registry. | ||
2119 | </param> | ||
2120 | <param name='addinsDir'> | ||
2121 | Add-ins directory. If the path is relative, it is considered to be relative | ||
2122 | to the configDir directory. | ||
2123 | </param> | ||
2124 | <param name='databaseDir'> | ||
2125 | Location of the add-in database. If the path is relative, it is considered to be relative | ||
2126 | to the configDir directory. | ||
2127 | </param> | ||
2128 | <remarks> | ||
2129 | The add-in engine needs to be initialized before doing any add-in operation. | ||
2130 | Configuration information about the add-in registry will be stored in the | ||
2131 | provided location. The add-in engine will look for add-ins in the provided | ||
2132 | 'addinsDir' directory. Cached information about add-ins will be stored in | ||
2133 | the 'databaseDir' directory. | ||
2134 | |||
2135 | When specifying a path, it is possible to use a special folder name as root. | ||
2136 | For example: [Personal]/.config/MyApp. In this case, [Personal] will be replaced | ||
2137 | by the location of the Environment.SpecialFolder.Personal folder. Any value | ||
2138 | of the Environment.SpecialFolder enumeration can be used (always between square | ||
2139 | brackets) | ||
2140 | </remarks> | ||
2141 | </member> | ||
2142 | <member name="M:Mono.Addins.AddinEngine.Shutdown"> | ||
2143 | <summary> | ||
2144 | Finalizes the add-in engine. | ||
2145 | </summary> | ||
2146 | </member> | ||
2147 | <member name="M:Mono.Addins.AddinEngine.InitializeDefaultLocalizer(Mono.Addins.Localization.IAddinLocalizer)"> | ||
2148 | <summary> | ||
2149 | Sets the default localizer to be used for this add-in engine | ||
2150 | </summary> | ||
2151 | <param name="localizer"> | ||
2152 | The add-in localizer | ||
2153 | </param> | ||
2154 | </member> | ||
2155 | <member name="M:Mono.Addins.AddinEngine.CheckInstalled(System.String,System.String[])"> | ||
2156 | <summary> | ||
2157 | Checks if the provided add-ins are installed, and requests the installation of those | ||
2158 | which aren't. | ||
2159 | </summary> | ||
2160 | <param name="message"> | ||
2161 | Message to show to the user when new add-ins have to be installed. | ||
2162 | </param> | ||
2163 | <param name="addinIds"> | ||
2164 | List of IDs of the add-ins to be checked. | ||
2165 | </param> | ||
2166 | <remarks> | ||
2167 | This method checks if the specified add-ins are installed. | ||
2168 | If some of the add-ins are not installed, it will use | ||
2169 | the installer assigned to the DefaultAddinInstaller property | ||
2170 | to install them. If the installation fails, or if DefaultAddinInstaller | ||
2171 | is not set, an exception will be thrown. | ||
2172 | </remarks> | ||
2173 | </member> | ||
2174 | <member name="M:Mono.Addins.AddinEngine.IsAddinLoaded(System.String)"> | ||
2175 | <summary> | ||
2176 | Checks if an add-in has been loaded. | ||
2177 | </summary> | ||
2178 | <param name="id"> | ||
2179 | Full identifier of the add-in. | ||
2180 | </param> | ||
2181 | <returns> | ||
2182 | True if the add-in is loaded. | ||
2183 | </returns> | ||
2184 | </member> | ||
2185 | <member name="M:Mono.Addins.AddinEngine.LoadAddin(Mono.Addins.IProgressStatus,System.String)"> | ||
2186 | <summary> | ||
2187 | Forces the loading of an add-in. | ||
2188 | </summary> | ||
2189 | <param name="statusMonitor"> | ||
2190 | Status monitor to keep track of the loading process. | ||
2191 | </param> | ||
2192 | <param name="id"> | ||
2193 | Full identifier of the add-in to load. | ||
2194 | </param> | ||
2195 | <remarks> | ||
2196 | This method loads all assemblies that belong to an add-in in memory. | ||
2197 | All add-ins on which the specified add-in depends will also be loaded. | ||
2198 | Notice that in general add-ins don't need to be explicitely loaded using | ||
2199 | this method, since the add-in engine will load them on demand. | ||
2200 | </remarks> | ||
2201 | </member> | ||
2202 | <member name="M:Mono.Addins.AddinEngine.CreateExtensionContext"> | ||
2203 | <summary> | ||
2204 | Creates a new extension context. | ||
2205 | </summary> | ||
2206 | <returns> | ||
2207 | The new extension context. | ||
2208 | </returns> | ||
2209 | <remarks> | ||
2210 | Extension contexts can be used to query the extension model using particular condition values. | ||
2211 | </remarks> | ||
2212 | </member> | ||
2213 | <member name="E:Mono.Addins.AddinEngine.AddinLoadError"> | ||
2214 | <summary> | ||
2215 | Raised when there is an error while loading an add-in | ||
2216 | </summary> | ||
2217 | </member> | ||
2218 | <member name="E:Mono.Addins.AddinEngine.AddinLoaded"> | ||
2219 | <summary> | ||
2220 | Raised when an add-in is loaded | ||
2221 | </summary> | ||
2222 | </member> | ||
2223 | <member name="E:Mono.Addins.AddinEngine.AddinUnloaded"> | ||
2224 | <summary> | ||
2225 | Raised when an add-in is unloaded | ||
2226 | </summary> | ||
2227 | </member> | ||
2228 | <member name="P:Mono.Addins.AddinEngine.IsInitialized"> | ||
2229 | <summary> | ||
2230 | Gets whether the add-in engine has been initialized. | ||
2231 | </summary> | ||
2232 | </member> | ||
2233 | <member name="P:Mono.Addins.AddinEngine.DefaultInstaller"> | ||
2234 | <summary> | ||
2235 | Gets the default add-in installer | ||
2236 | </summary> | ||
2237 | <remarks> | ||
2238 | The default installer is used by the CheckInstalled method to request | ||
2239 | the installation of missing add-ins. | ||
2240 | </remarks> | ||
2241 | </member> | ||
2242 | <member name="P:Mono.Addins.AddinEngine.DefaultLocalizer"> | ||
2243 | <summary> | ||
2244 | Gets the default localizer for this add-in engine | ||
2245 | </summary> | ||
2246 | </member> | ||
2247 | <member name="P:Mono.Addins.AddinEngine.CurrentLocalizer"> | ||
2248 | <summary> | ||
2249 | Gets the localizer for the add-in that is invoking this property | ||
2250 | </summary> | ||
2251 | </member> | ||
2252 | <member name="P:Mono.Addins.AddinEngine.CurrentAddin"> | ||
2253 | <summary> | ||
2254 | Gets a reference to the RuntimeAddin object for the add-in that is invoking this property | ||
2255 | </summary> | ||
2256 | </member> | ||
2257 | <member name="P:Mono.Addins.AddinEngine.Registry"> | ||
2258 | <summary> | ||
2259 | Gets the add-in registry bound to this add-in engine | ||
2260 | </summary> | ||
2261 | </member> | ||
2262 | <member name="T:Mono.Addins.Database.IAssemblyReflector"> | ||
2263 | <summary> | ||
2264 | An assembly reflector | ||
2265 | </summary> | ||
2266 | <remarks> | ||
2267 | This interface can be implemented to provide a custom method for getting information about assemblies. | ||
2268 | </remarks> | ||
2269 | </member> | ||
2270 | <member name="M:Mono.Addins.Database.IAssemblyReflector.Initialize(Mono.Addins.Database.IAssemblyLocator)"> | ||
2271 | <summary> | ||
2272 | Called to initialize the assembly reflector | ||
2273 | </summary> | ||
2274 | <param name='locator'> | ||
2275 | IAssemblyLocator instance which can be used to locate referenced assemblies. | ||
2276 | </param> | ||
2277 | </member> | ||
2278 | <member name="M:Mono.Addins.Database.IAssemblyReflector.GetCustomAttributes(System.Object,System.Type,System.Boolean)"> | ||
2279 | <summary> | ||
2280 | Gets a list of custom attributes | ||
2281 | </summary> | ||
2282 | <returns> | ||
2283 | The custom attributes. | ||
2284 | </returns> | ||
2285 | <param name='obj'> | ||
2286 | An assembly, class or class member | ||
2287 | </param> | ||
2288 | <param name='type'> | ||
2289 | Type of the attribute to be returned. It will always be one of the attribute types | ||
2290 | defined in Mono.Addins. | ||
2291 | </param> | ||
2292 | <param name='inherit'> | ||
2293 | 'true' if inherited attributes must be returned | ||
2294 | </param> | ||
2295 | </member> | ||
2296 | <member name="M:Mono.Addins.Database.IAssemblyReflector.GetRawCustomAttributes(System.Object,System.Type,System.Boolean)"> | ||
2297 | <summary> | ||
2298 | Gets a list of custom attributes | ||
2299 | </summary> | ||
2300 | <returns> | ||
2301 | The attributes. | ||
2302 | </returns> | ||
2303 | <param name='obj'> | ||
2304 | An assembly, class or class member | ||
2305 | </param> | ||
2306 | <param name='type'> | ||
2307 | Base type of the attribute to be returned | ||
2308 | </param> | ||
2309 | <param name='inherit'> | ||
2310 | 'true' if inherited attributes must be returned | ||
2311 | </param> | ||
2312 | </member> | ||
2313 | <member name="M:Mono.Addins.Database.IAssemblyReflector.LoadAssembly(System.String)"> | ||
2314 | <summary> | ||
2315 | Loads an assembly. | ||
2316 | </summary> | ||
2317 | <returns> | ||
2318 | The loaded assembly | ||
2319 | </returns> | ||
2320 | <param name='file'> | ||
2321 | Path of the assembly. | ||
2322 | </param> | ||
2323 | </member> | ||
2324 | <member name="M:Mono.Addins.Database.IAssemblyReflector.LoadAssemblyFromReference(System.Object)"> | ||
2325 | <summary> | ||
2326 | Loads the assembly specified in an assembly reference | ||
2327 | </summary> | ||
2328 | <returns> | ||
2329 | The assembly | ||
2330 | </returns> | ||
2331 | <param name='asmReference'> | ||
2332 | An assembly reference | ||
2333 | </param> | ||
2334 | </member> | ||
2335 | <member name="M:Mono.Addins.Database.IAssemblyReflector.GetResourceNames(System.Object)"> | ||
2336 | <summary> | ||
2337 | Gets the names of all resources embedded in an assembly | ||
2338 | </summary> | ||
2339 | <returns> | ||
2340 | The names of the resources | ||
2341 | </returns> | ||
2342 | <param name='asm'> | ||
2343 | An assembly | ||
2344 | </param> | ||
2345 | </member> | ||
2346 | <member name="M:Mono.Addins.Database.IAssemblyReflector.GetResourceStream(System.Object,System.String)"> | ||
2347 | <summary> | ||
2348 | Gets the data stream of a resource | ||
2349 | </summary> | ||
2350 | <returns> | ||
2351 | The stream. | ||
2352 | </returns> | ||
2353 | <param name='asm'> | ||
2354 | An assembly | ||
2355 | </param> | ||
2356 | <param name='resourceName'> | ||
2357 | The name of a resource | ||
2358 | </param> | ||
2359 | </member> | ||
2360 | <member name="M:Mono.Addins.Database.IAssemblyReflector.GetAssemblyTypes(System.Object)"> | ||
2361 | <summary> | ||
2362 | Gets all types defined in an assembly | ||
2363 | </summary> | ||
2364 | <returns> | ||
2365 | The types | ||
2366 | </returns> | ||
2367 | <param name='asm'> | ||
2368 | An assembly | ||
2369 | </param> | ||
2370 | </member> | ||
2371 | <member name="M:Mono.Addins.Database.IAssemblyReflector.GetAssemblyReferences(System.Object)"> | ||
2372 | <summary> | ||
2373 | Gets all assembly references of an assembly | ||
2374 | </summary> | ||
2375 | <returns> | ||
2376 | A list of assembly references | ||
2377 | </returns> | ||
2378 | <param name='asm'> | ||
2379 | An assembly | ||
2380 | </param> | ||
2381 | </member> | ||
2382 | <member name="M:Mono.Addins.Database.IAssemblyReflector.GetType(System.Object,System.String)"> | ||
2383 | <summary> | ||
2384 | Looks for a type in an assembly | ||
2385 | </summary> | ||
2386 | <returns> | ||
2387 | The type. | ||
2388 | </returns> | ||
2389 | <param name='asm'> | ||
2390 | An assembly | ||
2391 | </param> | ||
2392 | <param name='typeName'> | ||
2393 | Name of the type | ||
2394 | </param> | ||
2395 | </member> | ||
2396 | <member name="M:Mono.Addins.Database.IAssemblyReflector.GetCustomAttribute(System.Object,System.Type,System.Boolean)"> | ||
2397 | <summary> | ||
2398 | Gets a custom attribute | ||
2399 | </summary> | ||
2400 | <returns> | ||
2401 | The custom attribute. | ||
2402 | </returns> | ||
2403 | <param name='obj'> | ||
2404 | An assembly, class or class member | ||
2405 | </param> | ||
2406 | <param name='type'> | ||
2407 | Base type of the attribute to be returned. It will always be one of the attribute types | ||
2408 | defined in Mono.Addins. | ||
2409 | </param> | ||
2410 | <param name='inherit'> | ||
2411 | 'true' if inherited attributes must be returned | ||
2412 | </param> | ||
2413 | </member> | ||
2414 | <member name="M:Mono.Addins.Database.IAssemblyReflector.GetTypeName(System.Object)"> | ||
2415 | <summary> | ||
2416 | Gets the name of a type (not including namespace) | ||
2417 | </summary> | ||
2418 | <returns> | ||
2419 | The type name. | ||
2420 | </returns> | ||
2421 | <param name='type'> | ||
2422 | A type | ||
2423 | </param> | ||
2424 | </member> | ||
2425 | <member name="M:Mono.Addins.Database.IAssemblyReflector.GetTypeFullName(System.Object)"> | ||
2426 | <summary> | ||
2427 | Gets the full name of a type (including namespace) | ||
2428 | </summary> | ||
2429 | <returns> | ||
2430 | The full name of the type | ||
2431 | </returns> | ||
2432 | <param name='type'> | ||
2433 | A type | ||
2434 | </param> | ||
2435 | </member> | ||
2436 | <member name="M:Mono.Addins.Database.IAssemblyReflector.GetTypeAssemblyQualifiedName(System.Object)"> | ||
2437 | <summary> | ||
2438 | Gets the assembly qualified name of a type | ||
2439 | </summary> | ||
2440 | <returns> | ||
2441 | The assembly qualified type name | ||
2442 | </returns> | ||
2443 | <param name='type'> | ||
2444 | A type | ||
2445 | </param> | ||
2446 | </member> | ||
2447 | <member name="M:Mono.Addins.Database.IAssemblyReflector.GetBaseTypeFullNameList(System.Object)"> | ||
2448 | <summary> | ||
2449 | Gets a list of all base types (including interfaces) of a type | ||
2450 | </summary> | ||
2451 | <returns> | ||
2452 | An enumeration of the full name of all base types of the type | ||
2453 | </returns> | ||
2454 | <param name='type'> | ||
2455 | A type | ||
2456 | </param> | ||
2457 | </member> | ||
2458 | <member name="M:Mono.Addins.Database.IAssemblyReflector.TypeIsAssignableFrom(System.Object,System.Object)"> | ||
2459 | <summary> | ||
2460 | Checks if a type is assignable to another type | ||
2461 | </summary> | ||
2462 | <returns> | ||
2463 | 'true' if the type is assignable | ||
2464 | </returns> | ||
2465 | <param name='baseType'> | ||
2466 | Expected base type. | ||
2467 | </param> | ||
2468 | <param name='type'> | ||
2469 | A type. | ||
2470 | </param> | ||
2471 | </member> | ||
2472 | <member name="M:Mono.Addins.Database.IAssemblyReflector.GetFields(System.Object)"> | ||
2473 | <summary> | ||
2474 | Gets the fields of a type | ||
2475 | </summary> | ||
2476 | <returns> | ||
2477 | The fields. | ||
2478 | </returns> | ||
2479 | <param name='type'> | ||
2480 | A type | ||
2481 | </param> | ||
2482 | </member> | ||
2483 | <member name="M:Mono.Addins.Database.IAssemblyReflector.GetFieldName(System.Object)"> | ||
2484 | <summary> | ||
2485 | Gets the name of a field. | ||
2486 | </summary> | ||
2487 | <returns> | ||
2488 | The field name. | ||
2489 | </returns> | ||
2490 | <param name='field'> | ||
2491 | A field. | ||
2492 | </param> | ||
2493 | </member> | ||
2494 | <member name="M:Mono.Addins.Database.IAssemblyReflector.GetFieldTypeFullName(System.Object)"> | ||
2495 | <summary> | ||
2496 | Gets the full name of the type of a field | ||
2497 | </summary> | ||
2498 | <returns> | ||
2499 | The full type name | ||
2500 | </returns> | ||
2501 | <param name='field'> | ||
2502 | A field. | ||
2503 | </param> | ||
2504 | </member> | ||
2505 | <member name="T:Mono.Addins.Database.CustomAttribute"> | ||
2506 | <summary> | ||
2507 | A custom attribute | ||
2508 | </summary> | ||
2509 | </member> | ||
2510 | <member name="P:Mono.Addins.Database.CustomAttribute.TypeName"> | ||
2511 | <summary> | ||
2512 | Full name of the type of the custom attribute | ||
2513 | </summary> | ||
2514 | </member> | ||
2515 | <member name="T:Mono.Addins.TypeExtensionPointAttribute"> | ||
2516 | <summary> | ||
2517 | Declares an extension point bound to a type | ||
2518 | </summary> | ||
2519 | </member> | ||
2520 | <member name="M:Mono.Addins.TypeExtensionPointAttribute.#ctor"> | ||
2521 | <summary> | ||
2522 | Initializes a new instance | ||
2523 | </summary> | ||
2524 | </member> | ||
2525 | <member name="M:Mono.Addins.TypeExtensionPointAttribute.#ctor(System.String)"> | ||
2526 | <summary> | ||
2527 | Initializes a new instance | ||
2528 | </summary> | ||
2529 | <param name="path"> | ||
2530 | Path that identifies the extension point | ||
2531 | </param> | ||
2532 | </member> | ||
2533 | <member name="P:Mono.Addins.TypeExtensionPointAttribute.Path"> | ||
2534 | <summary> | ||
2535 | Path that identifies the extension point | ||
2536 | </summary> | ||
2537 | </member> | ||
2538 | <member name="P:Mono.Addins.TypeExtensionPointAttribute.Description"> | ||
2539 | <summary> | ||
2540 | Description of the extension point. | ||
2541 | </summary> | ||
2542 | </member> | ||
2543 | <member name="P:Mono.Addins.TypeExtensionPointAttribute.NodeName"> | ||
2544 | <summary> | ||
2545 | Element name to be used when defining an extension in an XML manifest. The default name is "Type". | ||
2546 | </summary> | ||
2547 | </member> | ||
2548 | <member name="P:Mono.Addins.TypeExtensionPointAttribute.Name"> | ||
2549 | <summary> | ||
2550 | Display name of the extension point. | ||
2551 | </summary> | ||
2552 | </member> | ||
2553 | <member name="P:Mono.Addins.TypeExtensionPointAttribute.NodeType"> | ||
2554 | <summary> | ||
2555 | Type of the extension node to be created for extensions | ||
2556 | </summary> | ||
2557 | </member> | ||
2558 | <member name="P:Mono.Addins.TypeExtensionPointAttribute.ExtensionAttributeType"> | ||
2559 | <summary> | ||
2560 | Type of the custom attribute to be used to specify metadata for the extension point | ||
2561 | </summary> | ||
2562 | </member> | ||
2563 | <member name="T:Mono.Addins.Description.AddinFlags"> | ||
2564 | <summary> | ||
2565 | Add-in flags | ||
2566 | </summary> | ||
2567 | </member> | ||
2568 | <member name="F:Mono.Addins.Description.AddinFlags.None"> | ||
2569 | <summary> | ||
2570 | No flags | ||
2571 | </summary> | ||
2572 | </member> | ||
2573 | <member name="F:Mono.Addins.Description.AddinFlags.CantUninstall"> | ||
2574 | <summary> | ||
2575 | The add-in can't be uninstalled | ||
2576 | </summary> | ||
2577 | </member> | ||
2578 | <member name="F:Mono.Addins.Description.AddinFlags.CantDisable"> | ||
2579 | <summary> | ||
2580 | The add-in can't be disabled | ||
2581 | </summary> | ||
2582 | </member> | ||
2583 | <member name="F:Mono.Addins.Description.AddinFlags.Hidden"> | ||
2584 | <summary> | ||
2585 | The add-in is not visible to end users | ||
2586 | </summary> | ||
2587 | </member> | ||
2588 | <member name="T:Mono.Addins.Description.ExtensionCollection"> | ||
2589 | <summary> | ||
2590 | A collection of extensions | ||
2591 | </summary> | ||
2592 | </member> | ||
2593 | <member name="M:Mono.Addins.Description.ExtensionCollection.#ctor"> | ||
2594 | <summary> | ||
2595 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.ExtensionCollection"/> class. | ||
2596 | </summary> | ||
2597 | </member> | ||
2598 | <member name="P:Mono.Addins.Description.ExtensionCollection.Item(System.Int32)"> | ||
2599 | <summary> | ||
2600 | Gets the <see cref="T:Mono.Addins.Description.Extension"/> at the specified index. | ||
2601 | </summary> | ||
2602 | <param name="n"> | ||
2603 | The index. | ||
2604 | </param> | ||
2605 | </member> | ||
2606 | <member name="T:Mono.Addins.InstanceExtensionNode"> | ||
2607 | <summary> | ||
2608 | Base class for extension nodes which create extension objects | ||
2609 | </summary> | ||
2610 | </member> | ||
2611 | <member name="T:Mono.Addins.ExtensionNode"> | ||
2612 | <summary> | ||
2613 | A node of the extension model. | ||
2614 | </summary> | ||
2615 | <remarks> | ||
2616 | An extension node is an element registered by an add-in in an extension point. | ||
2617 | A host can get nodes registered in an extension point using methods such as | ||
2618 | AddinManager.GetExtensionNodes(string), which returns a collection of ExtensionNode objects. | ||
2619 | |||
2620 | ExtensionNode will normally be used as a base class of more complex extension point types. | ||
2621 | The most common subclass is Mono.Addins.TypeExtensionNode, which allows registering a class | ||
2622 | implemented in an add-in. | ||
2623 | </remarks> | ||
2624 | </member> | ||
2625 | <member name="M:Mono.Addins.ExtensionNode.GetChildObjects"> | ||
2626 | <summary> | ||
2627 | Returns the child objects of a node. | ||
2628 | </summary> | ||
2629 | <returns> | ||
2630 | An array of child objects. | ||
2631 | </returns> | ||
2632 | <remarks> | ||
2633 | This method only works if all children of this node are of type Mono.Addins.TypeExtensionNode. | ||
2634 | The returned array is composed by all objects created by calling the | ||
2635 | TypeExtensionNode.GetInstance() method for each node. | ||
2636 | </remarks> | ||
2637 | </member> | ||
2638 | <member name="M:Mono.Addins.ExtensionNode.GetChildObjects(System.Boolean)"> | ||
2639 | <summary> | ||
2640 | Returns the child objects of a node. | ||
2641 | </summary> | ||
2642 | <param name="reuseCachedInstance"> | ||
2643 | True if the method can reuse instances created in previous calls. | ||
2644 | </param> | ||
2645 | <returns> | ||
2646 | An array of child objects. | ||
2647 | </returns> | ||
2648 | <remarks> | ||
2649 | This method only works if all children of this node are of type Mono.Addins.TypeExtensionNode. | ||
2650 | The returned array is composed by all objects created by calling the TypeExtensionNode.CreateInstance() | ||
2651 | method for each node (or TypeExtensionNode.GetInstance() if reuseCachedInstance is set to true). | ||
2652 | </remarks> | ||
2653 | </member> | ||
2654 | <member name="M:Mono.Addins.ExtensionNode.GetChildObjects(System.Type)"> | ||
2655 | <summary> | ||
2656 | Returns the child objects of a node (with type check). | ||
2657 | </summary> | ||
2658 | <param name="arrayElementType"> | ||
2659 | Type of the return array elements. | ||
2660 | </param> | ||
2661 | <returns> | ||
2662 | An array of child objects. | ||
2663 | </returns> | ||
2664 | <remarks> | ||
2665 | This method only works if all children of this node are of type Mono.Addins.TypeExtensionNode. | ||
2666 | The returned array is composed by all objects created by calling the | ||
2667 | TypeExtensionNode.GetInstance(Type) method for each node. | ||
2668 | |||
2669 | An InvalidOperationException exception is thrown if one of the found child objects is not a | ||
2670 | subclass of the provided type. | ||
2671 | </remarks> | ||
2672 | </member> | ||
2673 | <member name="M:Mono.Addins.ExtensionNode.GetChildObjects``1"> | ||
2674 | <summary> | ||
2675 | Returns the child objects of a node (casting to the specified type) | ||
2676 | </summary> | ||
2677 | <returns> | ||
2678 | An array of child objects. | ||
2679 | </returns> | ||
2680 | <remarks> | ||
2681 | This method only works if all children of this node are of type Mono.Addins.TypeExtensionNode. | ||
2682 | The returned array is composed by all objects created by calling the | ||
2683 | TypeExtensionNode.GetInstance() method for each node. | ||
2684 | </remarks> | ||
2685 | </member> | ||
2686 | <member name="M:Mono.Addins.ExtensionNode.GetChildObjects(System.Type,System.Boolean)"> | ||
2687 | <summary> | ||
2688 | Returns the child objects of a node (with type check). | ||
2689 | </summary> | ||
2690 | <param name="arrayElementType"> | ||
2691 | Type of the return array elements. | ||
2692 | </param> | ||
2693 | <param name="reuseCachedInstance"> | ||
2694 | True if the method can reuse instances created in previous calls. | ||
2695 | </param> | ||
2696 | <returns> | ||
2697 | An array of child objects. | ||
2698 | </returns> | ||
2699 | <remarks> | ||
2700 | This method only works if all children of this node are of type Mono.Addins.TypeExtensionNode. | ||
2701 | The returned array is composed by all objects created by calling the TypeExtensionNode.CreateInstance(Type) | ||
2702 | method for each node (or TypeExtensionNode.GetInstance(Type) if reuseCachedInstance is set to true). | ||
2703 | |||
2704 | An InvalidOperationException exception will be thrown if one of the found child objects is not a subclass | ||
2705 | of the provided type. | ||
2706 | </remarks> | ||
2707 | </member> | ||
2708 | <member name="M:Mono.Addins.ExtensionNode.GetChildObjects``1(System.Boolean)"> | ||
2709 | <summary> | ||
2710 | Returns the child objects of a node (casting to the specified type). | ||
2711 | </summary> | ||
2712 | <param name="reuseCachedInstance"> | ||
2713 | True if the method can reuse instances created in previous calls. | ||
2714 | </param> | ||
2715 | <returns> | ||
2716 | An array of child objects. | ||
2717 | </returns> | ||
2718 | <remarks> | ||
2719 | This method only works if all children of this node are of type Mono.Addins.TypeExtensionNode. | ||
2720 | The returned array is composed by all objects created by calling the TypeExtensionNode.CreateInstance() | ||
2721 | method for each node (or TypeExtensionNode.GetInstance() if reuseCachedInstance is set to true). | ||
2722 | </remarks> | ||
2723 | </member> | ||
2724 | <member name="M:Mono.Addins.ExtensionNode.Read(Mono.Addins.NodeElement)"> | ||
2725 | <summary> | ||
2726 | Reads the extension node data | ||
2727 | </summary> | ||
2728 | <param name='elem'> | ||
2729 | The element containing the extension data | ||
2730 | </param> | ||
2731 | <remarks> | ||
2732 | This method can be overriden to provide a custom method for reading extension node data from an element. | ||
2733 | The default implementation reads the attributes if the element and assigns the values to the fields | ||
2734 | and properties of the extension node that have the corresponding [NodeAttribute] decoration. | ||
2735 | </remarks> | ||
2736 | </member> | ||
2737 | <member name="M:Mono.Addins.ExtensionNode.OnAddinLoaded"> | ||
2738 | <summary> | ||
2739 | Called when the add-in that defined this extension node is actually loaded in memory. | ||
2740 | </summary> | ||
2741 | </member> | ||
2742 | <member name="M:Mono.Addins.ExtensionNode.OnAddinUnloaded"> | ||
2743 | <summary> | ||
2744 | Called when the add-in that defined this extension node is being | ||
2745 | unloaded from memory. | ||
2746 | </summary> | ||
2747 | </member> | ||
2748 | <member name="M:Mono.Addins.ExtensionNode.OnChildrenChanged"> | ||
2749 | <summary> | ||
2750 | Called when the children list of this node has changed. It may be due to add-ins | ||
2751 | being loaded/unloaded, or to conditions being changed. | ||
2752 | </summary> | ||
2753 | </member> | ||
2754 | <member name="M:Mono.Addins.ExtensionNode.OnChildNodeAdded(Mono.Addins.ExtensionNode)"> | ||
2755 | <summary> | ||
2756 | Called when a child node is added | ||
2757 | </summary> | ||
2758 | <param name="node"> | ||
2759 | Added node. | ||
2760 | </param> | ||
2761 | </member> | ||
2762 | <member name="M:Mono.Addins.ExtensionNode.OnChildNodeRemoved(Mono.Addins.ExtensionNode)"> | ||
2763 | <summary> | ||
2764 | Called when a child node is removed | ||
2765 | </summary> | ||
2766 | <param name="node"> | ||
2767 | Removed node. | ||
2768 | </param> | ||
2769 | </member> | ||
2770 | <member name="P:Mono.Addins.ExtensionNode.Id"> | ||
2771 | <summary> | ||
2772 | Identifier of the node. | ||
2773 | </summary> | ||
2774 | <remarks> | ||
2775 | It is not mandatory to specify an 'id' for a node. When none is provided, | ||
2776 | the add-in manager will automatically generate an unique id for the node. | ||
2777 | The ExtensionNode.HasId property can be used to know if the 'id' has been | ||
2778 | specified by the developer or not. | ||
2779 | </remarks> | ||
2780 | </member> | ||
2781 | <member name="P:Mono.Addins.ExtensionNode.Path"> | ||
2782 | <summary> | ||
2783 | Location of this node in the extension tree. | ||
2784 | </summary> | ||
2785 | <remarks> | ||
2786 | The node path is composed by the path of the extension point where it is defined, | ||
2787 | the identifiers of its parent nodes, and its own identifier. | ||
2788 | </remarks> | ||
2789 | </member> | ||
2790 | <member name="P:Mono.Addins.ExtensionNode.Parent"> | ||
2791 | <summary> | ||
2792 | Parent node of this node. | ||
2793 | </summary> | ||
2794 | </member> | ||
2795 | <member name="P:Mono.Addins.ExtensionNode.ExtensionContext"> | ||
2796 | <summary> | ||
2797 | Extension context to which this node belongs | ||
2798 | </summary> | ||
2799 | </member> | ||
2800 | <member name="P:Mono.Addins.ExtensionNode.HasId"> | ||
2801 | <summary> | ||
2802 | Specifies whether the extension node has as an Id or not. | ||
2803 | </summary> | ||
2804 | <remarks> | ||
2805 | It is not mandatory to specify an 'id' for a node. When none is provided, | ||
2806 | the add-in manager will automatically generate an unique id for the node. | ||
2807 | This property will return true if an 'id' was provided for the node, and | ||
2808 | false if the id was assigned by the add-in manager. | ||
2809 | </remarks> | ||
2810 | </member> | ||
2811 | <member name="P:Mono.Addins.ExtensionNode.Addin"> | ||
2812 | <summary> | ||
2813 | The add-in that registered this extension node. | ||
2814 | </summary> | ||
2815 | <remarks> | ||
2816 | This property provides access to the resources and types of the add-in that created this extension node. | ||
2817 | </remarks> | ||
2818 | </member> | ||
2819 | <member name="E:Mono.Addins.ExtensionNode.ExtensionNodeChanged"> | ||
2820 | <summary> | ||
2821 | Notifies that a child node of this node has been added or removed. | ||
2822 | </summary> | ||
2823 | <remarks> | ||
2824 | The first time the event is subscribed, the handler will be called for each existing node. | ||
2825 | </remarks> | ||
2826 | </member> | ||
2827 | <member name="P:Mono.Addins.ExtensionNode.ChildNodes"> | ||
2828 | <summary> | ||
2829 | Child nodes of this extension node. | ||
2830 | </summary> | ||
2831 | </member> | ||
2832 | <member name="M:Mono.Addins.InstanceExtensionNode.GetInstance(System.Type)"> | ||
2833 | <summary> | ||
2834 | Gets the extension object declared by this node | ||
2835 | </summary> | ||
2836 | <param name="expectedType"> | ||
2837 | Expected object type. An exception will be thrown if the object is not an instance of the specified type. | ||
2838 | </param> | ||
2839 | <returns> | ||
2840 | The extension object | ||
2841 | </returns> | ||
2842 | <remarks> | ||
2843 | The extension object is cached and the same instance will be returned at every call. | ||
2844 | </remarks> | ||
2845 | </member> | ||
2846 | <member name="M:Mono.Addins.InstanceExtensionNode.GetInstance"> | ||
2847 | <summary> | ||
2848 | Gets the extension object declared by this node | ||
2849 | </summary> | ||
2850 | <returns> | ||
2851 | The extension object | ||
2852 | </returns> | ||
2853 | <remarks> | ||
2854 | The extension object is cached and the same instance will be returned at every call. | ||
2855 | </remarks> | ||
2856 | </member> | ||
2857 | <member name="M:Mono.Addins.InstanceExtensionNode.CreateInstance(System.Type)"> | ||
2858 | <summary> | ||
2859 | Creates a new extension object | ||
2860 | </summary> | ||
2861 | <param name="expectedType"> | ||
2862 | Expected object type. An exception will be thrown if the object is not an instance of the specified type. | ||
2863 | </param> | ||
2864 | <returns> | ||
2865 | The extension object | ||
2866 | </returns> | ||
2867 | </member> | ||
2868 | <member name="M:Mono.Addins.InstanceExtensionNode.CreateInstance"> | ||
2869 | <summary> | ||
2870 | Creates a new extension object | ||
2871 | </summary> | ||
2872 | <returns> | ||
2873 | The extension object | ||
2874 | </returns> | ||
2875 | </member> | ||
2876 | <member name="T:Mono.Addins.AddinDependencyAttribute"> | ||
2877 | <summary> | ||
2878 | Declares a dependency on an add-in or add-in host | ||
2879 | </summary> | ||
2880 | </member> | ||
2881 | <member name="M:Mono.Addins.AddinDependencyAttribute.#ctor(System.String,System.String)"> | ||
2882 | <summary> | ||
2883 | Initializes the attribute | ||
2884 | </summary> | ||
2885 | <param name="id"> | ||
2886 | Identifier of the add-in | ||
2887 | </param> | ||
2888 | <param name="version"> | ||
2889 | Version of the add-in | ||
2890 | </param> | ||
2891 | </member> | ||
2892 | <member name="P:Mono.Addins.AddinDependencyAttribute.Id"> | ||
2893 | <summary> | ||
2894 | Identifier of the add-in | ||
2895 | </summary> | ||
2896 | </member> | ||
2897 | <member name="P:Mono.Addins.AddinDependencyAttribute.Version"> | ||
2898 | <summary> | ||
2899 | Version of the add-in | ||
2900 | </summary> | ||
2901 | </member> | ||
2902 | <member name="T:Mono.Addins.ExtensionNode`1"> | ||
2903 | <summary> | ||
2904 | An extension node with custom metadata | ||
2905 | </summary> | ||
2906 | <remarks> | ||
2907 | This is the default type for extension nodes bound to a custom extension attribute. | ||
2908 | </remarks> | ||
2909 | </member> | ||
2910 | <member name="T:Mono.Addins.IAttributedExtensionNode"> | ||
2911 | <summary> | ||
2912 | An extension node with custom metadata provided by an attribute | ||
2913 | </summary> | ||
2914 | <remarks> | ||
2915 | This interface is implemented by ExtensionNode<T> to provide non-generic access to the attribute instance. | ||
2916 | </remarks> | ||
2917 | </member> | ||
2918 | <member name="P:Mono.Addins.IAttributedExtensionNode.Attribute"> | ||
2919 | <summary> | ||
2920 | The custom attribute containing the extension metadata | ||
2921 | </summary> | ||
2922 | </member> | ||
2923 | <member name="P:Mono.Addins.ExtensionNode`1.Data"> | ||
2924 | <summary> | ||
2925 | The custom attribute containing the extension metadata | ||
2926 | </summary> | ||
2927 | </member> | ||
2928 | <member name="T:Mono.Addins.AddinPropertyAttribute"> | ||
2929 | <summary> | ||
2930 | Defines an add-in property | ||
2931 | </summary> | ||
2932 | </member> | ||
2933 | <member name="M:Mono.Addins.AddinPropertyAttribute.#ctor(System.String,System.String)"> | ||
2934 | <summary> | ||
2935 | Initializes a new instance of the <see cref="T:Mono.Addins.AddinPropertyAttribute"/> class. | ||
2936 | </summary> | ||
2937 | <param name="name"> | ||
2938 | Name of the property | ||
2939 | </param> | ||
2940 | <param name="value"> | ||
2941 | Value of the property | ||
2942 | </param> | ||
2943 | </member> | ||
2944 | <member name="M:Mono.Addins.AddinPropertyAttribute.#ctor(System.String,System.String,System.String)"> | ||
2945 | <summary> | ||
2946 | Initializes a new instance of the <see cref="T:Mono.Addins.AddinPropertyAttribute"/> class. | ||
2947 | </summary> | ||
2948 | <param name="name"> | ||
2949 | Name of the property | ||
2950 | </param> | ||
2951 | <param name="locale"> | ||
2952 | Locale of the property. It can be null if the property is not bound to a locale. | ||
2953 | </param> | ||
2954 | <param name="value"> | ||
2955 | Value of the property | ||
2956 | </param> | ||
2957 | </member> | ||
2958 | <member name="P:Mono.Addins.AddinPropertyAttribute.Name"> | ||
2959 | <summary> | ||
2960 | Name of the property | ||
2961 | </summary> | ||
2962 | </member> | ||
2963 | <member name="P:Mono.Addins.AddinPropertyAttribute.Locale"> | ||
2964 | <summary> | ||
2965 | Locale of the property. It can be null if the property is not bound to a locale. | ||
2966 | </summary> | ||
2967 | </member> | ||
2968 | <member name="P:Mono.Addins.AddinPropertyAttribute.Value"> | ||
2969 | <summary> | ||
2970 | Value of the property | ||
2971 | </summary> | ||
2972 | </member> | ||
2973 | <member name="T:Mono.Addins.CustomExtensionAttribute"> | ||
2974 | <summary> | ||
2975 | Base class for custon extension attributes. | ||
2976 | </summary> | ||
2977 | <remarks> | ||
2978 | Custom extension attributes can be used to declare extensions with custom metadata. | ||
2979 | All custom extension attributes must subclass CustomExtensionAttribute. | ||
2980 | </remarks> | ||
2981 | </member> | ||
2982 | <member name="P:Mono.Addins.CustomExtensionAttribute.Id"> | ||
2983 | <summary> | ||
2984 | Identifier of the node | ||
2985 | </summary> | ||
2986 | </member> | ||
2987 | <member name="P:Mono.Addins.CustomExtensionAttribute.InsertBefore"> | ||
2988 | <summary> | ||
2989 | Identifier of the node before which this node has to be placed | ||
2990 | </summary> | ||
2991 | </member> | ||
2992 | <member name="P:Mono.Addins.CustomExtensionAttribute.InsertAfter"> | ||
2993 | <summary> | ||
2994 | Identifier of the node after which this node has to be placed | ||
2995 | </summary> | ||
2996 | </member> | ||
2997 | <member name="P:Mono.Addins.CustomExtensionAttribute.Path"> | ||
2998 | <summary> | ||
2999 | Path of the extension point being extended. | ||
3000 | </summary> | ||
3001 | <remarks> | ||
3002 | This property is optional and useful only when there are several extension points which allow | ||
3003 | using this custom attribute to define extensions. | ||
3004 | </remarks> | ||
3005 | </member> | ||
3006 | <member name="P:Mono.Addins.CustomExtensionAttribute.ExtensionNode"> | ||
3007 | <summary> | ||
3008 | The extension node bound to this attribute | ||
3009 | </summary> | ||
3010 | </member> | ||
3011 | <member name="P:Mono.Addins.CustomExtensionAttribute.Addin"> | ||
3012 | <summary> | ||
3013 | The add-in that registered this extension node. | ||
3014 | </summary> | ||
3015 | <remarks> | ||
3016 | This property provides access to the resources and types of the add-in that created this extension node. | ||
3017 | </remarks> | ||
3018 | </member> | ||
3019 | <member name="T:Mono.Addins.Localization.IPluralAddinLocalizer"> | ||
3020 | <summary> | ||
3021 | A localizer that supports localization of plural forms. | ||
3022 | </summary> | ||
3023 | <remarks> | ||
3024 | This interface can be implemented by add-in localizers which want to provide | ||
3025 | support plural forms. | ||
3026 | </remarks> | ||
3027 | </member> | ||
3028 | <member name="M:Mono.Addins.Localization.IPluralAddinLocalizer.GetPluralString(System.String,System.String,System.Int32)"> | ||
3029 | <summary> | ||
3030 | Gets a localized message which may contain plural forms. | ||
3031 | </summary> | ||
3032 | <returns> | ||
3033 | The localized message. | ||
3034 | </returns> | ||
3035 | <param name='singular'> | ||
3036 | Message identifier to use when the specified count is 1. | ||
3037 | </param> | ||
3038 | <param name='defaultPlural'> | ||
3039 | Default message identifier to use when the specified count is not 1. | ||
3040 | </param> | ||
3041 | <param name='n'> | ||
3042 | The count that determines which plural form to use. | ||
3043 | </param> | ||
3044 | </member> | ||
3045 | <member name="T:Mono.Addins.AddinLocalizer"> | ||
3046 | <summary> | ||
3047 | Converts message identifiers to localized messages. | ||
3048 | </summary> | ||
3049 | </member> | ||
3050 | <member name="M:Mono.Addins.AddinLocalizer.GetString(System.String)"> | ||
3051 | <summary> | ||
3052 | Gets a localized message | ||
3053 | </summary> | ||
3054 | <param name="msgid"> | ||
3055 | Message identifier | ||
3056 | </param> | ||
3057 | <returns> | ||
3058 | The localized message | ||
3059 | </returns> | ||
3060 | </member> | ||
3061 | <member name="M:Mono.Addins.AddinLocalizer.GetString(System.String,System.String[])"> | ||
3062 | <summary> | ||
3063 | Gets a formatted and localized message | ||
3064 | </summary> | ||
3065 | <param name="msgid"> | ||
3066 | Message identifier (can contain string format placeholders) | ||
3067 | </param> | ||
3068 | <param name="args"> | ||
3069 | Arguments for the string format operation | ||
3070 | </param> | ||
3071 | <returns> | ||
3072 | The formatted and localized string | ||
3073 | </returns> | ||
3074 | </member> | ||
3075 | <member name="M:Mono.Addins.AddinLocalizer.GetString(System.String,System.Object[])"> | ||
3076 | <summary> | ||
3077 | Gets a formatted and localized message | ||
3078 | </summary> | ||
3079 | <param name="msgid"> | ||
3080 | Message identifier (can contain string format placeholders) | ||
3081 | </param> | ||
3082 | <param name="args"> | ||
3083 | Arguments for the string format operation | ||
3084 | </param> | ||
3085 | <returns> | ||
3086 | The formatted and localized string | ||
3087 | </returns> | ||
3088 | </member> | ||
3089 | <member name="M:Mono.Addins.AddinLocalizer.GetPluralString(System.String,System.String,System.Int32)"> | ||
3090 | <summary> | ||
3091 | Gets a localized plural form for a message identifier | ||
3092 | </summary> | ||
3093 | <param name="msgid"> | ||
3094 | Message identifier for the singular form | ||
3095 | </param> | ||
3096 | <param name="defaultPlural"> | ||
3097 | Default result message for the plural form | ||
3098 | </param> | ||
3099 | <param name="n"> | ||
3100 | Value count. Determines wether to use singular or plural form. | ||
3101 | </param> | ||
3102 | <returns> | ||
3103 | The localized message | ||
3104 | </returns> | ||
3105 | </member> | ||
3106 | <member name="M:Mono.Addins.AddinLocalizer.GetPluralString(System.String,System.String,System.Int32,System.String[])"> | ||
3107 | <summary> | ||
3108 | Gets a localized and formatted plural form for a message identifier | ||
3109 | </summary> | ||
3110 | <param name="singular"> | ||
3111 | Message identifier for the singular form (can contain string format placeholders) | ||
3112 | </param> | ||
3113 | <param name="defaultPlural"> | ||
3114 | Default result message for the plural form (can contain string format placeholders) | ||
3115 | </param> | ||
3116 | <param name="n"> | ||
3117 | Value count. Determines whether to use singular or plural form. | ||
3118 | </param> | ||
3119 | <param name="args"> | ||
3120 | Arguments for the string format operation | ||
3121 | </param> | ||
3122 | <returns> | ||
3123 | The localized message | ||
3124 | </returns> | ||
3125 | </member> | ||
3126 | <member name="M:Mono.Addins.AddinLocalizer.GetPluralString(System.String,System.String,System.Int32,System.Object[])"> | ||
3127 | <summary> | ||
3128 | Gets a localized and formatted plural form for a message identifier | ||
3129 | </summary> | ||
3130 | <param name="singular"> | ||
3131 | Message identifier for the singular form (can contain string format placeholders) | ||
3132 | </param> | ||
3133 | <param name="defaultPlural"> | ||
3134 | Default result message for the plural form (can contain string format placeholders) | ||
3135 | </param> | ||
3136 | <param name="n"> | ||
3137 | Value count. Determines whether to use singular or plural form. | ||
3138 | </param> | ||
3139 | <param name="args"> | ||
3140 | Arguments for the string format operation | ||
3141 | </param> | ||
3142 | <returns> | ||
3143 | The localized message | ||
3144 | </returns> | ||
3145 | </member> | ||
3146 | <member name="T:Mono.Addins.Description.ExtensionPointCollection"> | ||
3147 | <summary> | ||
3148 | A collection of extension point definitions. | ||
3149 | </summary> | ||
3150 | </member> | ||
3151 | <member name="M:Mono.Addins.Description.ExtensionPointCollection.#ctor"> | ||
3152 | <summary> | ||
3153 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.ExtensionPointCollection"/> class. | ||
3154 | </summary> | ||
3155 | </member> | ||
3156 | <member name="P:Mono.Addins.Description.ExtensionPointCollection.Item(System.Int32)"> | ||
3157 | <summary> | ||
3158 | Gets the <see cref="T:Mono.Addins.Description.ExtensionPoint"/> at the specified index. | ||
3159 | </summary> | ||
3160 | <param name="n"> | ||
3161 | The index. | ||
3162 | </param> | ||
3163 | </member> | ||
3164 | <member name="P:Mono.Addins.Description.ExtensionPointCollection.Item(System.String)"> | ||
3165 | <summary> | ||
3166 | Gets the <see cref="T:Mono.Addins.Description.ExtensionPoint"/> with the specified path. | ||
3167 | </summary> | ||
3168 | <param name="path"> | ||
3169 | Path. | ||
3170 | </param> | ||
3171 | </member> | ||
3172 | <member name="T:Mono.Addins.AddinLocalizerGettextAttribute"> | ||
3173 | <summary> | ||
3174 | Declares a Gettext-based localizer for an add-in | ||
3175 | </summary> | ||
3176 | </member> | ||
3177 | <member name="M:Mono.Addins.AddinLocalizerGettextAttribute.#ctor"> | ||
3178 | <summary> | ||
3179 | Initializes a new instance of the <see cref="T:Mono.Addins.AddinLocalizerGettextAttribute"/> class. | ||
3180 | </summary> | ||
3181 | </member> | ||
3182 | <member name="M:Mono.Addins.AddinLocalizerGettextAttribute.#ctor(System.String)"> | ||
3183 | <summary> | ||
3184 | Initializes a new instance of the <see cref="T:Mono.Addins.AddinLocalizerGettextAttribute"/> class. | ||
3185 | </summary> | ||
3186 | <param name="catalog"> | ||
3187 | Name of the catalog which contains the strings. | ||
3188 | </param> | ||
3189 | </member> | ||
3190 | <member name="M:Mono.Addins.AddinLocalizerGettextAttribute.#ctor(System.String,System.String)"> | ||
3191 | <summary> | ||
3192 | Initializes a new instance of the <see cref="T:Mono.Addins.AddinLocalizerGettextAttribute"/> class. | ||
3193 | </summary> | ||
3194 | <param name="catalog"> | ||
3195 | Name of the catalog which contains the strings. | ||
3196 | </param> | ||
3197 | <param name="location"> | ||
3198 | Relative path to the location of the catalog. This path must be relative to the add-in location. | ||
3199 | </param> | ||
3200 | <remarks> | ||
3201 | The location path must contain a directory structure like this: | ||
3202 | |||
3203 | {language-id}/LC_MESSAGES/{Catalog}.mo | ||
3204 | |||
3205 | For example, the catalog for spanish strings would be located at: | ||
3206 | |||
3207 | locale/es/LC_MESSAGES/some-addin.mo | ||
3208 | </remarks> | ||
3209 | </member> | ||
3210 | <member name="P:Mono.Addins.AddinLocalizerGettextAttribute.Catalog"> | ||
3211 | <summary> | ||
3212 | Name of the catalog which contains the strings. | ||
3213 | </summary> | ||
3214 | </member> | ||
3215 | <member name="P:Mono.Addins.AddinLocalizerGettextAttribute.Location"> | ||
3216 | <summary> | ||
3217 | Relative path to the location of the catalog. This path must be relative to the add-in location. | ||
3218 | </summary> | ||
3219 | <remarks> | ||
3220 | When not specified, the default value of this property is 'locale'. | ||
3221 | The location path must contain a directory structure like this: | ||
3222 | |||
3223 | {language-id}/LC_MESSAGES/{Catalog}.mo | ||
3224 | |||
3225 | For example, the catalog for spanish strings would be located at: | ||
3226 | |||
3227 | locale/es/LC_MESSAGES/some-addin.mo | ||
3228 | </remarks> | ||
3229 | </member> | ||
3230 | <member name="T:Mono.Addins.AddinAuthorAttribute"> | ||
3231 | <summary> | ||
3232 | Declares an author of the add-in | ||
3233 | </summary> | ||
3234 | </member> | ||
3235 | <member name="M:Mono.Addins.AddinAuthorAttribute.#ctor(System.String)"> | ||
3236 | <summary> | ||
3237 | Initializes the attribute | ||
3238 | </summary> | ||
3239 | <param name="name"> | ||
3240 | Name of the author | ||
3241 | </param> | ||
3242 | </member> | ||
3243 | <member name="P:Mono.Addins.AddinAuthorAttribute.Name"> | ||
3244 | <summary> | ||
3245 | Author name | ||
3246 | </summary> | ||
3247 | </member> | ||
3248 | <member name="T:Mono.Addins.Description.ConditionTypeDescription"> | ||
3249 | <summary> | ||
3250 | A condition type definition. | ||
3251 | </summary> | ||
3252 | </member> | ||
3253 | <member name="M:Mono.Addins.Description.ConditionTypeDescription.#ctor"> | ||
3254 | <summary> | ||
3255 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.ConditionTypeDescription"/> class. | ||
3256 | </summary> | ||
3257 | </member> | ||
3258 | <member name="M:Mono.Addins.Description.ConditionTypeDescription.CopyFrom(Mono.Addins.Description.ConditionTypeDescription)"> | ||
3259 | <summary> | ||
3260 | Copies data from another condition type definition | ||
3261 | </summary> | ||
3262 | <param name='cond'> | ||
3263 | Condition from which to copy | ||
3264 | </param> | ||
3265 | </member> | ||
3266 | <member name="P:Mono.Addins.Description.ConditionTypeDescription.Id"> | ||
3267 | <summary> | ||
3268 | Gets or sets the identifier of the condition type | ||
3269 | </summary> | ||
3270 | <value> | ||
3271 | The identifier. | ||
3272 | </value> | ||
3273 | </member> | ||
3274 | <member name="P:Mono.Addins.Description.ConditionTypeDescription.TypeName"> | ||
3275 | <summary> | ||
3276 | Gets or sets the name of the type that implements the condition | ||
3277 | </summary> | ||
3278 | <value> | ||
3279 | The name of the type. | ||
3280 | </value> | ||
3281 | </member> | ||
3282 | <member name="P:Mono.Addins.Description.ConditionTypeDescription.Description"> | ||
3283 | <summary> | ||
3284 | Gets or sets the description of the condition. | ||
3285 | </summary> | ||
3286 | <value> | ||
3287 | The description. | ||
3288 | </value> | ||
3289 | </member> | ||
3290 | <member name="T:Mono.Addins.Description.ExtensionPoint"> | ||
3291 | <summary> | ||
3292 | An extension point definition. | ||
3293 | </summary> | ||
3294 | </member> | ||
3295 | <member name="M:Mono.Addins.Description.ExtensionPoint.#ctor"> | ||
3296 | <summary> | ||
3297 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.ExtensionPoint"/> class. | ||
3298 | </summary> | ||
3299 | </member> | ||
3300 | <member name="M:Mono.Addins.Description.ExtensionPoint.CopyFrom(Mono.Addins.Description.ExtensionPoint)"> | ||
3301 | <summary> | ||
3302 | Copies another extension point. | ||
3303 | </summary> | ||
3304 | <param name='ep'> | ||
3305 | Extension point from which to copy. | ||
3306 | </param> | ||
3307 | </member> | ||
3308 | <member name="M:Mono.Addins.Description.ExtensionPoint.AddExtensionNode(System.String,System.String)"> | ||
3309 | <summary> | ||
3310 | Adds an extension node type. | ||
3311 | </summary> | ||
3312 | <returns> | ||
3313 | The extension node type. | ||
3314 | </returns> | ||
3315 | <param name='name'> | ||
3316 | Name of the node | ||
3317 | </param> | ||
3318 | <param name='typeName'> | ||
3319 | Name of the type that implements the extension node. | ||
3320 | </param> | ||
3321 | <remarks> | ||
3322 | This method can be used to register a new allowed node type for the extension point. | ||
3323 | </remarks> | ||
3324 | </member> | ||
3325 | <member name="P:Mono.Addins.Description.ExtensionPoint.Path"> | ||
3326 | <summary> | ||
3327 | Gets or sets the path that identifies the extension point. | ||
3328 | </summary> | ||
3329 | <value> | ||
3330 | The path. | ||
3331 | </value> | ||
3332 | </member> | ||
3333 | <member name="P:Mono.Addins.Description.ExtensionPoint.Name"> | ||
3334 | <summary> | ||
3335 | Gets or sets the display name of the extension point. | ||
3336 | </summary> | ||
3337 | <value> | ||
3338 | The name. | ||
3339 | </value> | ||
3340 | </member> | ||
3341 | <member name="P:Mono.Addins.Description.ExtensionPoint.Description"> | ||
3342 | <summary> | ||
3343 | Gets or sets the description of the extension point. | ||
3344 | </summary> | ||
3345 | <value> | ||
3346 | The description. | ||
3347 | </value> | ||
3348 | </member> | ||
3349 | <member name="P:Mono.Addins.Description.ExtensionPoint.ExtenderAddins"> | ||
3350 | <summary> | ||
3351 | Gets a list of add-ins that extend this extension point. | ||
3352 | </summary> | ||
3353 | <remarks> | ||
3354 | This value is only available when the add-in description is loaded from an add-in registry. | ||
3355 | </remarks> | ||
3356 | </member> | ||
3357 | <member name="P:Mono.Addins.Description.ExtensionPoint.NodeSet"> | ||
3358 | <summary> | ||
3359 | A node set which specifies the node types allowed in this extension point. | ||
3360 | </summary> | ||
3361 | <value> | ||
3362 | The node set. | ||
3363 | </value> | ||
3364 | </member> | ||
3365 | <member name="P:Mono.Addins.Description.ExtensionPoint.Conditions"> | ||
3366 | <summary> | ||
3367 | Gets the conditions available in this node set. | ||
3368 | </summary> | ||
3369 | <value> | ||
3370 | The conditions. | ||
3371 | </value> | ||
3372 | </member> | ||
3373 | <member name="T:Mono.Addins.ConditionType"> | ||
3374 | <summary> | ||
3375 | A condition evaluator. | ||
3376 | </summary> | ||
3377 | <remarks> | ||
3378 | Add-ins may use conditions to register nodes in an extension point which | ||
3379 | are only visible under some contexts. For example, an add-in registering | ||
3380 | a custom menu option to the main menu of a sample text editor might want | ||
3381 | to make that option visible only for some kind of files. To allow add-ins | ||
3382 | to do this kind of check, the host application needs to define a new condition. | ||
3383 | </remarks> | ||
3384 | </member> | ||
3385 | <member name="M:Mono.Addins.ConditionType.Evaluate(Mono.Addins.NodeElement)"> | ||
3386 | <summary> | ||
3387 | Evaluates the condition. | ||
3388 | </summary> | ||
3389 | <param name="conditionNode"> | ||
3390 | Condition node information. | ||
3391 | </param> | ||
3392 | <returns> | ||
3393 | 'true' if the condition is satisfied. | ||
3394 | </returns> | ||
3395 | </member> | ||
3396 | <member name="M:Mono.Addins.ConditionType.NotifyChanged"> | ||
3397 | <summary> | ||
3398 | Notifies that the condition has changed, and that it has to be re-evaluated. | ||
3399 | </summary> | ||
3400 | This method must be called when there is a change in the state that determines | ||
3401 | the result of the evaluation. When this method is called, all node conditions | ||
3402 | depending on it are reevaluated and the corresponding events for adding or | ||
3403 | removing extension nodes are fired. | ||
3404 | <remarks> | ||
3405 | </remarks> | ||
3406 | </member> | ||
3407 | <member name="T:Mono.Addins.ExtensionNodeList"> | ||
3408 | <summary> | ||
3409 | A list of extension nodes. | ||
3410 | </summary> | ||
3411 | </member> | ||
3412 | <member name="M:Mono.Addins.ExtensionNodeList.GetEnumerator"> | ||
3413 | <summary> | ||
3414 | Gets an enumerator which enumerates all nodes in the list | ||
3415 | </summary> | ||
3416 | </member> | ||
3417 | <member name="M:Mono.Addins.ExtensionNodeList.CopyTo(Mono.Addins.ExtensionNode[],System.Int32)"> | ||
3418 | <summary> | ||
3419 | Copies all nodes to an array | ||
3420 | </summary> | ||
3421 | <param name='array'> | ||
3422 | The target array | ||
3423 | </param> | ||
3424 | <param name='index'> | ||
3425 | Initial index where to copy to | ||
3426 | </param> | ||
3427 | </member> | ||
3428 | <member name="P:Mono.Addins.ExtensionNodeList.Item(System.Int32)"> | ||
3429 | <summary> | ||
3430 | Returns the node in the specified index. | ||
3431 | </summary> | ||
3432 | <param name="n"> | ||
3433 | The index. | ||
3434 | </param> | ||
3435 | </member> | ||
3436 | <member name="P:Mono.Addins.ExtensionNodeList.Item(System.String)"> | ||
3437 | <summary> | ||
3438 | Returns the node with the specified ID. | ||
3439 | </summary> | ||
3440 | <param name="id"> | ||
3441 | An id. | ||
3442 | </param> | ||
3443 | </member> | ||
3444 | <member name="P:Mono.Addins.ExtensionNodeList.Count"> | ||
3445 | <summary> | ||
3446 | Number of nodes of the collection. | ||
3447 | </summary> | ||
3448 | </member> | ||
3449 | <member name="T:Mono.Addins.ExtensionNodeList`1"> | ||
3450 | <summary> | ||
3451 | A list of extension nodes. | ||
3452 | </summary> | ||
3453 | </member> | ||
3454 | <member name="M:Mono.Addins.ExtensionNodeList`1.GetEnumerator"> | ||
3455 | <summary> | ||
3456 | Gets an enumerator which enumerates all nodes in the list | ||
3457 | </summary> | ||
3458 | </member> | ||
3459 | <member name="M:Mono.Addins.ExtensionNodeList`1.CopyTo(`0[],System.Int32)"> | ||
3460 | <summary> | ||
3461 | Copies all nodes to an array | ||
3462 | </summary> | ||
3463 | <param name='array'> | ||
3464 | The target array | ||
3465 | </param> | ||
3466 | <param name='index'> | ||
3467 | Initial index where to copy to | ||
3468 | </param> | ||
3469 | </member> | ||
3470 | <member name="P:Mono.Addins.ExtensionNodeList`1.Item(System.Int32)"> | ||
3471 | <summary> | ||
3472 | Returns the node in the specified index. | ||
3473 | </summary> | ||
3474 | <param name="n"> | ||
3475 | The index. | ||
3476 | </param> | ||
3477 | </member> | ||
3478 | <member name="P:Mono.Addins.ExtensionNodeList`1.Item(System.String)"> | ||
3479 | <summary> | ||
3480 | Returns the node with the specified ID. | ||
3481 | </summary> | ||
3482 | <param name="id"> | ||
3483 | An id. | ||
3484 | </param> | ||
3485 | </member> | ||
3486 | <member name="P:Mono.Addins.ExtensionNodeList`1.Count"> | ||
3487 | <summary> | ||
3488 | Number of nodes of the collection. | ||
3489 | </summary> | ||
3490 | </member> | ||
3491 | <member name="T:Mono.Addins.MissingDependencyException"> | ||
3492 | <summary> | ||
3493 | Exception thrown when the add-in engine can't find a required add-in dependency | ||
3494 | </summary> | ||
3495 | </member> | ||
3496 | <member name="T:Mono.Addins.TypeExtensionNode"> | ||
3497 | <summary> | ||
3498 | An extension node which specifies a type. | ||
3499 | </summary> | ||
3500 | <remarks> | ||
3501 | This class is a kind of Mono.Addins.ExtensionNode which can be used to register | ||
3502 | types in an extension point. This is a very common case: a host application | ||
3503 | defines an interface, and add-ins create classes that implement that interface. | ||
3504 | The host will define an extension point which will use TypeExtensionNode as nodetext | ||
3505 | type. Add-ins will register the classes they implement in that extension point. | ||
3506 | |||
3507 | When the nodes of an extension point are of type TypeExtensionNode it is then | ||
3508 | possible to use query methods such as AddinManager.GetExtensionObjects(string), | ||
3509 | which will get all nodes in the provided extension path and will create an object | ||
3510 | for each node. | ||
3511 | |||
3512 | When declaring extension nodes in an add-in manifest, the class names can be | ||
3513 | specified using the 'class' or 'type' attribute. If none of those attributes is | ||
3514 | provided, the class name will be taken from the 'id' attribute. | ||
3515 | |||
3516 | TypeExtensionNode is the default extension type used when no type is provided | ||
3517 | in the definition of an extension point. | ||
3518 | </remarks> | ||
3519 | </member> | ||
3520 | <member name="M:Mono.Addins.TypeExtensionNode.Read(Mono.Addins.NodeElement)"> | ||
3521 | <summary> | ||
3522 | Reads the extension node data | ||
3523 | </summary> | ||
3524 | <param name='elem'> | ||
3525 | The element containing the extension data | ||
3526 | </param> | ||
3527 | <remarks> | ||
3528 | This method can be overriden to provide a custom method for reading extension node data from an element. | ||
3529 | The default implementation reads the attributes if the element and assigns the values to the fields | ||
3530 | and properties of the extension node that have the corresponding [NodeAttribute] decoration. | ||
3531 | </remarks> | ||
3532 | </member> | ||
3533 | <member name="M:Mono.Addins.TypeExtensionNode.CreateInstance"> | ||
3534 | <summary> | ||
3535 | Creates a new extension object | ||
3536 | </summary> | ||
3537 | <returns> | ||
3538 | The extension object | ||
3539 | </returns> | ||
3540 | </member> | ||
3541 | <member name="P:Mono.Addins.TypeExtensionNode.Type"> | ||
3542 | <summary> | ||
3543 | Type of the object that this node creates | ||
3544 | </summary> | ||
3545 | </member> | ||
3546 | <member name="P:Mono.Addins.TypeExtensionNode.TypeName"> | ||
3547 | <summary> | ||
3548 | Name of the type of the object that this node creates | ||
3549 | </summary> | ||
3550 | <value>The name of the type.</value> | ||
3551 | </member> | ||
3552 | <member name="T:Mono.Addins.TypeExtensionNode`1"> | ||
3553 | <summary> | ||
3554 | An extension node which specifies a type with custom extension metadata | ||
3555 | </summary> | ||
3556 | <remarks> | ||
3557 | This is the default type for type extension nodes bound to a custom extension attribute. | ||
3558 | </remarks> | ||
3559 | </member> | ||
3560 | <member name="P:Mono.Addins.TypeExtensionNode`1.Data"> | ||
3561 | <summary> | ||
3562 | The custom attribute containing the extension metadata | ||
3563 | </summary> | ||
3564 | </member> | ||
3565 | <member name="T:Mono.Addins.AddinDescriptionAttribute"> | ||
3566 | <summary> | ||
3567 | Describes the purpose of an add-in or add-in root | ||
3568 | </summary> | ||
3569 | </member> | ||
3570 | <member name="M:Mono.Addins.AddinDescriptionAttribute.#ctor(System.String)"> | ||
3571 | <summary> | ||
3572 | Initializes a new instance of the <see cref="T:Mono.Addins.AddinDescriptionAttribute"/> class. | ||
3573 | </summary> | ||
3574 | <param name="description"> | ||
3575 | Description of the add-in | ||
3576 | </param> | ||
3577 | </member> | ||
3578 | <member name="M:Mono.Addins.AddinDescriptionAttribute.#ctor(System.String,System.String)"> | ||
3579 | <summary> | ||
3580 | Initializes a new instance of the <see cref="T:Mono.Addins.AddinDescriptionAttribute"/> class. | ||
3581 | </summary> | ||
3582 | <param name="description"> | ||
3583 | Description of the add-in | ||
3584 | </param> | ||
3585 | <param name="locale"> | ||
3586 | Locale of the description (for example, 'en-US', or 'en') | ||
3587 | </param> | ||
3588 | </member> | ||
3589 | <member name="P:Mono.Addins.AddinDescriptionAttribute.Description"> | ||
3590 | <value> | ||
3591 | Description of the add-in | ||
3592 | </value> | ||
3593 | </member> | ||
3594 | <member name="P:Mono.Addins.AddinDescriptionAttribute.Locale"> | ||
3595 | <summary> | ||
3596 | Locale of the description (for example, 'en-US', or 'en') | ||
3597 | </summary> | ||
3598 | </member> | ||
3599 | <member name="T:Mono.Addins.AddinRootAttribute"> | ||
3600 | <summary> | ||
3601 | Marks an assembly as being an add-in root. | ||
3602 | </summary> | ||
3603 | <remarks> | ||
3604 | An add-in root is an assemly which can be extended by add-ins. | ||
3605 | </remarks> | ||
3606 | </member> | ||
3607 | <member name="T:Mono.Addins.AddinAttribute"> | ||
3608 | <summary> | ||
3609 | Marks an assembly as being an add-in. | ||
3610 | </summary> | ||
3611 | </member> | ||
3612 | <member name="M:Mono.Addins.AddinAttribute.#ctor"> | ||
3613 | <summary> | ||
3614 | Initializes an add-in marker attribute | ||
3615 | </summary> | ||
3616 | </member> | ||
3617 | <member name="M:Mono.Addins.AddinAttribute.#ctor(System.String)"> | ||
3618 | <summary> | ||
3619 | Initializes an add-in marker attribute | ||
3620 | </summary> | ||
3621 | <param name="id"> | ||
3622 | Identifier of the add-in | ||
3623 | </param> | ||
3624 | </member> | ||
3625 | <member name="M:Mono.Addins.AddinAttribute.#ctor(System.String,System.String)"> | ||
3626 | <summary> | ||
3627 | Initializes an add-in marker attribute | ||
3628 | </summary> | ||
3629 | <param name="id"> | ||
3630 | Identifier of the add-in | ||
3631 | </param> | ||
3632 | <param name="version"> | ||
3633 | Version of the add-in | ||
3634 | </param> | ||
3635 | </member> | ||
3636 | <member name="P:Mono.Addins.AddinAttribute.Id"> | ||
3637 | <summary> | ||
3638 | Identifier of the add-in. | ||
3639 | </summary> | ||
3640 | </member> | ||
3641 | <member name="P:Mono.Addins.AddinAttribute.Version"> | ||
3642 | <summary> | ||
3643 | Version of the add-in. | ||
3644 | </summary> | ||
3645 | </member> | ||
3646 | <member name="P:Mono.Addins.AddinAttribute.CompatVersion"> | ||
3647 | <summary> | ||
3648 | Version of the add-in with which this add-in is backwards compatible. | ||
3649 | </summary> | ||
3650 | </member> | ||
3651 | <member name="P:Mono.Addins.AddinAttribute.Namespace"> | ||
3652 | <summary> | ||
3653 | Namespace of the add-in | ||
3654 | </summary> | ||
3655 | </member> | ||
3656 | <member name="P:Mono.Addins.AddinAttribute.Category"> | ||
3657 | <summary> | ||
3658 | Category of the add-in | ||
3659 | </summary> | ||
3660 | </member> | ||
3661 | <member name="P:Mono.Addins.AddinAttribute.Url"> | ||
3662 | <summary> | ||
3663 | Url to a web page with more information about the add-in | ||
3664 | </summary> | ||
3665 | </member> | ||
3666 | <member name="P:Mono.Addins.AddinAttribute.EnabledByDefault"> | ||
3667 | <summary> | ||
3668 | When set to True, the add-in will be automatically enabled after installing. | ||
3669 | It's True by default. | ||
3670 | </summary> | ||
3671 | </member> | ||
3672 | <member name="P:Mono.Addins.AddinAttribute.Flags"> | ||
3673 | <summary> | ||
3674 | Add-in flags | ||
3675 | </summary> | ||
3676 | </member> | ||
3677 | <member name="M:Mono.Addins.AddinRootAttribute.#ctor"> | ||
3678 | <summary> | ||
3679 | Initializes a new instance | ||
3680 | </summary> | ||
3681 | </member> | ||
3682 | <member name="M:Mono.Addins.AddinRootAttribute.#ctor(System.String)"> | ||
3683 | <summary> | ||
3684 | Initializes a new instance | ||
3685 | </summary> | ||
3686 | <param name="id"> | ||
3687 | Identifier of the add-in root | ||
3688 | </param> | ||
3689 | </member> | ||
3690 | <member name="M:Mono.Addins.AddinRootAttribute.#ctor(System.String,System.String)"> | ||
3691 | <summary> | ||
3692 | Initializes a new instance | ||
3693 | </summary> | ||
3694 | <param name="id"> | ||
3695 | Identifier of the add-in root | ||
3696 | </param> | ||
3697 | <param name="version"> | ||
3698 | Version of the add-in root | ||
3699 | </param> | ||
3700 | </member> | ||
3701 | <member name="T:Mono.Addins.Description.Extension"> | ||
3702 | <summary> | ||
3703 | An extension definition. | ||
3704 | </summary> | ||
3705 | <remarks> | ||
3706 | An Extension is a collection of nodes which have to be registered in an extension point. | ||
3707 | The target extension point is specified in the <see cref="T:Mono.Addins.Description.Extension"/>.Path property. | ||
3708 | </remarks> | ||
3709 | </member> | ||
3710 | <member name="M:Mono.Addins.Description.Extension.#ctor"> | ||
3711 | <summary> | ||
3712 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.Extension"/> class. | ||
3713 | </summary> | ||
3714 | </member> | ||
3715 | <member name="M:Mono.Addins.Description.Extension.#ctor(System.String)"> | ||
3716 | <summary> | ||
3717 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.Extension"/> class. | ||
3718 | </summary> | ||
3719 | <param name="path"> | ||
3720 | Path that identifies the extension point being extended | ||
3721 | </param> | ||
3722 | </member> | ||
3723 | <member name="M:Mono.Addins.Description.Extension.GetExtendedObject"> | ||
3724 | <summary> | ||
3725 | Gets the object extended by this extension | ||
3726 | </summary> | ||
3727 | <returns> | ||
3728 | The extended object can be an <see cref="T:Mono.Addins.Description.ExtensionPoint"/> or | ||
3729 | an <see cref="T:Mono.Addins.Description.ExtensionNodeDescription"/>. | ||
3730 | </returns> | ||
3731 | <remarks> | ||
3732 | This method only works when the add-in description to which the extension belongs has been | ||
3733 | loaded from an add-in registry. | ||
3734 | </remarks> | ||
3735 | </member> | ||
3736 | <member name="M:Mono.Addins.Description.Extension.GetAllowedNodeTypes"> | ||
3737 | <summary> | ||
3738 | Gets the node types allowed in this extension. | ||
3739 | </summary> | ||
3740 | <returns> | ||
3741 | The allowed node types. | ||
3742 | </returns> | ||
3743 | <remarks> | ||
3744 | This method only works when the add-in description to which the extension belongs has been | ||
3745 | loaded from an add-in registry. | ||
3746 | </remarks> | ||
3747 | </member> | ||
3748 | <member name="M:Mono.Addins.Description.Extension.#ctor(System.Xml.XmlElement)"> | ||
3749 | <summary> | ||
3750 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.Extension"/> class. | ||
3751 | </summary> | ||
3752 | <param name="element"> | ||
3753 | XML that describes the extension. | ||
3754 | </param> | ||
3755 | </member> | ||
3756 | <member name="P:Mono.Addins.Description.Extension.Path"> | ||
3757 | <summary> | ||
3758 | Gets or sets the path that identifies the extension point being extended. | ||
3759 | </summary> | ||
3760 | <value> | ||
3761 | The path. | ||
3762 | </value> | ||
3763 | </member> | ||
3764 | <member name="P:Mono.Addins.Description.Extension.ExtensionNodes"> | ||
3765 | <summary> | ||
3766 | Gets the extension nodes. | ||
3767 | </summary> | ||
3768 | <value> | ||
3769 | The extension nodes. | ||
3770 | </value> | ||
3771 | </member> | ||
3772 | <member name="T:Mono.Addins.ExtensionEventHandler"> | ||
3773 | <summary> | ||
3774 | Delegate to be used in extension point subscriptions | ||
3775 | </summary> | ||
3776 | </member> | ||
3777 | <member name="T:Mono.Addins.ExtensionNodeEventHandler"> | ||
3778 | <summary> | ||
3779 | Delegate to be used in extension point subscriptions | ||
3780 | </summary> | ||
3781 | </member> | ||
3782 | <member name="T:Mono.Addins.ExtensionEventArgs"> | ||
3783 | <summary> | ||
3784 | Arguments for extension events. | ||
3785 | </summary> | ||
3786 | </member> | ||
3787 | <member name="M:Mono.Addins.ExtensionEventArgs.#ctor(System.String)"> | ||
3788 | <summary> | ||
3789 | Creates a new instance. | ||
3790 | </summary> | ||
3791 | <param name="path"> | ||
3792 | Path of the extension node that has changed. | ||
3793 | </param> | ||
3794 | </member> | ||
3795 | <member name="M:Mono.Addins.ExtensionEventArgs.PathChanged(System.String)"> | ||
3796 | <summary> | ||
3797 | Checks if a path has changed. | ||
3798 | </summary> | ||
3799 | <param name="pathToCheck"> | ||
3800 | An extension path. | ||
3801 | </param> | ||
3802 | <returns> | ||
3803 | 'true' if the path is affected by the extension change event. | ||
3804 | </returns> | ||
3805 | <remarks> | ||
3806 | Checks if the specified path or any of its children paths is affected by the extension change event. | ||
3807 | </remarks> | ||
3808 | </member> | ||
3809 | <member name="P:Mono.Addins.ExtensionEventArgs.Path"> | ||
3810 | <summary> | ||
3811 | Path of the extension node that has changed. | ||
3812 | </summary> | ||
3813 | </member> | ||
3814 | <member name="T:Mono.Addins.ExtensionNodeEventArgs"> | ||
3815 | <summary> | ||
3816 | Arguments for extension node events. | ||
3817 | </summary> | ||
3818 | </member> | ||
3819 | <member name="M:Mono.Addins.ExtensionNodeEventArgs.#ctor(Mono.Addins.ExtensionChange,Mono.Addins.ExtensionNode)"> | ||
3820 | <summary> | ||
3821 | Creates a new instance | ||
3822 | </summary> | ||
3823 | <param name="change"> | ||
3824 | Type of change. | ||
3825 | </param> | ||
3826 | <param name="node"> | ||
3827 | Node that has been added or removed. | ||
3828 | </param> | ||
3829 | </member> | ||
3830 | <member name="P:Mono.Addins.ExtensionNodeEventArgs.Path"> | ||
3831 | <summary> | ||
3832 | Path of the extension that changed. | ||
3833 | </summary> | ||
3834 | </member> | ||
3835 | <member name="P:Mono.Addins.ExtensionNodeEventArgs.Change"> | ||
3836 | <summary> | ||
3837 | Type of change. | ||
3838 | </summary> | ||
3839 | </member> | ||
3840 | <member name="P:Mono.Addins.ExtensionNodeEventArgs.ExtensionNode"> | ||
3841 | <summary> | ||
3842 | Node that has been added or removed. | ||
3843 | </summary> | ||
3844 | </member> | ||
3845 | <member name="P:Mono.Addins.ExtensionNodeEventArgs.ExtensionObject"> | ||
3846 | <summary> | ||
3847 | Extension object that has been added or removed. | ||
3848 | </summary> | ||
3849 | </member> | ||
3850 | <member name="T:Mono.Addins.ExtensionChange"> | ||
3851 | <summary> | ||
3852 | Type of change in an extension change event. | ||
3853 | </summary> | ||
3854 | </member> | ||
3855 | <member name="F:Mono.Addins.ExtensionChange.Add"> | ||
3856 | <summary> | ||
3857 | An extension node has been added. | ||
3858 | </summary> | ||
3859 | </member> | ||
3860 | <member name="F:Mono.Addins.ExtensionChange.Remove"> | ||
3861 | <summary> | ||
3862 | An extension node has been removed. | ||
3863 | </summary> | ||
3864 | </member> | ||
3865 | <member name="T:Mono.Addins.AddinNameAttribute"> | ||
3866 | <summary> | ||
3867 | Sets the display name of an add-in | ||
3868 | </summary> | ||
3869 | </member> | ||
3870 | <member name="M:Mono.Addins.AddinNameAttribute.#ctor(System.String)"> | ||
3871 | <summary> | ||
3872 | Initializes a new instance of the <see cref="T:Mono.Addins.AddinNameAttribute"/> class. | ||
3873 | </summary> | ||
3874 | <param name="name"> | ||
3875 | Name of the add-in | ||
3876 | </param> | ||
3877 | </member> | ||
3878 | <member name="M:Mono.Addins.AddinNameAttribute.#ctor(System.String,System.String)"> | ||
3879 | <summary> | ||
3880 | Initializes a new instance of the <see cref="T:Mono.Addins.AddinNameAttribute"/> class. | ||
3881 | </summary> | ||
3882 | <param name="name"> | ||
3883 | Name of the add-in | ||
3884 | </param> | ||
3885 | <param name="locale"> | ||
3886 | Locale of the name (for example, 'en-US', or 'en') | ||
3887 | </param> | ||
3888 | </member> | ||
3889 | <member name="P:Mono.Addins.AddinNameAttribute.Name"> | ||
3890 | <value> | ||
3891 | Name of the add-in | ||
3892 | </value> | ||
3893 | </member> | ||
3894 | <member name="P:Mono.Addins.AddinNameAttribute.Locale"> | ||
3895 | <summary> | ||
3896 | Locale of the name (for example, 'en-US', or 'en') | ||
3897 | </summary> | ||
3898 | </member> | ||
3899 | <member name="T:Mono.Addins.ContentType"> | ||
3900 | <summary> | ||
3901 | Type of the content of a string extension node attribute | ||
3902 | </summary> | ||
3903 | </member> | ||
3904 | <member name="F:Mono.Addins.ContentType.Text"> | ||
3905 | <summary> | ||
3906 | Plain text | ||
3907 | </summary> | ||
3908 | </member> | ||
3909 | <member name="F:Mono.Addins.ContentType.Class"> | ||
3910 | <summary> | ||
3911 | A class name | ||
3912 | </summary> | ||
3913 | </member> | ||
3914 | <member name="F:Mono.Addins.ContentType.Resource"> | ||
3915 | <summary> | ||
3916 | A resource name | ||
3917 | </summary> | ||
3918 | </member> | ||
3919 | <member name="F:Mono.Addins.ContentType.File"> | ||
3920 | <summary> | ||
3921 | A file name | ||
3922 | </summary> | ||
3923 | </member> | ||
3924 | <member name="T:Mono.Addins.Database.AddinFileSystemExtension"> | ||
3925 | <summary> | ||
3926 | An add-in file system extension. | ||
3927 | </summary> | ||
3928 | <remarks> | ||
3929 | File system extensions can override the behavior of the add-in scanner and provide custom rules for | ||
3930 | locating and scanning assemblies. | ||
3931 | </remarks> | ||
3932 | </member> | ||
3933 | <member name="M:Mono.Addins.Database.AddinFileSystemExtension.ScanStarted"> | ||
3934 | <summary> | ||
3935 | Called when the add-in scan is about to start | ||
3936 | </summary> | ||
3937 | </member> | ||
3938 | <member name="M:Mono.Addins.Database.AddinFileSystemExtension.ScanFinished"> | ||
3939 | <summary> | ||
3940 | Called when the add-in scan has finished | ||
3941 | </summary> | ||
3942 | </member> | ||
3943 | <member name="M:Mono.Addins.Database.AddinFileSystemExtension.DirectoryExists(System.String)"> | ||
3944 | <summary> | ||
3945 | Checks if a directory exists | ||
3946 | </summary> | ||
3947 | <returns> | ||
3948 | 'true' if the directory exists | ||
3949 | </returns> | ||
3950 | <param name='path'> | ||
3951 | Directory path | ||
3952 | </param> | ||
3953 | </member> | ||
3954 | <member name="M:Mono.Addins.Database.AddinFileSystemExtension.FileExists(System.String)"> | ||
3955 | <summary> | ||
3956 | Checks if a file exists | ||
3957 | </summary> | ||
3958 | <returns> | ||
3959 | 'true' if the file exists | ||
3960 | </returns> | ||
3961 | <param name='path'> | ||
3962 | Path to the file | ||
3963 | </param> | ||
3964 | </member> | ||
3965 | <member name="M:Mono.Addins.Database.AddinFileSystemExtension.GetFiles(System.String)"> | ||
3966 | <summary> | ||
3967 | Gets the files in a directory | ||
3968 | </summary> | ||
3969 | <returns> | ||
3970 | The full path of the files in the directory | ||
3971 | </returns> | ||
3972 | <param name='path'> | ||
3973 | Directory path | ||
3974 | </param> | ||
3975 | </member> | ||
3976 | <member name="M:Mono.Addins.Database.AddinFileSystemExtension.GetDirectories(System.String)"> | ||
3977 | <summary> | ||
3978 | Gets the subdirectories of a directory | ||
3979 | </summary> | ||
3980 | <returns> | ||
3981 | The subdirectories. | ||
3982 | </returns> | ||
3983 | <param name='path'> | ||
3984 | The directory | ||
3985 | </param> | ||
3986 | </member> | ||
3987 | <member name="M:Mono.Addins.Database.AddinFileSystemExtension.GetLastWriteTime(System.String)"> | ||
3988 | <summary> | ||
3989 | Gets the last write time of a file | ||
3990 | </summary> | ||
3991 | <returns> | ||
3992 | The last write time. | ||
3993 | </returns> | ||
3994 | <param name='filePath'> | ||
3995 | File path. | ||
3996 | </param> | ||
3997 | </member> | ||
3998 | <member name="M:Mono.Addins.Database.AddinFileSystemExtension.OpenTextFile(System.String)"> | ||
3999 | <summary> | ||
4000 | Opens a text file | ||
4001 | </summary> | ||
4002 | <returns> | ||
4003 | The text file stream | ||
4004 | </returns> | ||
4005 | <param name='path'> | ||
4006 | File path. | ||
4007 | </param> | ||
4008 | </member> | ||
4009 | <member name="M:Mono.Addins.Database.AddinFileSystemExtension.OpenFile(System.String)"> | ||
4010 | <summary> | ||
4011 | Opens a file. | ||
4012 | </summary> | ||
4013 | <returns> | ||
4014 | The file stream. | ||
4015 | </returns> | ||
4016 | <param name='path'> | ||
4017 | The file path. | ||
4018 | </param> | ||
4019 | </member> | ||
4020 | <member name="M:Mono.Addins.Database.AddinFileSystemExtension.GetReflectorForFile(Mono.Addins.Database.IAssemblyLocator,System.String)"> | ||
4021 | <summary> | ||
4022 | Gets an assembly reflector for a file. | ||
4023 | </summary> | ||
4024 | <returns> | ||
4025 | The reflector for the file. | ||
4026 | </returns> | ||
4027 | <param name='locator'> | ||
4028 | An assembly locator | ||
4029 | </param> | ||
4030 | <param name='path'> | ||
4031 | A file path | ||
4032 | </param> | ||
4033 | </member> | ||
4034 | <member name="P:Mono.Addins.Database.AddinFileSystemExtension.RequiresIsolation"> | ||
4035 | <summary> | ||
4036 | Gets a value indicating whether this <see cref="T:Mono.Addins.Database.AddinFileSystemExtension"/> needs to be isolated from the main execution process | ||
4037 | </summary> | ||
4038 | <value> | ||
4039 | <c>true</c> if requires isolation; otherwise, <c>false</c>. | ||
4040 | </value> | ||
4041 | </member> | ||
4042 | <member name="T:Mono.Addins.ExtensionAttributeAttribute"> | ||
4043 | <summary> | ||
4044 | Assigns an attribute value to an extension | ||
4045 | </summary> | ||
4046 | <remarks> | ||
4047 | This attribute can be used together with the [Extenion] attribute to specify | ||
4048 | a value for an attribute of the extension. | ||
4049 | </remarks> | ||
4050 | </member> | ||
4051 | <member name="M:Mono.Addins.ExtensionAttributeAttribute.#ctor(System.String,System.String)"> | ||
4052 | <summary> | ||
4053 | Initializes a new instance of the <see cref="T:Mono.Addins.ExtensionAttributeAttribute"/> class. | ||
4054 | </summary> | ||
4055 | <param name="name"> | ||
4056 | Name of the attribute | ||
4057 | </param> | ||
4058 | <param name="value"> | ||
4059 | Value of the attribute | ||
4060 | </param> | ||
4061 | </member> | ||
4062 | <member name="M:Mono.Addins.ExtensionAttributeAttribute.#ctor(System.Type,System.String,System.String)"> | ||
4063 | <summary> | ||
4064 | Initializes a new instance of the <see cref="T:Mono.Addins.ExtensionAttributeAttribute"/> class. | ||
4065 | </summary> | ||
4066 | <param name="type"> | ||
4067 | Type of the extension for which the attribute value is being set | ||
4068 | </param> | ||
4069 | <param name="name"> | ||
4070 | Name of the attribute | ||
4071 | </param> | ||
4072 | <param name="value"> | ||
4073 | Value of the attribute | ||
4074 | </param> | ||
4075 | </member> | ||
4076 | <member name="M:Mono.Addins.ExtensionAttributeAttribute.#ctor(System.String,System.String,System.String)"> | ||
4077 | <summary> | ||
4078 | Initializes a new instance of the <see cref="T:Mono.Addins.ExtensionAttributeAttribute"/> class. | ||
4079 | </summary> | ||
4080 | <param name="path"> | ||
4081 | Path of the extension for which the attribute value is being set | ||
4082 | </param> | ||
4083 | <param name="name"> | ||
4084 | Name of the attribute | ||
4085 | </param> | ||
4086 | <param name="value"> | ||
4087 | Value of the attribute | ||
4088 | </param> | ||
4089 | </member> | ||
4090 | <member name="P:Mono.Addins.ExtensionAttributeAttribute.Name"> | ||
4091 | <summary> | ||
4092 | Name of the attribute | ||
4093 | </summary> | ||
4094 | </member> | ||
4095 | <member name="P:Mono.Addins.ExtensionAttributeAttribute.Value"> | ||
4096 | <summary> | ||
4097 | Value of the attribute | ||
4098 | </summary> | ||
4099 | </member> | ||
4100 | <member name="P:Mono.Addins.ExtensionAttributeAttribute.Path"> | ||
4101 | <summary> | ||
4102 | Path of the extension for which the attribute value is being set | ||
4103 | </summary> | ||
4104 | </member> | ||
4105 | <member name="P:Mono.Addins.ExtensionAttributeAttribute.Type"> | ||
4106 | <summary> | ||
4107 | Type of the extension for which the attribute value is being set | ||
4108 | </summary> | ||
4109 | </member> | ||
4110 | <member name="T:Mono.Addins.IAddinInstaller"> | ||
4111 | <summary> | ||
4112 | An add-in installation handler | ||
4113 | </summary> | ||
4114 | </member> | ||
4115 | <member name="M:Mono.Addins.IAddinInstaller.InstallAddins(Mono.Addins.AddinRegistry,System.String,System.String[])"> | ||
4116 | <summary> | ||
4117 | Installs a set of add-ins | ||
4118 | </summary> | ||
4119 | <param name="reg"> | ||
4120 | Registry where to install | ||
4121 | </param> | ||
4122 | <param name="message"> | ||
4123 | Message to show to the user when new add-ins have to be installed. | ||
4124 | </param> | ||
4125 | <param name="addinIds"> | ||
4126 | List of IDs of the add-ins to be installed. | ||
4127 | </param> | ||
4128 | </member> | ||
4129 | <member name="T:Mono.Addins.ExtensionNodeAttribute"> | ||
4130 | <summary> | ||
4131 | This attribute can be applied to an ExtensionNode subclass to specify the default name and description. | ||
4132 | </summary> | ||
4133 | <remarks> | ||
4134 | This information will be used when an extension point does not define a name or description for a node type. | ||
4135 | </remarks> | ||
4136 | </member> | ||
4137 | <member name="M:Mono.Addins.ExtensionNodeAttribute.#ctor"> | ||
4138 | <summary> | ||
4139 | Initializes the attribute | ||
4140 | </summary> | ||
4141 | </member> | ||
4142 | <member name="M:Mono.Addins.ExtensionNodeAttribute.#ctor(System.String)"> | ||
4143 | <summary> | ||
4144 | Initializes the attribute | ||
4145 | </summary> | ||
4146 | <param name="nodeName"> | ||
4147 | Name of the node | ||
4148 | </param> | ||
4149 | </member> | ||
4150 | <member name="M:Mono.Addins.ExtensionNodeAttribute.#ctor(System.String,System.String)"> | ||
4151 | <summary> | ||
4152 | Initializes the attribute | ||
4153 | </summary> | ||
4154 | <param name="nodeName"> | ||
4155 | Name of the node | ||
4156 | </param> | ||
4157 | <param name="description"> | ||
4158 | Description of the node | ||
4159 | </param> | ||
4160 | </member> | ||
4161 | <member name="P:Mono.Addins.ExtensionNodeAttribute.NodeName"> | ||
4162 | <summary> | ||
4163 | Default name of the extension node | ||
4164 | </summary> | ||
4165 | </member> | ||
4166 | <member name="P:Mono.Addins.ExtensionNodeAttribute.Description"> | ||
4167 | <summary> | ||
4168 | Default description of the extension node type | ||
4169 | </summary> | ||
4170 | </member> | ||
4171 | <member name="P:Mono.Addins.ExtensionNodeAttribute.ExtensionAttributeType"> | ||
4172 | <summary> | ||
4173 | Type of a custom attribute which can be used to specify metadata for this extension node type | ||
4174 | </summary> | ||
4175 | </member> | ||
4176 | <member name="T:Mono.Addins.Description.DependencyCollection"> | ||
4177 | <summary> | ||
4178 | A collection of dependency definitions. | ||
4179 | </summary> | ||
4180 | </member> | ||
4181 | <member name="M:Mono.Addins.Description.DependencyCollection.#ctor"> | ||
4182 | <summary> | ||
4183 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.DependencyCollection"/> class. | ||
4184 | </summary> | ||
4185 | </member> | ||
4186 | <member name="M:Mono.Addins.Description.DependencyCollection.Add(Mono.Addins.Description.Dependency)"> | ||
4187 | <summary> | ||
4188 | Adds a dependency to the collection | ||
4189 | </summary> | ||
4190 | <param name='dep'> | ||
4191 | The dependency to add. | ||
4192 | </param> | ||
4193 | </member> | ||
4194 | <member name="M:Mono.Addins.Description.DependencyCollection.Remove(Mono.Addins.Description.Dependency)"> | ||
4195 | <summary> | ||
4196 | Remove the specified dependency. | ||
4197 | </summary> | ||
4198 | <param name='dep'> | ||
4199 | Dependency to remove. | ||
4200 | </param> | ||
4201 | </member> | ||
4202 | <member name="P:Mono.Addins.Description.DependencyCollection.Item(System.Int32)"> | ||
4203 | <summary> | ||
4204 | Gets the <see cref="T:Mono.Addins.Description.Dependency"/> at the specified index. | ||
4205 | </summary> | ||
4206 | <param name="n"> | ||
4207 | The idnex. | ||
4208 | </param> | ||
4209 | </member> | ||
4210 | <member name="T:Mono.Addins.ExtensionAttribute"> | ||
4211 | <summary> | ||
4212 | Declares a type extension. | ||
4213 | </summary> | ||
4214 | <remarks> | ||
4215 | When applied to a class, specifies that the class is an extension | ||
4216 | class to be registered in a matching extension point. | ||
4217 | </remarks> | ||
4218 | </member> | ||
4219 | <member name="M:Mono.Addins.ExtensionAttribute.#ctor"> | ||
4220 | <summary> | ||
4221 | Initializes a new instance of the ExtensionAttribute class. | ||
4222 | </summary> | ||
4223 | </member> | ||
4224 | <member name="M:Mono.Addins.ExtensionAttribute.#ctor(System.String)"> | ||
4225 | <summary> | ||
4226 | Initializes a new instance | ||
4227 | </summary> | ||
4228 | <param name="path"> | ||
4229 | Path of the extension point. | ||
4230 | </param> | ||
4231 | <remarks>The path is only required if there are several extension points defined for the same type.</remarks> | ||
4232 | </member> | ||
4233 | <member name="M:Mono.Addins.ExtensionAttribute.#ctor(System.Type)"> | ||
4234 | <summary> | ||
4235 | Initializes a new instance | ||
4236 | </summary> | ||
4237 | <param name="type"> | ||
4238 | Type defining the extension point being extended | ||
4239 | </param> | ||
4240 | <remarks> | ||
4241 | This constructor can be used to explicitly specify the type that defines the extension point | ||
4242 | to be extended. By default, Mono.Addins will try to find any extension point defined in any | ||
4243 | of the base classes or interfaces. The type parameter can be used when there is more than one | ||
4244 | base type providing an extension point. | ||
4245 | </remarks> | ||
4246 | </member> | ||
4247 | <member name="P:Mono.Addins.ExtensionAttribute.Path"> | ||
4248 | <summary> | ||
4249 | Path of the extension point being extended | ||
4250 | </summary> | ||
4251 | <remarks> | ||
4252 | The path is only required if there are several extension points defined for the same type. | ||
4253 | </remarks> | ||
4254 | </member> | ||
4255 | <member name="P:Mono.Addins.ExtensionAttribute.NodeName"> | ||
4256 | <summary> | ||
4257 | Name of the extension node | ||
4258 | </summary> | ||
4259 | <remarks> | ||
4260 | Extension points may require extensions to use a specific node name. | ||
4261 | This is needed when an extension point may contain several different types of nodes. | ||
4262 | </remarks> | ||
4263 | </member> | ||
4264 | <member name="P:Mono.Addins.ExtensionAttribute.Id"> | ||
4265 | <summary> | ||
4266 | Identifier of the extension node. | ||
4267 | </summary> | ||
4268 | <remarks> | ||
4269 | The ExtensionAttribute.InsertAfter and ExtensionAttribute.InsertBefore | ||
4270 | properties can be used to specify the relative location of a node. The nodes | ||
4271 | referenced in those properties must be defined either in the add-in host | ||
4272 | being extended, or in any add-in on which this add-in depends. | ||
4273 | </remarks> | ||
4274 | </member> | ||
4275 | <member name="P:Mono.Addins.ExtensionAttribute.InsertBefore"> | ||
4276 | <summary> | ||
4277 | Identifier of the extension node before which this node has to be added in the extension point. | ||
4278 | </summary> | ||
4279 | <remarks> | ||
4280 | The ExtensionAttribute.InsertAfter and ExtensionAttribute.InsertBefore | ||
4281 | properties can be used to specify the relative location of a node. The nodes | ||
4282 | referenced in those properties must be defined either in the add-in host | ||
4283 | being extended, or in any add-in on which this add-in depends. | ||
4284 | </remarks> | ||
4285 | </member> | ||
4286 | <member name="P:Mono.Addins.ExtensionAttribute.InsertAfter"> | ||
4287 | <summary> | ||
4288 | Identifier of the extension node after which this node has to be added in the extension point. | ||
4289 | </summary> | ||
4290 | </member> | ||
4291 | <member name="P:Mono.Addins.ExtensionAttribute.Type"> | ||
4292 | <summary> | ||
4293 | Type defining the extension point being extended | ||
4294 | </summary> | ||
4295 | <remarks> | ||
4296 | This property can be used to explicitly specify the type that defines the extension point | ||
4297 | to be extended. By default, Mono.Addins will try to find any extension point defined in any | ||
4298 | of the base classes or interfaces. This property can be used when there is more than one | ||
4299 | base type providing an extension point. | ||
4300 | </remarks> | ||
4301 | </member> | ||
4302 | <member name="T:Mono.Addins.RuntimeAddin"> | ||
4303 | <summary> | ||
4304 | Run-time representation of an add-in. | ||
4305 | </summary> | ||
4306 | </member> | ||
4307 | <member name="M:Mono.Addins.RuntimeAddin.ToString"> | ||
4308 | <summary> | ||
4309 | Returns a string that represents the current RuntimeAddin. | ||
4310 | </summary> | ||
4311 | <returns> | ||
4312 | A string that represents the current RuntimeAddin. | ||
4313 | </returns> | ||
4314 | </member> | ||
4315 | <member name="M:Mono.Addins.RuntimeAddin.GetResourceString(System.String)"> | ||
4316 | <summary> | ||
4317 | Gets a resource string | ||
4318 | </summary> | ||
4319 | <param name="name"> | ||
4320 | Name of the resource | ||
4321 | </param> | ||
4322 | <returns> | ||
4323 | The value of the resource string, or null if the resource can't be found. | ||
4324 | </returns> | ||
4325 | <remarks> | ||
4326 | The add-in engine will look for resources in the main add-in assembly and in all included add-in assemblies. | ||
4327 | </remarks> | ||
4328 | </member> | ||
4329 | <member name="M:Mono.Addins.RuntimeAddin.GetResourceString(System.String,System.Boolean)"> | ||
4330 | <summary> | ||
4331 | Gets a resource string | ||
4332 | </summary> | ||
4333 | <param name="name"> | ||
4334 | Name of the resource | ||
4335 | </param> | ||
4336 | <param name="throwIfNotFound"> | ||
4337 | When set to true, an exception will be thrown if the resource is not found. | ||
4338 | </param> | ||
4339 | <returns> | ||
4340 | The value of the resource string | ||
4341 | </returns> | ||
4342 | <remarks> | ||
4343 | The add-in engine will look for resources in the main add-in assembly and in all included add-in assemblies. | ||
4344 | </remarks> | ||
4345 | </member> | ||
4346 | <member name="M:Mono.Addins.RuntimeAddin.GetResourceString(System.String,System.Boolean,System.Globalization.CultureInfo)"> | ||
4347 | <summary> | ||
4348 | Gets a resource string | ||
4349 | </summary> | ||
4350 | <param name="name"> | ||
4351 | Name of the resource | ||
4352 | </param> | ||
4353 | <param name="throwIfNotFound"> | ||
4354 | When set to true, an exception will be thrown if the resource is not found. | ||
4355 | </param> | ||
4356 | <param name="culture"> | ||
4357 | Culture of the resource | ||
4358 | </param> | ||
4359 | <returns> | ||
4360 | The value of the resource string | ||
4361 | </returns> | ||
4362 | <remarks> | ||
4363 | The add-in engine will look for resources in the main add-in assembly and in all included add-in assemblies. | ||
4364 | </remarks> | ||
4365 | </member> | ||
4366 | <member name="M:Mono.Addins.RuntimeAddin.GetResourceObject(System.String)"> | ||
4367 | <summary> | ||
4368 | Gets a resource object | ||
4369 | </summary> | ||
4370 | <param name="name"> | ||
4371 | Name of the resource | ||
4372 | </param> | ||
4373 | <returns> | ||
4374 | Value of the resource | ||
4375 | </returns> | ||
4376 | <remarks> | ||
4377 | The add-in engine will look for resources in the main add-in assembly and in all included add-in assemblies. | ||
4378 | </remarks> | ||
4379 | </member> | ||
4380 | <member name="M:Mono.Addins.RuntimeAddin.GetResourceObject(System.String,System.Boolean)"> | ||
4381 | <summary> | ||
4382 | Gets a resource object | ||
4383 | </summary> | ||
4384 | <param name="name"> | ||
4385 | Name of the resource | ||
4386 | </param> | ||
4387 | <param name="throwIfNotFound"> | ||
4388 | When set to true, an exception will be thrown if the resource is not found. | ||
4389 | </param> | ||
4390 | <returns> | ||
4391 | Value of the resource | ||
4392 | </returns> | ||
4393 | <remarks> | ||
4394 | The add-in engine will look for resources in the main add-in assembly and in all included add-in assemblies. | ||
4395 | </remarks> | ||
4396 | </member> | ||
4397 | <member name="M:Mono.Addins.RuntimeAddin.GetResourceObject(System.String,System.Boolean,System.Globalization.CultureInfo)"> | ||
4398 | <summary> | ||
4399 | Gets a resource object | ||
4400 | </summary> | ||
4401 | <param name="name"> | ||
4402 | Name of the resource | ||
4403 | </param> | ||
4404 | <param name="throwIfNotFound"> | ||
4405 | When set to true, an exception will be thrown if the resource is not found. | ||
4406 | </param> | ||
4407 | <param name="culture"> | ||
4408 | Culture of the resource | ||
4409 | </param> | ||
4410 | <returns> | ||
4411 | Value of the resource | ||
4412 | </returns> | ||
4413 | <remarks> | ||
4414 | The add-in engine will look for resources in the main add-in assembly and in all included add-in assemblies. | ||
4415 | </remarks> | ||
4416 | </member> | ||
4417 | <member name="M:Mono.Addins.RuntimeAddin.GetType(System.String)"> | ||
4418 | <summary> | ||
4419 | Gets a type defined in the add-in | ||
4420 | </summary> | ||
4421 | <param name="typeName"> | ||
4422 | Full name of the type | ||
4423 | </param> | ||
4424 | <returns> | ||
4425 | A type. | ||
4426 | </returns> | ||
4427 | <remarks> | ||
4428 | The type will be looked up in the assemblies that implement the add-in, | ||
4429 | and recursivelly in all add-ins on which it depends. | ||
4430 | |||
4431 | This method throws an InvalidOperationException if the type can't be found. | ||
4432 | </remarks> | ||
4433 | </member> | ||
4434 | <member name="M:Mono.Addins.RuntimeAddin.GetType(System.String,System.Boolean)"> | ||
4435 | <summary> | ||
4436 | Gets a type defined in the add-in | ||
4437 | </summary> | ||
4438 | <param name="typeName"> | ||
4439 | Full name of the type | ||
4440 | </param> | ||
4441 | <param name="throwIfNotFound"> | ||
4442 | Indicates whether the method should throw an exception if the type can't be found. | ||
4443 | </param> | ||
4444 | <returns> | ||
4445 | A <see cref="T:System.Type"/> | ||
4446 | </returns> | ||
4447 | <remarks> | ||
4448 | The type will be looked up in the assemblies that implement the add-in, | ||
4449 | and recursivelly in all add-ins on which it depends. | ||
4450 | |||
4451 | If the type can't be found, this method throw a InvalidOperationException if | ||
4452 | 'throwIfNotFound' is 'true', or 'null' otherwise. | ||
4453 | </remarks> | ||
4454 | </member> | ||
4455 | <member name="M:Mono.Addins.RuntimeAddin.CreateInstance(System.String)"> | ||
4456 | <summary> | ||
4457 | Creates an instance of a type defined in the add-in | ||
4458 | </summary> | ||
4459 | <param name="typeName"> | ||
4460 | Name of the type. | ||
4461 | </param> | ||
4462 | <returns> | ||
4463 | A new instance of the type | ||
4464 | </returns> | ||
4465 | <remarks> | ||
4466 | The type will be looked up in the assemblies that implement the add-in, | ||
4467 | and recursivelly in all add-ins on which it depends. | ||
4468 | |||
4469 | This method throws an InvalidOperationException if the type can't be found. | ||
4470 | |||
4471 | The specified type must have a default constructor. | ||
4472 | </remarks> | ||
4473 | </member> | ||
4474 | <member name="M:Mono.Addins.RuntimeAddin.CreateInstance(System.String,System.Boolean)"> | ||
4475 | <summary> | ||
4476 | Creates an instance of a type defined in the add-in | ||
4477 | </summary> | ||
4478 | <param name="typeName"> | ||
4479 | Name of the type. | ||
4480 | </param> | ||
4481 | <param name="throwIfNotFound"> | ||
4482 | Indicates whether the method should throw an exception if the type can't be found. | ||
4483 | </param> | ||
4484 | <returns> | ||
4485 | A new instance of the type | ||
4486 | </returns> | ||
4487 | <remarks> | ||
4488 | The type will be looked up in the assemblies that implement the add-in, | ||
4489 | and recursivelly in all add-ins on which it depends. | ||
4490 | |||
4491 | If the type can't be found, this method throw a InvalidOperationException if | ||
4492 | 'throwIfNotFound' is 'true', or 'null' otherwise. | ||
4493 | |||
4494 | The specified type must have a default constructor. | ||
4495 | </remarks> | ||
4496 | </member> | ||
4497 | <member name="M:Mono.Addins.RuntimeAddin.GetFilePath(System.String)"> | ||
4498 | <summary> | ||
4499 | Gets the path of an add-in file | ||
4500 | </summary> | ||
4501 | <param name="fileName"> | ||
4502 | Relative path of the file | ||
4503 | </param> | ||
4504 | <returns> | ||
4505 | Full path of the file | ||
4506 | </returns> | ||
4507 | <remarks> | ||
4508 | This method can be used to get the full path of a data file deployed together with the add-in. | ||
4509 | </remarks> | ||
4510 | </member> | ||
4511 | <member name="M:Mono.Addins.RuntimeAddin.GetFilePath(System.String[])"> | ||
4512 | <summary> | ||
4513 | Gets the path of an add-in file | ||
4514 | </summary> | ||
4515 | <param name="filePath"> | ||
4516 | Components of the file path | ||
4517 | </param> | ||
4518 | <returns> | ||
4519 | Full path of the file | ||
4520 | </returns> | ||
4521 | <remarks> | ||
4522 | This method can be used to get the full path of a data file deployed together with the add-in. | ||
4523 | </remarks> | ||
4524 | </member> | ||
4525 | <member name="M:Mono.Addins.RuntimeAddin.GetResource(System.String)"> | ||
4526 | <summary> | ||
4527 | Gets the content of a resource | ||
4528 | </summary> | ||
4529 | <param name="resourceName"> | ||
4530 | Name of the resource | ||
4531 | </param> | ||
4532 | <returns> | ||
4533 | Content of the resource, or null if not found | ||
4534 | </returns> | ||
4535 | <remarks> | ||
4536 | The add-in engine will look for resources in the main add-in assembly and in all included add-in assemblies. | ||
4537 | </remarks> | ||
4538 | </member> | ||
4539 | <member name="M:Mono.Addins.RuntimeAddin.GetResource(System.String,System.Boolean)"> | ||
4540 | <summary> | ||
4541 | Gets the content of a resource | ||
4542 | </summary> | ||
4543 | <param name="resourceName"> | ||
4544 | Name of the resource | ||
4545 | </param> | ||
4546 | <param name="throwIfNotFound"> | ||
4547 | When set to true, an exception will be thrown if the resource is not found. | ||
4548 | </param> | ||
4549 | <returns> | ||
4550 | Content of the resource. | ||
4551 | </returns> | ||
4552 | <remarks> | ||
4553 | The add-in engine will look for resources in the main add-in assembly and in all included add-in assemblies. | ||
4554 | </remarks> | ||
4555 | </member> | ||
4556 | <member name="P:Mono.Addins.RuntimeAddin.Id"> | ||
4557 | <summary> | ||
4558 | Identifier of the add-in. | ||
4559 | </summary> | ||
4560 | </member> | ||
4561 | <member name="P:Mono.Addins.RuntimeAddin.Version"> | ||
4562 | <summary> | ||
4563 | Version of the add-in. | ||
4564 | </summary> | ||
4565 | </member> | ||
4566 | <member name="P:Mono.Addins.RuntimeAddin.PrivateDataPath"> | ||
4567 | <summary> | ||
4568 | Path to a directory where add-ins can store private configuration or status data | ||
4569 | </summary> | ||
4570 | </member> | ||
4571 | <member name="P:Mono.Addins.RuntimeAddin.Localizer"> | ||
4572 | <summary> | ||
4573 | Localizer which can be used to localize strings defined in this add-in | ||
4574 | </summary> | ||
4575 | </member> | ||
4576 | <member name="T:Mono.Addins.ImportAddinAssemblyAttribute"> | ||
4577 | <summary> | ||
4578 | Declares an add-in assembly import | ||
4579 | </summary> | ||
4580 | <remarks> | ||
4581 | An add-in may be composed by several assemblies and data files. | ||
4582 | Assemblies must be declared in the main assembly using this attribute, or in the XML manifest. | ||
4583 | |||
4584 | It is important to properly declare all files used by an add-in. | ||
4585 | For example, when a type from the add-in is required (e.g. an ICommand implementation), | ||
4586 | only properly declared assemblies will be checked. | ||
4587 | This information is also used by setup tools to know exactly what needs to be packaged when creating | ||
4588 | an add-in package, or to know what needs to be deleted when removing an add-in. | ||
4589 | </remarks> | ||
4590 | </member> | ||
4591 | <member name="M:Mono.Addins.ImportAddinAssemblyAttribute.#ctor(System.String)"> | ||
4592 | <summary> | ||
4593 | Initializes a new instance | ||
4594 | </summary> | ||
4595 | <param name="filePath"> | ||
4596 | Path to the assembly. Must be relative to the assembly declaring this attribute. | ||
4597 | </param> | ||
4598 | </member> | ||
4599 | <member name="P:Mono.Addins.ImportAddinAssemblyAttribute.FilePath"> | ||
4600 | <summary> | ||
4601 | Path to the assembly. Must be relative to the assembly declaring this attribute. | ||
4602 | </summary> | ||
4603 | </member> | ||
4604 | <member name="P:Mono.Addins.ImportAddinAssemblyAttribute.Scan"> | ||
4605 | <summary> | ||
4606 | When set to true (the default), the included assembly will be scanned | ||
4607 | looking for extension point declarations. | ||
4608 | </summary> | ||
4609 | </member> | ||
4610 | <member name="T:Mono.Addins.AddinErrorEventHandler"> | ||
4611 | <summary> | ||
4612 | Delegate to be used in add-in error subscriptions | ||
4613 | </summary> | ||
4614 | </member> | ||
4615 | <member name="T:Mono.Addins.AddinErrorEventArgs"> | ||
4616 | <summary> | ||
4617 | Provides information about an add-in loading error. | ||
4618 | </summary> | ||
4619 | </member> | ||
4620 | <member name="M:Mono.Addins.AddinErrorEventArgs.#ctor(System.String,System.String,System.Exception)"> | ||
4621 | <summary> | ||
4622 | Initializes a new instance of the <see cref="T:Mono.Addins.AddinErrorEventArgs"/> class. | ||
4623 | </summary> | ||
4624 | <param name="message"> | ||
4625 | Error message | ||
4626 | </param> | ||
4627 | <param name="addinId"> | ||
4628 | Add-in identifier. | ||
4629 | </param> | ||
4630 | <param name="exception"> | ||
4631 | Exception that caused the error. | ||
4632 | </param> | ||
4633 | </member> | ||
4634 | <member name="P:Mono.Addins.AddinErrorEventArgs.Exception"> | ||
4635 | <summary> | ||
4636 | Exception that caused the error. | ||
4637 | </summary> | ||
4638 | </member> | ||
4639 | <member name="P:Mono.Addins.AddinErrorEventArgs.Message"> | ||
4640 | <summary> | ||
4641 | Error message | ||
4642 | </summary> | ||
4643 | </member> | ||
4644 | <member name="T:Mono.Addins.Addin"> | ||
4645 | <summary> | ||
4646 | An add-in. | ||
4647 | </summary> | ||
4648 | </member> | ||
4649 | <member name="M:Mono.Addins.Addin.SupportsVersion(System.String)"> | ||
4650 | <summary> | ||
4651 | Checks version compatibility. | ||
4652 | </summary> | ||
4653 | <param name="version"> | ||
4654 | An add-in version. | ||
4655 | </param> | ||
4656 | <returns> | ||
4657 | True if the provided version is compatible with this add-in. | ||
4658 | </returns> | ||
4659 | <remarks> | ||
4660 | This method checks the CompatVersion property to know if the provided version is compatible with the version of this add-in. | ||
4661 | </remarks> | ||
4662 | </member> | ||
4663 | <member name="M:Mono.Addins.Addin.ToString"> | ||
4664 | <summary> | ||
4665 | Returns a <see cref="T:System.String"/> that represents the current <see cref="T:Mono.Addins.Addin"/>. | ||
4666 | </summary> | ||
4667 | <returns> | ||
4668 | A <see cref="T:System.String"/> that represents the current <see cref="T:Mono.Addins.Addin"/>. | ||
4669 | </returns> | ||
4670 | </member> | ||
4671 | <member name="M:Mono.Addins.Addin.CompareVersions(System.String,System.String)"> | ||
4672 | <summary> | ||
4673 | Compares two add-in versions | ||
4674 | </summary> | ||
4675 | <returns> | ||
4676 | -1 if v1 is greater than v2, 0 if v1 == v2, 1 if v1 less than v2 | ||
4677 | </returns> | ||
4678 | <param name='v1'> | ||
4679 | A version | ||
4680 | </param> | ||
4681 | <param name='v2'> | ||
4682 | A version | ||
4683 | </param> | ||
4684 | </member> | ||
4685 | <member name="M:Mono.Addins.Addin.GetFullId(System.String,System.String,System.String)"> | ||
4686 | <summary> | ||
4687 | Returns the identifier of an add-in | ||
4688 | </summary> | ||
4689 | <returns> | ||
4690 | The full identifier. | ||
4691 | </returns> | ||
4692 | <param name='ns'> | ||
4693 | Namespace of the add-in | ||
4694 | </param> | ||
4695 | <param name='id'> | ||
4696 | Name of the add-in | ||
4697 | </param> | ||
4698 | <param name='version'> | ||
4699 | Version of the add-in | ||
4700 | </param> | ||
4701 | </member> | ||
4702 | <member name="M:Mono.Addins.Addin.GetIdName(System.String)"> | ||
4703 | <summary> | ||
4704 | Given a full add-in identifier, returns the namespace and name of the add-in (it removes the version number) | ||
4705 | </summary> | ||
4706 | <param name='addinId'> | ||
4707 | Add-in identifier. | ||
4708 | </param> | ||
4709 | </member> | ||
4710 | <member name="M:Mono.Addins.Addin.GetIdVersion(System.String)"> | ||
4711 | <summary> | ||
4712 | Given a full add-in identifier, returns the version the add-in | ||
4713 | </summary> | ||
4714 | <returns> | ||
4715 | The version. | ||
4716 | </returns> | ||
4717 | </member> | ||
4718 | <member name="M:Mono.Addins.Addin.GetIdParts(System.String,System.String@,System.String@)"> | ||
4719 | <summary> | ||
4720 | Splits a full add-in identifier in name and version | ||
4721 | </summary> | ||
4722 | <param name='addinId'> | ||
4723 | Add-in identifier. | ||
4724 | </param> | ||
4725 | <param name='name'> | ||
4726 | The resulting name | ||
4727 | </param> | ||
4728 | <param name='version'> | ||
4729 | The resulting version | ||
4730 | </param> | ||
4731 | </member> | ||
4732 | <member name="P:Mono.Addins.Addin.Id"> | ||
4733 | <summary> | ||
4734 | Full identifier of the add-in, including namespace and version. | ||
4735 | </summary> | ||
4736 | </member> | ||
4737 | <member name="P:Mono.Addins.Addin.Namespace"> | ||
4738 | <summary> | ||
4739 | Namespace of the add-in. | ||
4740 | </summary> | ||
4741 | </member> | ||
4742 | <member name="P:Mono.Addins.Addin.LocalId"> | ||
4743 | <summary> | ||
4744 | Identifier of the add-in (without namespace) | ||
4745 | </summary> | ||
4746 | </member> | ||
4747 | <member name="P:Mono.Addins.Addin.Version"> | ||
4748 | <summary> | ||
4749 | Version of the add-in | ||
4750 | </summary> | ||
4751 | </member> | ||
4752 | <member name="P:Mono.Addins.Addin.Name"> | ||
4753 | <summary> | ||
4754 | Display name of the add-in | ||
4755 | </summary> | ||
4756 | </member> | ||
4757 | <member name="P:Mono.Addins.Addin.Properties"> | ||
4758 | <summary> | ||
4759 | Custom properties specified in the add-in header | ||
4760 | </summary> | ||
4761 | </member> | ||
4762 | <member name="P:Mono.Addins.Addin.Enabled"> | ||
4763 | <summary> | ||
4764 | Gets or sets the enabled status of the add-in. | ||
4765 | </summary> | ||
4766 | <remarks> | ||
4767 | This property can be used to enable or disable an add-in. | ||
4768 | The enabled status of an add-in is stored in the add-in registry, | ||
4769 | so when an add-in is disabled, it will be disabled for all applications | ||
4770 | sharing the same registry. | ||
4771 | When an add-in is enabled or disabled, the extension points currently loaded | ||
4772 | in memory will be properly updated to include or exclude extensions from the add-in. | ||
4773 | </remarks> | ||
4774 | </member> | ||
4775 | <member name="P:Mono.Addins.Addin.IsUserAddin"> | ||
4776 | <summary> | ||
4777 | Returns 'true' if the add-in is installed in the user's personal folder | ||
4778 | </summary> | ||
4779 | </member> | ||
4780 | <member name="P:Mono.Addins.Addin.AddinFile"> | ||
4781 | <summary> | ||
4782 | Path to the add-in file (it can be an assembly or a standalone XML manifest) | ||
4783 | </summary> | ||
4784 | </member> | ||
4785 | <member name="P:Mono.Addins.Addin.Description"> | ||
4786 | <summary> | ||
4787 | Description of the add-in | ||
4788 | </summary> | ||
4789 | </member> | ||
4790 | <member name="T:Mono.Addins.Description.ConditionTypeDescriptionCollection"> | ||
4791 | <summary> | ||
4792 | A collection of condition types | ||
4793 | </summary> | ||
4794 | </member> | ||
4795 | <member name="M:Mono.Addins.Description.ConditionTypeDescriptionCollection.#ctor"> | ||
4796 | <summary> | ||
4797 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.ConditionTypeDescriptionCollection"/> class. | ||
4798 | </summary> | ||
4799 | </member> | ||
4800 | <member name="P:Mono.Addins.Description.ConditionTypeDescriptionCollection.Item(System.Int32)"> | ||
4801 | <summary> | ||
4802 | Gets the <see cref="T:Mono.Addins.Description.ConditionTypeDescription"/> at the specified index. | ||
4803 | </summary> | ||
4804 | <param name="n"> | ||
4805 | Index. | ||
4806 | </param> | ||
4807 | <returns> | ||
4808 | The condition. | ||
4809 | </returns> | ||
4810 | </member> | ||
4811 | <member name="T:Mono.Addins.Description.ModuleCollection"> | ||
4812 | <summary> | ||
4813 | A collection of module descriptions | ||
4814 | </summary> | ||
4815 | </member> | ||
4816 | <member name="M:Mono.Addins.Description.ModuleCollection.#ctor"> | ||
4817 | <summary> | ||
4818 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.ModuleCollection"/> class. | ||
4819 | </summary> | ||
4820 | </member> | ||
4821 | <member name="P:Mono.Addins.Description.ModuleCollection.Item(System.Int32)"> | ||
4822 | <summary> | ||
4823 | Gets the <see cref="T:Mono.Addins.Description.ModuleDescription"/> at the specified index. | ||
4824 | </summary> | ||
4825 | <param name="n"> | ||
4826 | The index. | ||
4827 | </param> | ||
4828 | </member> | ||
4829 | <member name="T:Mono.Addins.Description.NodeTypeAttributeCollection"> | ||
4830 | <summary> | ||
4831 | A collection of node attributes | ||
4832 | </summary> | ||
4833 | </member> | ||
4834 | <member name="M:Mono.Addins.Description.NodeTypeAttributeCollection.#ctor"> | ||
4835 | <summary> | ||
4836 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.NodeTypeAttributeCollection"/> class. | ||
4837 | </summary> | ||
4838 | </member> | ||
4839 | <member name="P:Mono.Addins.Description.NodeTypeAttributeCollection.Item(System.Int32)"> | ||
4840 | <summary> | ||
4841 | Gets the <see cref="T:Mono.Addins.Description.NodeTypeAttribute"/> at the specified index. | ||
4842 | </summary> | ||
4843 | <param name="n"> | ||
4844 | The index. | ||
4845 | </param> | ||
4846 | </member> | ||
4847 | <member name="T:Mono.Addins.Description.AssemblyDependency"> | ||
4848 | <summary> | ||
4849 | Definition of a dependency of an add-in on an assembly. | ||
4850 | </summary> | ||
4851 | </member> | ||
4852 | <member name="M:Mono.Addins.Description.AssemblyDependency.#ctor"> | ||
4853 | <summary> | ||
4854 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.AssemblyDependency"/> class. | ||
4855 | </summary> | ||
4856 | </member> | ||
4857 | <member name="P:Mono.Addins.Description.AssemblyDependency.FullName"> | ||
4858 | <summary> | ||
4859 | Gets or sets the full name of the assembly | ||
4860 | </summary> | ||
4861 | <value> | ||
4862 | The full name of the assembly. | ||
4863 | </value> | ||
4864 | </member> | ||
4865 | <member name="P:Mono.Addins.Description.AssemblyDependency.Package"> | ||
4866 | <summary> | ||
4867 | Gets or sets the name of the package that provides the assembly. | ||
4868 | </summary> | ||
4869 | <value> | ||
4870 | The name of the package that provides the assembly. | ||
4871 | </value> | ||
4872 | </member> | ||
4873 | <member name="P:Mono.Addins.Description.AssemblyDependency.Name"> | ||
4874 | <summary> | ||
4875 | Display name of the dependency | ||
4876 | </summary> | ||
4877 | <value> | ||
4878 | The name. | ||
4879 | </value> | ||
4880 | </member> | ||
4881 | <member name="T:Mono.Addins.AddinModuleAttribute"> | ||
4882 | <summary> | ||
4883 | Declares an optional add-in module | ||
4884 | </summary> | ||
4885 | </member> | ||
4886 | <member name="M:Mono.Addins.AddinModuleAttribute.#ctor(System.String)"> | ||
4887 | <summary> | ||
4888 | Initializes the instance. | ||
4889 | </summary> | ||
4890 | <param name="assemblyFile"> | ||
4891 | Relative path to the assembly that implements the optional module | ||
4892 | </param> | ||
4893 | </member> | ||
4894 | <member name="P:Mono.Addins.AddinModuleAttribute.AssemblyFile"> | ||
4895 | <summary> | ||
4896 | Relative path to the assembly that implements the optional module | ||
4897 | </summary> | ||
4898 | </member> | ||
4899 | <member name="T:Mono.Addins.AddinRegistry"> | ||
4900 | <summary> | ||
4901 | An add-in registry. | ||
4902 | </summary> | ||
4903 | <remarks> | ||
4904 | An add-in registry is a data structure used by the add-in engine to locate add-ins to load. | ||
4905 | |||
4906 | A registry can be configured to look for add-ins in several directories. However, add-ins | ||
4907 | copied to those directories won't be detected until an explicit add-in scan is requested. | ||
4908 | The registry can be updated by an application by calling Registry.Update(), or by a user by | ||
4909 | running the 'mautil' add-in setup tool. | ||
4910 | |||
4911 | The registry has information about the location of every add-in and a timestamp of the last | ||
4912 | check, so the Update method will only scan new or modified add-ins. An application can | ||
4913 | add a call to Registry.Update() in the Main method to detect all new add-ins every time the | ||
4914 | app is started. | ||
4915 | |||
4916 | Every add-in added to the registry is parsed and validated, and if there is any error it | ||
4917 | will be rejected. The registry is also in charge of scanning the add-in assemblies and look | ||
4918 | for extensions and other information declared using custom attributes. That information is | ||
4919 | merged with the manifest information (if there is one) to create a complete add-in | ||
4920 | description ready to be used at run-time. | ||
4921 | |||
4922 | Mono.Addins allows sharing an add-in registry among several applications. In this context, | ||
4923 | all applications sharing the registry share the same extension point model, and it is | ||
4924 | possible to implement add-ins which extend several hosts. | ||
4925 | </remarks> | ||
4926 | </member> | ||
4927 | <member name="M:Mono.Addins.AddinRegistry.#ctor(System.String)"> | ||
4928 | <summary> | ||
4929 | Initializes a new instance. | ||
4930 | </summary> | ||
4931 | <param name="registryPath"> | ||
4932 | Location of the add-in registry. | ||
4933 | </param> | ||
4934 | <remarks> | ||
4935 | Creates a new add-in registry located in the provided path. | ||
4936 | The add-in registry will look for add-ins in an 'addins' | ||
4937 | subdirectory of the provided registryPath. | ||
4938 | |||
4939 | When specifying a path, it is possible to use a special folder name as root. | ||
4940 | For example: [Personal]/.config/MyApp. In this case, [Personal] will be replaced | ||
4941 | by the location of the Environment.SpecialFolder.Personal folder. Any value | ||
4942 | of the Environment.SpecialFolder enumeration can be used (always between square | ||
4943 | brackets) | ||
4944 | </remarks> | ||
4945 | </member> | ||
4946 | <member name="M:Mono.Addins.AddinRegistry.#ctor(System.String,System.String)"> | ||
4947 | <summary> | ||
4948 | Initializes a new instance. | ||
4949 | </summary> | ||
4950 | <param name="registryPath"> | ||
4951 | Location of the add-in registry. | ||
4952 | </param> | ||
4953 | <param name="startupDirectory"> | ||
4954 | Location of the application. | ||
4955 | </param> | ||
4956 | <remarks> | ||
4957 | Creates a new add-in registry located in the provided path. | ||
4958 | The add-in registry will look for add-ins in an 'addins' | ||
4959 | subdirectory of the provided registryPath. | ||
4960 | |||
4961 | When specifying a path, it is possible to use a special folder name as root. | ||
4962 | For example: [Personal]/.config/MyApp. In this case, [Personal] will be replaced | ||
4963 | by the location of the Environment.SpecialFolder.Personal folder. Any value | ||
4964 | of the Environment.SpecialFolder enumeration can be used (always between square | ||
4965 | brackets) | ||
4966 | </remarks> | ||
4967 | </member> | ||
4968 | <member name="M:Mono.Addins.AddinRegistry.#ctor(System.String,System.String,System.String)"> | ||
4969 | <summary> | ||
4970 | Initializes a new instance of the <see cref="T:Mono.Addins.AddinRegistry"/> class. | ||
4971 | </summary> | ||
4972 | <param name="registryPath"> | ||
4973 | Location of the add-in registry. | ||
4974 | </param> | ||
4975 | <param name="startupDirectory"> | ||
4976 | Location of the application. | ||
4977 | </param> | ||
4978 | <param name="addinsDir"> | ||
4979 | Add-ins directory. If the path is relative, it is considered to be relative | ||
4980 | to the configDir directory. | ||
4981 | </param> | ||
4982 | <remarks> | ||
4983 | Creates a new add-in registry located in the provided path. | ||
4984 | Configuration information about the add-in registry will be stored in | ||
4985 | 'registryPath'. The add-in registry will look for add-ins in the provided | ||
4986 | 'addinsDir' directory. | ||
4987 | |||
4988 | When specifying a path, it is possible to use a special folder name as root. | ||
4989 | For example: [Personal]/.config/MyApp. In this case, [Personal] will be replaced | ||
4990 | by the location of the Environment.SpecialFolder.Personal folder. Any value | ||
4991 | of the Environment.SpecialFolder enumeration can be used (always between square | ||
4992 | brackets) | ||
4993 | </remarks> | ||
4994 | </member> | ||
4995 | <member name="M:Mono.Addins.AddinRegistry.#ctor(System.String,System.String,System.String,System.String)"> | ||
4996 | <summary> | ||
4997 | Initializes a new instance of the <see cref="T:Mono.Addins.AddinRegistry"/> class. | ||
4998 | </summary> | ||
4999 | <param name="registryPath"> | ||
5000 | Location of the add-in registry. | ||
5001 | </param> | ||
5002 | <param name="startupDirectory"> | ||
5003 | Location of the application. | ||
5004 | </param> | ||
5005 | <param name="addinsDir"> | ||
5006 | Add-ins directory. If the path is relative, it is considered to be relative | ||
5007 | to the configDir directory. | ||
5008 | </param> | ||
5009 | <param name="databaseDir"> | ||
5010 | Location of the add-in database. If the path is relative, it is considered to be relative | ||
5011 | to the configDir directory. | ||
5012 | </param> | ||
5013 | <remarks> | ||
5014 | Creates a new add-in registry located in the provided path. | ||
5015 | Configuration information about the add-in registry will be stored in | ||
5016 | 'registryPath'. The add-in registry will look for add-ins in the provided | ||
5017 | 'addinsDir' directory. Cached information about add-ins will be stored in | ||
5018 | the 'databaseDir' directory. | ||
5019 | |||
5020 | When specifying a path, it is possible to use a special folder name as root. | ||
5021 | For example: [Personal]/.config/MyApp. In this case, [Personal] will be replaced | ||
5022 | by the location of the Environment.SpecialFolder.Personal folder. Any value | ||
5023 | of the Environment.SpecialFolder enumeration can be used (always between square | ||
5024 | brackets) | ||
5025 | </remarks> | ||
5026 | </member> | ||
5027 | <member name="M:Mono.Addins.AddinRegistry.GetGlobalRegistry"> | ||
5028 | <summary> | ||
5029 | Gets the global registry. | ||
5030 | </summary> | ||
5031 | <returns> | ||
5032 | The global registry | ||
5033 | </returns> | ||
5034 | <remarks> | ||
5035 | The global add-in registry is created in "~/.config/mono.addins", | ||
5036 | and it is the default registry used when none is specified. | ||
5037 | </remarks> | ||
5038 | </member> | ||
5039 | <member name="M:Mono.Addins.AddinRegistry.Dispose"> | ||
5040 | <summary> | ||
5041 | Disposes the add-in engine. | ||
5042 | </summary> | ||
5043 | </member> | ||
5044 | <member name="M:Mono.Addins.AddinRegistry.GetAddin(System.String)"> | ||
5045 | <summary> | ||
5046 | Returns an add-in from the registry. | ||
5047 | </summary> | ||
5048 | <param name="id"> | ||
5049 | Identifier of the add-in. | ||
5050 | </param> | ||
5051 | <returns> | ||
5052 | The add-in, or 'null' if not found. | ||
5053 | </returns> | ||
5054 | <remarks> | ||
5055 | The add-in identifier may optionally include a version number, for example: "TextEditor.Xml,1.2" | ||
5056 | </remarks> | ||
5057 | </member> | ||
5058 | <member name="M:Mono.Addins.AddinRegistry.GetAddin(System.String,System.Boolean)"> | ||
5059 | <summary> | ||
5060 | Returns an add-in from the registry. | ||
5061 | </summary> | ||
5062 | <param name="id"> | ||
5063 | Identifier of the add-in. | ||
5064 | </param> | ||
5065 | <param name="exactVersionMatch"> | ||
5066 | 'true' if the exact add-in version must be found. | ||
5067 | </param> | ||
5068 | <returns> | ||
5069 | The add-in, or 'null' if not found. | ||
5070 | </returns> | ||
5071 | <remarks> | ||
5072 | The add-in identifier may optionally include a version number, for example: "TextEditor.Xml,1.2". | ||
5073 | In this case, if the exact version is not found and exactVersionMatch is 'false', it will | ||
5074 | return one than is compatible with the required version. | ||
5075 | </remarks> | ||
5076 | </member> | ||
5077 | <member name="M:Mono.Addins.AddinRegistry.GetModules(Mono.Addins.AddinSearchFlags)"> | ||
5078 | <summary> | ||
5079 | Gets all add-ins or add-in roots registered in the registry. | ||
5080 | </summary> | ||
5081 | <returns> | ||
5082 | The addins. | ||
5083 | </returns> | ||
5084 | <param name='flags'> | ||
5085 | Flags. | ||
5086 | </param> | ||
5087 | </member> | ||
5088 | <member name="M:Mono.Addins.AddinRegistry.GetAddins"> | ||
5089 | <summary> | ||
5090 | Gets all add-ins registered in the registry. | ||
5091 | </summary> | ||
5092 | <returns> | ||
5093 | Add-ins registered in the registry. | ||
5094 | </returns> | ||
5095 | </member> | ||
5096 | <member name="M:Mono.Addins.AddinRegistry.GetAddinRoots"> | ||
5097 | <summary> | ||
5098 | Gets all add-in roots registered in the registry. | ||
5099 | </summary> | ||
5100 | <returns> | ||
5101 | Descriptions of all add-in roots. | ||
5102 | </returns> | ||
5103 | </member> | ||
5104 | <member name="M:Mono.Addins.AddinRegistry.GetAddinDescription(Mono.Addins.IProgressStatus,System.String)"> | ||
5105 | <summary> | ||
5106 | Loads an add-in description | ||
5107 | </summary> | ||
5108 | <param name="progressStatus"> | ||
5109 | Progress tracker. | ||
5110 | </param> | ||
5111 | <param name="file"> | ||
5112 | Name of the file to load | ||
5113 | </param> | ||
5114 | <returns> | ||
5115 | An add-in description | ||
5116 | </returns> | ||
5117 | <remarks> | ||
5118 | This method loads an add-in description from a file. The file can be an XML manifest or an | ||
5119 | assembly that implements an add-in. | ||
5120 | </remarks> | ||
5121 | </member> | ||
5122 | <member name="M:Mono.Addins.AddinRegistry.ReadAddinManifestFile(System.String)"> | ||
5123 | <summary> | ||
5124 | Reads an XML add-in manifest | ||
5125 | </summary> | ||
5126 | <param name="file"> | ||
5127 | Path to the XML file | ||
5128 | </param> | ||
5129 | <returns> | ||
5130 | An add-in description | ||
5131 | </returns> | ||
5132 | </member> | ||
5133 | <member name="M:Mono.Addins.AddinRegistry.ReadAddinManifestFile(System.IO.TextReader,System.String)"> | ||
5134 | <summary> | ||
5135 | Reads an XML add-in manifest | ||
5136 | </summary> | ||
5137 | <param name="reader"> | ||
5138 | Reader that contains the XML | ||
5139 | </param> | ||
5140 | <param name="baseFile"> | ||
5141 | Base path to use to discover add-in files | ||
5142 | </param> | ||
5143 | <returns> | ||
5144 | An add-in description | ||
5145 | </returns> | ||
5146 | </member> | ||
5147 | <member name="M:Mono.Addins.AddinRegistry.IsAddinEnabled(System.String)"> | ||
5148 | <summary> | ||
5149 | Checks whether an add-in is enabled. | ||
5150 | </summary> | ||
5151 | <param name="id"> | ||
5152 | Identifier of the add-in. | ||
5153 | </param> | ||
5154 | <returns> | ||
5155 | 'true' if the add-in is enabled. | ||
5156 | </returns> | ||
5157 | </member> | ||
5158 | <member name="M:Mono.Addins.AddinRegistry.EnableAddin(System.String)"> | ||
5159 | <summary> | ||
5160 | Enables an add-in. | ||
5161 | </summary> | ||
5162 | <param name="id"> | ||
5163 | Identifier of the add-in | ||
5164 | </param> | ||
5165 | <remarks> | ||
5166 | If the enabled add-in depends on other add-ins which are disabled, | ||
5167 | those will automatically be enabled too. | ||
5168 | </remarks> | ||
5169 | </member> | ||
5170 | <member name="M:Mono.Addins.AddinRegistry.DisableAddin(System.String)"> | ||
5171 | <summary> | ||
5172 | Disables an add-in. | ||
5173 | </summary> | ||
5174 | <param name="id"> | ||
5175 | Identifier of the add-in. | ||
5176 | </param> | ||
5177 | <remarks> | ||
5178 | When an add-in is disabled, all extension points it defines will be ignored | ||
5179 | by the add-in engine. Other add-ins which depend on the disabled add-in will | ||
5180 | also automatically be disabled. | ||
5181 | </remarks> | ||
5182 | </member> | ||
5183 | <member name="M:Mono.Addins.AddinRegistry.RegisterForUninstall(System.String,System.Collections.Generic.IEnumerable{System.String})"> | ||
5184 | <summary> | ||
5185 | Registers a set of add-ins for uninstallation. | ||
5186 | </summary> | ||
5187 | <param name='id'> | ||
5188 | Identifier of the add-in | ||
5189 | </param> | ||
5190 | <param name='files'> | ||
5191 | Files to be uninstalled | ||
5192 | </param> | ||
5193 | <remarks> | ||
5194 | This method can be used to instruct the add-in manager to uninstall | ||
5195 | an add-in the next time the registry is updated. This is useful | ||
5196 | when an add-in manager can't delete an add-in because if it is | ||
5197 | loaded. | ||
5198 | </remarks> | ||
5199 | </member> | ||
5200 | <member name="M:Mono.Addins.AddinRegistry.IsRegisteredForUninstall(System.String)"> | ||
5201 | <summary> | ||
5202 | Determines whether an add-in is registered for uninstallation | ||
5203 | </summary> | ||
5204 | <returns> | ||
5205 | <c>true</c> if the add-in is registered for uninstallation | ||
5206 | </returns> | ||
5207 | <param name='addinId'> | ||
5208 | Identifier of the add-in | ||
5209 | </param> | ||
5210 | </member> | ||
5211 | <member name="M:Mono.Addins.AddinRegistry.DumpFile(System.String)"> | ||
5212 | <summary> | ||
5213 | Internal use only | ||
5214 | </summary> | ||
5215 | </member> | ||
5216 | <member name="M:Mono.Addins.AddinRegistry.ResetConfiguration"> | ||
5217 | <summary> | ||
5218 | Resets the configuration files of the registry | ||
5219 | </summary> | ||
5220 | </member> | ||
5221 | <member name="M:Mono.Addins.AddinRegistry.Update"> | ||
5222 | <summary> | ||
5223 | Updates the add-in registry. | ||
5224 | </summary> | ||
5225 | <remarks> | ||
5226 | This method must be called after modifying, installing or uninstalling add-ins. | ||
5227 | |||
5228 | When calling Update, every add-in added to the registry is parsed and validated, | ||
5229 | and if there is any error it will be rejected. It will also cache add-in information | ||
5230 | needed at run-time. | ||
5231 | |||
5232 | If during the update operation the registry finds new add-ins or detects that some | ||
5233 | add-ins have been deleted, the loaded extension points will be updated to include | ||
5234 | or exclude extension nodes from those add-ins. | ||
5235 | </remarks> | ||
5236 | </member> | ||
5237 | <member name="M:Mono.Addins.AddinRegistry.Update(Mono.Addins.IProgressStatus)"> | ||
5238 | <summary> | ||
5239 | Updates the add-in registry. | ||
5240 | </summary> | ||
5241 | <param name="monitor"> | ||
5242 | Progress monitor to keep track of the update operation. | ||
5243 | </param> | ||
5244 | <remarks> | ||
5245 | This method must be called after modifying, installing or uninstalling add-ins. | ||
5246 | |||
5247 | When calling Update, every add-in added to the registry is parsed and validated, | ||
5248 | and if there is any error it will be rejected. It will also cache add-in information | ||
5249 | needed at run-time. | ||
5250 | |||
5251 | If during the update operation the registry finds new add-ins or detects that some | ||
5252 | add-ins have been deleted, the loaded extension points will be updated to include | ||
5253 | or exclude extension nodes from those add-ins. | ||
5254 | </remarks> | ||
5255 | </member> | ||
5256 | <member name="M:Mono.Addins.AddinRegistry.Rebuild(Mono.Addins.IProgressStatus)"> | ||
5257 | <summary> | ||
5258 | Regenerates the cached data of the add-in registry. | ||
5259 | </summary> | ||
5260 | <param name="monitor"> | ||
5261 | Progress monitor to keep track of the rebuild operation. | ||
5262 | </param> | ||
5263 | </member> | ||
5264 | <member name="M:Mono.Addins.AddinRegistry.RegisterExtension(System.Object)"> | ||
5265 | <summary> | ||
5266 | Registers an extension. Only AddinFileSystemExtension extensions are supported right now. | ||
5267 | </summary> | ||
5268 | <param name='extension'> | ||
5269 | The extension to register | ||
5270 | </param> | ||
5271 | </member> | ||
5272 | <member name="M:Mono.Addins.AddinRegistry.UnregisterExtension(System.Object)"> | ||
5273 | <summary> | ||
5274 | Unregisters an extension. | ||
5275 | </summary> | ||
5276 | <param name='extension'> | ||
5277 | The extension to unregister | ||
5278 | </param> | ||
5279 | </member> | ||
5280 | <member name="P:Mono.Addins.AddinRegistry.RegistryPath"> | ||
5281 | <summary> | ||
5282 | Location of the add-in registry. | ||
5283 | </summary> | ||
5284 | </member> | ||
5285 | <member name="P:Mono.Addins.AddinRegistry.HasPendingUninstalls"> | ||
5286 | <summary> | ||
5287 | Gets a value indicating whether there are pending add-ins to be uninstalled installed | ||
5288 | </summary> | ||
5289 | </member> | ||
5290 | <member name="P:Mono.Addins.AddinRegistry.DefaultAddinsFolder"> | ||
5291 | <summary> | ||
5292 | Gets the default add-ins folder of the registry. | ||
5293 | </summary> | ||
5294 | <remarks> | ||
5295 | For every add-in registry there is an add-in folder where the registry will look for add-ins by default. | ||
5296 | This folder is an "addins" subdirectory of the directory where the repository is located. In most cases, | ||
5297 | this folder will only contain .addins files referencing other more convenient locations for add-ins. | ||
5298 | </remarks> | ||
5299 | </member> | ||
5300 | <member name="T:Mono.Addins.AddinSearchFlags"> | ||
5301 | <summary> | ||
5302 | Addin search flags. | ||
5303 | </summary> | ||
5304 | </member> | ||
5305 | <member name="F:Mono.Addins.AddinSearchFlags.IncludeAddins"> | ||
5306 | <summary> | ||
5307 | Add-ins are included in the search | ||
5308 | </summary> | ||
5309 | </member> | ||
5310 | <member name="F:Mono.Addins.AddinSearchFlags.IncludeRoots"> | ||
5311 | <summary> | ||
5312 | Add-in roots are included in the search | ||
5313 | </summary> | ||
5314 | </member> | ||
5315 | <member name="F:Mono.Addins.AddinSearchFlags.IncludeAll"> | ||
5316 | <summary> | ||
5317 | Both add-in and add-in roots are included in the search | ||
5318 | </summary> | ||
5319 | </member> | ||
5320 | <member name="F:Mono.Addins.AddinSearchFlags.LatestVersionsOnly"> | ||
5321 | <summary> | ||
5322 | Only the latest version of every add-in or add-in root is included in the search | ||
5323 | </summary> | ||
5324 | </member> | ||
5325 | <member name="T:Mono.Addins.ConsoleProgressStatus"> | ||
5326 | <summary> | ||
5327 | An IProgressStatus class which writes output to the console. | ||
5328 | </summary> | ||
5329 | </member> | ||
5330 | <member name="T:Mono.Addins.IProgressStatus"> | ||
5331 | <summary> | ||
5332 | Progress status listener. | ||
5333 | </summary> | ||
5334 | </member> | ||
5335 | <member name="M:Mono.Addins.IProgressStatus.SetMessage(System.String)"> | ||
5336 | <summary> | ||
5337 | Sets the description of the current operation. | ||
5338 | </summary> | ||
5339 | <param name="msg"> | ||
5340 | A message | ||
5341 | </param> | ||
5342 | <remarks> | ||
5343 | This method is called by the add-in engine to show a description of the operation being monitorized. | ||
5344 | </remarks> | ||
5345 | </member> | ||
5346 | <member name="M:Mono.Addins.IProgressStatus.SetProgress(System.Double)"> | ||
5347 | <summary> | ||
5348 | Sets the progress of the operation. | ||
5349 | </summary> | ||
5350 | <param name="progress"> | ||
5351 | A number between 0 and 1. 0 means no progress, 1 means operation completed. | ||
5352 | </param> | ||
5353 | <remarks> | ||
5354 | This method is called by the add-in engine to show the progress of the operation being monitorized. | ||
5355 | </remarks> | ||
5356 | </member> | ||
5357 | <member name="M:Mono.Addins.IProgressStatus.Log(System.String)"> | ||
5358 | <summary> | ||
5359 | Writes text to the log. | ||
5360 | </summary> | ||
5361 | <param name="msg"> | ||
5362 | Message to write | ||
5363 | </param> | ||
5364 | </member> | ||
5365 | <member name="M:Mono.Addins.IProgressStatus.ReportWarning(System.String)"> | ||
5366 | <summary> | ||
5367 | Reports a warning. | ||
5368 | </summary> | ||
5369 | <param name="message"> | ||
5370 | Warning message | ||
5371 | </param> | ||
5372 | <remarks> | ||
5373 | This method is called by the add-in engine to report a warning in the operation being monitorized. | ||
5374 | </remarks> | ||
5375 | </member> | ||
5376 | <member name="M:Mono.Addins.IProgressStatus.ReportError(System.String,System.Exception)"> | ||
5377 | <summary> | ||
5378 | Reports an error. | ||
5379 | </summary> | ||
5380 | <param name="message"> | ||
5381 | Error message | ||
5382 | </param> | ||
5383 | <param name="exception"> | ||
5384 | Exception that caused the error. It can be null. | ||
5385 | </param> | ||
5386 | <remarks> | ||
5387 | This method is called by the add-in engine to report an error occurred while executing the operation being monitorized. | ||
5388 | </remarks> | ||
5389 | </member> | ||
5390 | <member name="M:Mono.Addins.IProgressStatus.Cancel"> | ||
5391 | <summary> | ||
5392 | Cancels the operation being montorized. | ||
5393 | </summary> | ||
5394 | </member> | ||
5395 | <member name="P:Mono.Addins.IProgressStatus.LogLevel"> | ||
5396 | <summary> | ||
5397 | Log level requested by the user: 0: no log, 1: normal log, >1 verbose log | ||
5398 | </summary> | ||
5399 | </member> | ||
5400 | <member name="P:Mono.Addins.IProgressStatus.IsCanceled"> | ||
5401 | <summary> | ||
5402 | Returns True when the user requested to cancel this operation | ||
5403 | </summary> | ||
5404 | </member> | ||
5405 | <member name="M:Mono.Addins.ConsoleProgressStatus.#ctor(System.Boolean)"> | ||
5406 | <summary> | ||
5407 | Initializes a new instance | ||
5408 | </summary> | ||
5409 | <param name="verboseLog"> | ||
5410 | Set to true to enabled verbose log | ||
5411 | </param> | ||
5412 | </member> | ||
5413 | <member name="M:Mono.Addins.ConsoleProgressStatus.#ctor(System.Int32)"> | ||
5414 | <summary> | ||
5415 | Initializes a new instance | ||
5416 | </summary> | ||
5417 | <param name="logLevel"> | ||
5418 | Verbosity level. 0: not verbose, 1: normal, >1 extra verbose | ||
5419 | </param> | ||
5420 | </member> | ||
5421 | <member name="M:Mono.Addins.ConsoleProgressStatus.SetMessage(System.String)"> | ||
5422 | <summary> | ||
5423 | Sets the description of the current operation. | ||
5424 | </summary> | ||
5425 | <param name="msg"> | ||
5426 | A message | ||
5427 | </param> | ||
5428 | <remarks> | ||
5429 | This method is called by the add-in engine to show a description of the operation being monitorized. | ||
5430 | </remarks> | ||
5431 | </member> | ||
5432 | <member name="M:Mono.Addins.ConsoleProgressStatus.SetProgress(System.Double)"> | ||
5433 | <summary> | ||
5434 | Sets the progress of the operation. | ||
5435 | </summary> | ||
5436 | <param name="progress"> | ||
5437 | A number between 0 and 1. 0 means no progress, 1 means operation completed. | ||
5438 | </param> | ||
5439 | <remarks> | ||
5440 | This method is called by the add-in engine to show the progress of the operation being monitorized. | ||
5441 | </remarks> | ||
5442 | </member> | ||
5443 | <member name="M:Mono.Addins.ConsoleProgressStatus.Log(System.String)"> | ||
5444 | <summary> | ||
5445 | Writes text to the log. | ||
5446 | </summary> | ||
5447 | <param name="msg"> | ||
5448 | Message to write | ||
5449 | </param> | ||
5450 | </member> | ||
5451 | <member name="M:Mono.Addins.ConsoleProgressStatus.ReportWarning(System.String)"> | ||
5452 | <summary> | ||
5453 | Reports a warning. | ||
5454 | </summary> | ||
5455 | <param name="message"> | ||
5456 | Warning message | ||
5457 | </param> | ||
5458 | <remarks> | ||
5459 | This method is called by the add-in engine to report a warning in the operation being monitorized. | ||
5460 | </remarks> | ||
5461 | </member> | ||
5462 | <member name="M:Mono.Addins.ConsoleProgressStatus.ReportError(System.String,System.Exception)"> | ||
5463 | <summary> | ||
5464 | Reports an error. | ||
5465 | </summary> | ||
5466 | <param name="message"> | ||
5467 | Error message | ||
5468 | </param> | ||
5469 | <param name="exception"> | ||
5470 | Exception that caused the error. It can be null. | ||
5471 | </param> | ||
5472 | <remarks> | ||
5473 | This method is called by the add-in engine to report an error occurred while executing the operation being monitorized. | ||
5474 | </remarks> | ||
5475 | </member> | ||
5476 | <member name="M:Mono.Addins.ConsoleProgressStatus.Cancel"> | ||
5477 | <summary> | ||
5478 | Cancels the operation being montorized. | ||
5479 | </summary> | ||
5480 | </member> | ||
5481 | <member name="P:Mono.Addins.ConsoleProgressStatus.IsCanceled"> | ||
5482 | <summary> | ||
5483 | Returns True when the user requested to cancel this operation | ||
5484 | </summary> | ||
5485 | </member> | ||
5486 | <member name="P:Mono.Addins.ConsoleProgressStatus.LogLevel"> | ||
5487 | <summary> | ||
5488 | Log level requested by the user: 0: no log, 1: normal log, >1 verbose log | ||
5489 | </summary> | ||
5490 | </member> | ||
5491 | <member name="T:Mono.Addins.Description.AddinDependency"> | ||
5492 | <summary> | ||
5493 | Definition of a dependency of an add-in on another add-in. | ||
5494 | </summary> | ||
5495 | </member> | ||
5496 | <member name="M:Mono.Addins.Description.AddinDependency.#ctor"> | ||
5497 | <summary> | ||
5498 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.AddinDependency"/> class. | ||
5499 | </summary> | ||
5500 | </member> | ||
5501 | <member name="M:Mono.Addins.Description.AddinDependency.#ctor(System.String)"> | ||
5502 | <summary> | ||
5503 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.AddinDependency"/> class. | ||
5504 | </summary> | ||
5505 | <param name="fullId"> | ||
5506 | Full identifier of the add-in (includes version) | ||
5507 | </param> | ||
5508 | </member> | ||
5509 | <member name="M:Mono.Addins.Description.AddinDependency.#ctor(System.String,System.String)"> | ||
5510 | <summary> | ||
5511 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.AddinDependency"/> class. | ||
5512 | </summary> | ||
5513 | <param name="id"> | ||
5514 | Identifier of the add-in. | ||
5515 | </param> | ||
5516 | <param name="version"> | ||
5517 | Version of the add-in. | ||
5518 | </param> | ||
5519 | </member> | ||
5520 | <member name="P:Mono.Addins.Description.AddinDependency.FullAddinId"> | ||
5521 | <summary> | ||
5522 | Gets the full addin identifier. | ||
5523 | </summary> | ||
5524 | <value> | ||
5525 | The full addin identifier. | ||
5526 | </value> | ||
5527 | <remarks> | ||
5528 | Includes namespace and version number. For example: MonoDevelop.TextEditor,1.0 | ||
5529 | </remarks> | ||
5530 | </member> | ||
5531 | <member name="P:Mono.Addins.Description.AddinDependency.AddinId"> | ||
5532 | <summary> | ||
5533 | Gets or sets the addin identifier. | ||
5534 | </summary> | ||
5535 | <value> | ||
5536 | The addin identifier. | ||
5537 | </value> | ||
5538 | </member> | ||
5539 | <member name="P:Mono.Addins.Description.AddinDependency.Version"> | ||
5540 | <summary> | ||
5541 | Gets or sets the version. | ||
5542 | </summary> | ||
5543 | <value> | ||
5544 | The version. | ||
5545 | </value> | ||
5546 | </member> | ||
5547 | <member name="P:Mono.Addins.Description.AddinDependency.Name"> | ||
5548 | <summary> | ||
5549 | Display name of the dependency. | ||
5550 | </summary> | ||
5551 | <value> | ||
5552 | The name. | ||
5553 | </value> | ||
5554 | </member> | ||
5555 | <member name="T:Mono.Addins.NodeAttributeAttribute"> | ||
5556 | <summary> | ||
5557 | Indicates that a field or property is bound to a node attribute | ||
5558 | </summary> | ||
5559 | </member> | ||
5560 | <member name="M:Mono.Addins.NodeAttributeAttribute.#ctor"> | ||
5561 | <summary> | ||
5562 | Initializes a new instance | ||
5563 | </summary> | ||
5564 | </member> | ||
5565 | <member name="M:Mono.Addins.NodeAttributeAttribute.#ctor(System.String)"> | ||
5566 | <summary> | ||
5567 | Initializes a new instance | ||
5568 | </summary> | ||
5569 | <param name="name"> | ||
5570 | XML name of the attribute. | ||
5571 | </param> | ||
5572 | </member> | ||
5573 | <member name="M:Mono.Addins.NodeAttributeAttribute.#ctor(System.String,System.String)"> | ||
5574 | <summary> | ||
5575 | Initializes a new instance | ||
5576 | </summary> | ||
5577 | <param name="name"> | ||
5578 | XML name of the attribute. | ||
5579 | </param> | ||
5580 | <param name="description"> | ||
5581 | Description of the attribute. | ||
5582 | </param> | ||
5583 | </member> | ||
5584 | <member name="M:Mono.Addins.NodeAttributeAttribute.#ctor(System.String,System.Boolean)"> | ||
5585 | <summary> | ||
5586 | Initializes a new instance | ||
5587 | </summary> | ||
5588 | <param name="name"> | ||
5589 | XML name of the attribute. | ||
5590 | </param> | ||
5591 | <param name="required"> | ||
5592 | Indicates whether the attribute is required or not. | ||
5593 | </param> | ||
5594 | </member> | ||
5595 | <member name="M:Mono.Addins.NodeAttributeAttribute.#ctor(System.String,System.Boolean,System.String)"> | ||
5596 | <summary> | ||
5597 | Initializes a new instance | ||
5598 | </summary> | ||
5599 | <param name="name"> | ||
5600 | XML name of the attribute. | ||
5601 | </param> | ||
5602 | <param name="required"> | ||
5603 | Indicates whether the attribute is required or not. | ||
5604 | </param> | ||
5605 | <param name="description"> | ||
5606 | Description of the attribute. | ||
5607 | </param> | ||
5608 | </member> | ||
5609 | <member name="M:Mono.Addins.NodeAttributeAttribute.#ctor(System.String,System.Type)"> | ||
5610 | <summary> | ||
5611 | Initializes a new instance | ||
5612 | </summary> | ||
5613 | <param name="name"> | ||
5614 | XML name of the attribute. | ||
5615 | </param> | ||
5616 | <param name="type"> | ||
5617 | Type of the extension node attribute. | ||
5618 | </param> | ||
5619 | <remarks> | ||
5620 | The type of the attribute is only required when applying this attribute at class level. | ||
5621 | It is not required when it is applied to a field, since the attribute type will be the type of the field. | ||
5622 | </remarks> | ||
5623 | </member> | ||
5624 | <member name="M:Mono.Addins.NodeAttributeAttribute.#ctor(System.String,System.Type,System.String)"> | ||
5625 | <summary> | ||
5626 | Initializes a new instance | ||
5627 | </summary> | ||
5628 | <param name="name"> | ||
5629 | XML name of the attribute. | ||
5630 | </param> | ||
5631 | <param name="type"> | ||
5632 | Type of the extension node attribute. | ||
5633 | </param> | ||
5634 | <param name="description"> | ||
5635 | Description of the attribute. | ||
5636 | </param> | ||
5637 | <remarks> | ||
5638 | The type of the attribute is only required when applying this attribute at class level. | ||
5639 | It is not required when it is applied to a field, since the attribute type will be the type of the field. | ||
5640 | </remarks> | ||
5641 | </member> | ||
5642 | <member name="M:Mono.Addins.NodeAttributeAttribute.#ctor(System.String,System.Type,System.Boolean)"> | ||
5643 | <summary> | ||
5644 | Initializes a new instance | ||
5645 | </summary> | ||
5646 | <param name="name"> | ||
5647 | XML name of the attribute. | ||
5648 | </param> | ||
5649 | <param name="type"> | ||
5650 | Type of the extension node attribute. | ||
5651 | </param> | ||
5652 | <param name="required"> | ||
5653 | Indicates whether the attribute is required or not. | ||
5654 | </param> | ||
5655 | <remarks> | ||
5656 | The type of the attribute is only required when applying this attribute at class level. | ||
5657 | It is not required when it is applied to a field, since the attribute type will be the type of the field. | ||
5658 | </remarks> | ||
5659 | </member> | ||
5660 | <member name="M:Mono.Addins.NodeAttributeAttribute.#ctor(System.String,System.Type,System.Boolean,System.String)"> | ||
5661 | <summary> | ||
5662 | Initializes a new instance | ||
5663 | </summary> | ||
5664 | <param name="name"> | ||
5665 | XML name of the attribute. | ||
5666 | </param> | ||
5667 | <param name="type"> | ||
5668 | Type of the extension node attribute. | ||
5669 | </param> | ||
5670 | <param name="required"> | ||
5671 | Indicates whether the attribute is required or not. | ||
5672 | </param> | ||
5673 | <param name="description"> | ||
5674 | Description of the attribute. | ||
5675 | </param> | ||
5676 | <remarks> | ||
5677 | The type of the attribute is only required when applying this attribute at class level. | ||
5678 | It is not required when it is applied to a field, since the attribute type will be the type of the field. | ||
5679 | </remarks> | ||
5680 | </member> | ||
5681 | <member name="P:Mono.Addins.NodeAttributeAttribute.Name"> | ||
5682 | <summary> | ||
5683 | XML name of the attribute. | ||
5684 | </summary> | ||
5685 | <remarks> | ||
5686 | If the name is not specified, the field name to which the [NodeAttribute] | ||
5687 | is applied will be used as name. Providing a name is mandatory when applying | ||
5688 | [NodeAttribute] at class level. | ||
5689 | </remarks> | ||
5690 | </member> | ||
5691 | <member name="P:Mono.Addins.NodeAttributeAttribute.Required"> | ||
5692 | <summary> | ||
5693 | Indicates whether the attribute is required or not. | ||
5694 | </summary> | ||
5695 | </member> | ||
5696 | <member name="P:Mono.Addins.NodeAttributeAttribute.Type"> | ||
5697 | <summary> | ||
5698 | Type of the extension node attribute. | ||
5699 | </summary> | ||
5700 | <remarks> | ||
5701 | To be used only when applying [NodeAttribute] at class level. It is not required when it | ||
5702 | is applied to a field, since the attribute type will be the type of the field. | ||
5703 | </remarks> | ||
5704 | </member> | ||
5705 | <member name="P:Mono.Addins.NodeAttributeAttribute.Description"> | ||
5706 | <summary> | ||
5707 | Description of the attribute. | ||
5708 | </summary> | ||
5709 | <remarks> | ||
5710 | To be used in the extension point documentation. | ||
5711 | </remarks> | ||
5712 | </member> | ||
5713 | <member name="P:Mono.Addins.NodeAttributeAttribute.Localizable"> | ||
5714 | <summary> | ||
5715 | When set to True, the value of the field or property is expected to be a string id which | ||
5716 | will be localized by the add-in engine | ||
5717 | </summary> | ||
5718 | </member> | ||
5719 | <member name="P:Mono.Addins.NodeAttributeAttribute.ContentType"> | ||
5720 | <summary> | ||
5721 | Gets or sets the type of the content. | ||
5722 | </summary> | ||
5723 | <remarks> | ||
5724 | Allows specifying the type of the content of a string attribute. | ||
5725 | This value is for documentation purposes only. | ||
5726 | </remarks> | ||
5727 | </member> | ||
5728 | <member name="T:Mono.Addins.Description.AddinPropertyCollection"> | ||
5729 | <summary> | ||
5730 | A collection of add-in properties | ||
5731 | </summary> | ||
5732 | </member> | ||
5733 | <member name="M:Mono.Addins.Description.AddinPropertyCollection.GetPropertyValue(System.String)"> | ||
5734 | <summary> | ||
5735 | Gets the value of a property | ||
5736 | </summary> | ||
5737 | <returns> | ||
5738 | The property value. | ||
5739 | </returns> | ||
5740 | <param name='name'> | ||
5741 | Name of the property. | ||
5742 | </param> | ||
5743 | <remarks> | ||
5744 | If the property is localized, it will return the value for the current language if exists, or the | ||
5745 | default value if it doesn't. | ||
5746 | </remarks> | ||
5747 | </member> | ||
5748 | <member name="M:Mono.Addins.Description.AddinPropertyCollection.GetPropertyValue(System.String,System.String)"> | ||
5749 | <summary> | ||
5750 | Gets the value of a property | ||
5751 | </summary> | ||
5752 | <returns> | ||
5753 | The property value. | ||
5754 | </returns> | ||
5755 | <param name='name'> | ||
5756 | Name of the property. | ||
5757 | </param> | ||
5758 | <param name='locale'> | ||
5759 | Locale for which the value must be returned. | ||
5760 | </param> | ||
5761 | </member> | ||
5762 | <member name="M:Mono.Addins.Description.AddinPropertyCollection.SetPropertyValue(System.String,System.String)"> | ||
5763 | <summary> | ||
5764 | Sets the value of a property | ||
5765 | </summary> | ||
5766 | <param name='name'> | ||
5767 | Name of the property | ||
5768 | </param> | ||
5769 | <param name='value'> | ||
5770 | New value. | ||
5771 | </param> | ||
5772 | </member> | ||
5773 | <member name="M:Mono.Addins.Description.AddinPropertyCollection.SetPropertyValue(System.String,System.String,System.String)"> | ||
5774 | <summary> | ||
5775 | Sets the value of a property for a specific locale | ||
5776 | </summary> | ||
5777 | <param name='name'> | ||
5778 | Name of the property. | ||
5779 | </param> | ||
5780 | <param name='value'> | ||
5781 | New value. | ||
5782 | </param> | ||
5783 | <param name='locale'> | ||
5784 | Locale of the property to be set. | ||
5785 | </param> | ||
5786 | </member> | ||
5787 | <member name="M:Mono.Addins.Description.AddinPropertyCollection.RemoveProperty(System.String)"> | ||
5788 | <summary> | ||
5789 | Removes a property. | ||
5790 | </summary> | ||
5791 | <param name='name'> | ||
5792 | Name of the property. | ||
5793 | </param> | ||
5794 | <remarks> | ||
5795 | This method only removes properties which have no locale set. | ||
5796 | </remarks> | ||
5797 | </member> | ||
5798 | <member name="M:Mono.Addins.Description.AddinPropertyCollection.RemoveProperty(System.String,System.String)"> | ||
5799 | <summary> | ||
5800 | Removes a property with a specified locale | ||
5801 | </summary> | ||
5802 | <param name='name'> | ||
5803 | Name of the property | ||
5804 | </param> | ||
5805 | <param name='locale'> | ||
5806 | Locale of the property | ||
5807 | </param> | ||
5808 | </member> | ||
5809 | <member name="T:Mono.Addins.ImportAddinFileAttribute"> | ||
5810 | <summary> | ||
5811 | Declares an add-in file import | ||
5812 | </summary> | ||
5813 | <remarks> | ||
5814 | An add-in may be composed by several assemblies and data files. | ||
5815 | Data files must be declared in the main assembly using this attribute, or in the XML manifest. | ||
5816 | |||
5817 | It is important to properly declare all files used by an add-in. | ||
5818 | This information is used by setup tools to know exactly what needs to be packaged when creating | ||
5819 | an add-in package, or to know what needs to be deleted when removing an add-in. | ||
5820 | </remarks> | ||
5821 | </member> | ||
5822 | <member name="M:Mono.Addins.ImportAddinFileAttribute.#ctor(System.String)"> | ||
5823 | <summary> | ||
5824 | Initializes a new instance | ||
5825 | </summary> | ||
5826 | <param name="filePath"> | ||
5827 | Path to the file. Must be relative to the assembly declaring this attribute. | ||
5828 | </param> | ||
5829 | </member> | ||
5830 | <member name="P:Mono.Addins.ImportAddinFileAttribute.FilePath"> | ||
5831 | <summary> | ||
5832 | Path to the file. Must be relative to the assembly declaring this attribute. | ||
5833 | </summary> | ||
5834 | </member> | ||
5835 | <member name="T:Mono.Addins.Description.NodeSetIdCollection"> | ||
5836 | <summary> | ||
5837 | A collection of node set identifiers | ||
5838 | </summary> | ||
5839 | </member> | ||
5840 | <member name="M:Mono.Addins.Description.NodeSetIdCollection.GetEnumerator"> | ||
5841 | <summary> | ||
5842 | Gets the collection enumerator. | ||
5843 | </summary> | ||
5844 | <returns> | ||
5845 | The enumerator. | ||
5846 | </returns> | ||
5847 | </member> | ||
5848 | <member name="M:Mono.Addins.Description.NodeSetIdCollection.Add(System.String)"> | ||
5849 | <summary> | ||
5850 | Add the specified node set identifier. | ||
5851 | </summary> | ||
5852 | <param name='nodeSetId'> | ||
5853 | Node set identifier. | ||
5854 | </param> | ||
5855 | </member> | ||
5856 | <member name="M:Mono.Addins.Description.NodeSetIdCollection.Remove(System.String)"> | ||
5857 | <summary> | ||
5858 | Remove a node set identifier | ||
5859 | </summary> | ||
5860 | <param name='nodeSetId'> | ||
5861 | Node set identifier. | ||
5862 | </param> | ||
5863 | </member> | ||
5864 | <member name="M:Mono.Addins.Description.NodeSetIdCollection.Clear"> | ||
5865 | <summary> | ||
5866 | Clears the collection | ||
5867 | </summary> | ||
5868 | </member> | ||
5869 | <member name="M:Mono.Addins.Description.NodeSetIdCollection.Contains(System.String)"> | ||
5870 | <summary> | ||
5871 | Checks if the specified identifier is present in the collection | ||
5872 | </summary> | ||
5873 | <param name='nodeSetId'> | ||
5874 | <c>true</c> if the node set identifier is present. | ||
5875 | </param> | ||
5876 | </member> | ||
5877 | <member name="M:Mono.Addins.Description.NodeSetIdCollection.IndexOf(System.String)"> | ||
5878 | <summary> | ||
5879 | Returns the index of the specified node set identifier | ||
5880 | </summary> | ||
5881 | <returns> | ||
5882 | The index. | ||
5883 | </returns> | ||
5884 | <param name='nodeSetId'> | ||
5885 | A node set identifier. | ||
5886 | </param> | ||
5887 | </member> | ||
5888 | <member name="P:Mono.Addins.Description.NodeSetIdCollection.Item(System.Int32)"> | ||
5889 | <summary> | ||
5890 | Gets the node set identifier at the specified index. | ||
5891 | </summary> | ||
5892 | <param name='n'> | ||
5893 | An index. | ||
5894 | </param> | ||
5895 | </member> | ||
5896 | <member name="P:Mono.Addins.Description.NodeSetIdCollection.Count"> | ||
5897 | <summary> | ||
5898 | Gets the item count. | ||
5899 | </summary> | ||
5900 | <value> | ||
5901 | The count. | ||
5902 | </value> | ||
5903 | </member> | ||
5904 | <member name="T:Mono.Addins.Description.ModuleDescription"> | ||
5905 | <summary> | ||
5906 | A module definition. | ||
5907 | </summary> | ||
5908 | <remarks> | ||
5909 | Optional modules can be used to declare extensions which will be registered only if some | ||
5910 | specified add-in dependencies can be satisfied. | ||
5911 | </remarks> | ||
5912 | </member> | ||
5913 | <member name="M:Mono.Addins.Description.ModuleDescription.#ctor"> | ||
5914 | <summary> | ||
5915 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.ModuleDescription"/> class. | ||
5916 | </summary> | ||
5917 | </member> | ||
5918 | <member name="M:Mono.Addins.Description.ModuleDescription.DependsOnAddin(System.String)"> | ||
5919 | <summary> | ||
5920 | Checks if this module depends on the specified add-in. | ||
5921 | </summary> | ||
5922 | <returns> | ||
5923 | <c>true</c> if there is a dependency. | ||
5924 | </returns> | ||
5925 | <param name='addinId'> | ||
5926 | Identifier of the add-in | ||
5927 | </param> | ||
5928 | </member> | ||
5929 | <member name="M:Mono.Addins.Description.ModuleDescription.AddExtensionNode(System.String,System.String)"> | ||
5930 | <summary> | ||
5931 | Adds an extension node to the module. | ||
5932 | </summary> | ||
5933 | <returns> | ||
5934 | The extension node. | ||
5935 | </returns> | ||
5936 | <param name='path'> | ||
5937 | Path that identifies the extension point. | ||
5938 | </param> | ||
5939 | <param name='nodeName'> | ||
5940 | Node name. | ||
5941 | </param> | ||
5942 | <remarks> | ||
5943 | This method creates a new Extension object for the provided path if none exist. | ||
5944 | </remarks> | ||
5945 | </member> | ||
5946 | <member name="M:Mono.Addins.Description.ModuleDescription.GetExtension(System.String)"> | ||
5947 | <summary> | ||
5948 | Gets an extension instance. | ||
5949 | </summary> | ||
5950 | <returns> | ||
5951 | The extension instance. | ||
5952 | </returns> | ||
5953 | <param name='path'> | ||
5954 | Path that identifies the extension point that the extension extends. | ||
5955 | </param> | ||
5956 | <remarks> | ||
5957 | This method creates a new Extension object for the provided path if none exist. | ||
5958 | </remarks> | ||
5959 | </member> | ||
5960 | <member name="M:Mono.Addins.Description.ModuleDescription.AddAssemblyReference(System.String,System.String)"> | ||
5961 | <summary> | ||
5962 | Adds an add-in reference (there is a typo in the method name) | ||
5963 | </summary> | ||
5964 | <param name='id'> | ||
5965 | Identifier of the add-in. | ||
5966 | </param> | ||
5967 | <param name='version'> | ||
5968 | Version of the add-in. | ||
5969 | </param> | ||
5970 | </member> | ||
5971 | <member name="P:Mono.Addins.Description.ModuleDescription.IgnorePaths"> | ||
5972 | <summary> | ||
5973 | Gets the list of paths to be ignored by the add-in scanner. | ||
5974 | </summary> | ||
5975 | </member> | ||
5976 | <member name="P:Mono.Addins.Description.ModuleDescription.AllFiles"> | ||
5977 | <summary> | ||
5978 | Gets all external files | ||
5979 | </summary> | ||
5980 | <value> | ||
5981 | All files. | ||
5982 | </value> | ||
5983 | <remarks> | ||
5984 | External files are data files and assemblies explicitly referenced in the Runtime section of the add-in manifest. | ||
5985 | </remarks> | ||
5986 | </member> | ||
5987 | <member name="P:Mono.Addins.Description.ModuleDescription.Assemblies"> | ||
5988 | <summary> | ||
5989 | Gets the list of external assemblies used by this module. | ||
5990 | </summary> | ||
5991 | </member> | ||
5992 | <member name="P:Mono.Addins.Description.ModuleDescription.DataFiles"> | ||
5993 | <summary> | ||
5994 | Gets the list of external data files used by this module | ||
5995 | </summary> | ||
5996 | </member> | ||
5997 | <member name="P:Mono.Addins.Description.ModuleDescription.Dependencies"> | ||
5998 | <summary> | ||
5999 | Gets the dependencies of this module | ||
6000 | </summary> | ||
6001 | </member> | ||
6002 | <member name="P:Mono.Addins.Description.ModuleDescription.Extensions"> | ||
6003 | <summary> | ||
6004 | Gets the extensions of this module | ||
6005 | </summary> | ||
6006 | </member> | ||
6007 | <member name="T:Mono.Addins.AddinCategoryAttribute"> | ||
6008 | <summary> | ||
6009 | Addin category attribute. | ||
6010 | </summary> | ||
6011 | </member> | ||
6012 | <member name="M:Mono.Addins.AddinCategoryAttribute.#ctor(System.String)"> | ||
6013 | <summary> | ||
6014 | Initializes the attribute | ||
6015 | </summary> | ||
6016 | <param name="category"> | ||
6017 | The category to which the add-in belongs | ||
6018 | </param> | ||
6019 | </member> | ||
6020 | <member name="P:Mono.Addins.AddinCategoryAttribute.Category"> | ||
6021 | <summary> | ||
6022 | The category to which the add-in belongs | ||
6023 | </summary> | ||
6024 | </member> | ||
6025 | <member name="T:Mono.Addins.Description.ExtensionNodeTypeCollection"> | ||
6026 | <summary> | ||
6027 | A collection of node types. | ||
6028 | </summary> | ||
6029 | </member> | ||
6030 | <member name="M:Mono.Addins.Description.ExtensionNodeTypeCollection.#ctor"> | ||
6031 | <summary> | ||
6032 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.ExtensionNodeTypeCollection"/> class. | ||
6033 | </summary> | ||
6034 | </member> | ||
6035 | <member name="P:Mono.Addins.Description.ExtensionNodeTypeCollection.Item(System.Int32)"> | ||
6036 | <summary> | ||
6037 | Gets the <see cref="T:Mono.Addins.Description.ExtensionNodeType"/> at the specified index. | ||
6038 | </summary> | ||
6039 | <param name="n"> | ||
6040 | The index. | ||
6041 | </param> | ||
6042 | </member> | ||
6043 | <member name="P:Mono.Addins.Description.ExtensionNodeTypeCollection.Item(System.String)"> | ||
6044 | <summary> | ||
6045 | Gets the <see cref="T:Mono.Addins.Description.ExtensionNodeType"/> with the specified id. | ||
6046 | </summary> | ||
6047 | <param name="id"> | ||
6048 | Identifier. | ||
6049 | </param> | ||
6050 | </member> | ||
6051 | <member name="T:Mono.Addins.Description.NodeTypeAttribute"> | ||
6052 | <summary> | ||
6053 | Description of the attribute of a node type. | ||
6054 | </summary> | ||
6055 | </member> | ||
6056 | <member name="M:Mono.Addins.Description.NodeTypeAttribute.#ctor"> | ||
6057 | <summary> | ||
6058 | Initializes a new instance of the <see cref="T:Mono.Addins.Description.NodeTypeAttribute"/> class. | ||
6059 | </summary> | ||
6060 | </member> | ||
6061 | <member name="M:Mono.Addins.Description.NodeTypeAttribute.CopyFrom(Mono.Addins.Description.NodeTypeAttribute)"> | ||
6062 | <summary> | ||
6063 | Copies data from another node attribute. | ||
6064 | </summary> | ||
6065 | <param name='att'> | ||
6066 | The attribute from which to copy. | ||
6067 | </param> | ||
6068 | </member> | ||
6069 | <member name="P:Mono.Addins.Description.NodeTypeAttribute.Name"> | ||
6070 | <summary> | ||
6071 | Gets or sets the name of the attribute. | ||
6072 | </summary> | ||
6073 | <value> | ||
6074 | The name. | ||
6075 | </value> | ||
6076 | </member> | ||
6077 | <member name="P:Mono.Addins.Description.NodeTypeAttribute.Required"> | ||
6078 | <summary> | ||
6079 | Gets or sets a value indicating whether this <see cref="T:Mono.Addins.Description.NodeTypeAttribute"/> is required. | ||
6080 | </summary> | ||
6081 | <value> | ||
6082 | <c>true</c> if required; otherwise, <c>false</c>. | ||
6083 | </value> | ||
6084 | </member> | ||
6085 | <member name="P:Mono.Addins.Description.NodeTypeAttribute.Localizable"> | ||
6086 | <summary> | ||
6087 | Gets or sets a value indicating whether this <see cref="T:Mono.Addins.Description.NodeTypeAttribute"/> is localizable. | ||
6088 | </summary> | ||
6089 | <value> | ||
6090 | <c>true</c> if localizable; otherwise, <c>false</c>. | ||
6091 | </value> | ||
6092 | </member> | ||
6093 | <member name="P:Mono.Addins.Description.NodeTypeAttribute.Type"> | ||
6094 | <summary> | ||
6095 | Gets or sets the type of the attribute. | ||
6096 | </summary> | ||
6097 | <value> | ||
6098 | The type. | ||
6099 | </value> | ||
6100 | </member> | ||
6101 | <member name="P:Mono.Addins.Description.NodeTypeAttribute.Description"> | ||
6102 | <summary> | ||
6103 | Gets or sets the description of the attribute. | ||
6104 | </summary> | ||
6105 | <value> | ||
6106 | The description. | ||
6107 | </value> | ||
6108 | </member> | ||
6109 | <member name="P:Mono.Addins.Description.NodeTypeAttribute.ContentType"> | ||
6110 | <summary> | ||
6111 | Gets or sets the type of the content. | ||
6112 | </summary> | ||
6113 | <remarks> | ||
6114 | Allows specifying the type of the content of a string attribute. | ||
6115 | The value of this property is only informative, and it doesn't | ||
6116 | have any effect on how add-ins are packaged or loaded. | ||
6117 | </remarks> | ||
6118 | </member> | ||
6119 | </members> | ||
6120 | </doc> | ||
diff --git a/bin/OpenSim.addin.xml b/bin/OpenSim.addin.xml deleted file mode 100644 index a42ba25..0000000 --- a/bin/OpenSim.addin.xml +++ /dev/null | |||
@@ -1,20 +0,0 @@ | |||
1 | <Addin id="OpenSim" isroot="true" version="0.5"> | ||
2 | <Runtime> | ||
3 | <Import assembly="OpenSim.exe"/> | ||
4 | <Import assembly="OpenSim.Framework.dll"/> | ||
5 | <Import assembly="OpenSim.Region.Framework.dll"/> | ||
6 | <Import assembly="Mono.Addins.dll"/> | ||
7 | </Runtime> | ||
8 | |||
9 | <ExtensionPoint path="/OpenSim/Startup"> | ||
10 | <ExtensionNode name="Plugin" type="OpenSim.Framework.PluginExtensionNode" objectType="OpenSim.IApplicationPlugin"/> | ||
11 | </ExtensionPoint> | ||
12 | |||
13 | <ExtensionPoint path="/OpenSim/WindModule" name="Wind Module Plugins for wind models"> | ||
14 | <ExtensionNode name="WindModel" type="Mono.Addins.TypeExtensionNode" objectType="OpenSim.Region.Framework.Interfaces.IWindModelPlugin"/> | ||
15 | </ExtensionPoint> | ||
16 | |||
17 | <ExtensionPoint path="/OpenSim/RegionModules"> | ||
18 | <ExtensionNode name="RegionModule" type="Mono.Addins.TypeExtensionNode" objectType="OpenSim.Region.Framework.Interfaces.IRegionModuleBase"/> | ||
19 | </ExtensionPoint> | ||
20 | </Addin> | ||
diff --git a/bin/mautil.exe b/bin/mautil.exe new file mode 100644 index 0000000..34b16c5 --- /dev/null +++ b/bin/mautil.exe | |||
Binary files differ | |||