Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
1/5/2010
This is the base class that all plug-ins must be derived from.
Namespace: Microsoft.RemoteToolSdk.PluginComponents
Assembly: Microsoft.RemoteToolSdk (in microsoft.remotetoolsdk.dll)
Syntax
public abstract class PluginComponent
'Declaration
Public MustInherit Class PluginComponent
Remarks
This class is the communication point between the Remote Tools Framework and your plug-in. This class is responsible for defining the data, views, features, UI command changes, and nodes of your plug-in.
It is possible that method calls on this object will occur on a thread that is not the primary thread. If your code has threading issues (such as communicating with Windows Forms Controls) then be sure to check the InvokeRequired property When you define your class, be sure to indicate the full name of that class in the Remote Tool Bundler input file (usually plugininfo.cebundleinfo).
For example, if your code looks like this:
using System;
using System.Collections;
using System.Collections.Generic;
using Microsoft.RemoteToolSdk.PluginComponents;
namespace MyFirstPlugin
{
public class Plugin : PluginComponent
{
...
}
}
You will want to specify the name of the plug-in in the input file to look like this:
PluginObjectName=MyFirstPlugin.Plugin
The Remote Tools Framework will create an instance of this class when your plug-in is loaded. Once the instance is created, the M:Microsoft.RemoteToolSdk.PluginComponents.PluginComponent.OnInit method will be called.
Inheritance Hierarchy
System.Object
Microsoft.RemoteToolSdk.PluginComponents.PluginComponent
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread-safe. Any instance members are not guaranteed to be thread-safe.
See Also
Reference
PluginComponent Members
Microsoft.RemoteToolSdk.PluginComponents Namespace