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.
The following tables list the members exposed by the PluginComponent type.
Public Constructors
| Name | Description | |
|---|---|---|
| PluginComponent | Base constructor |
Top
Public Properties
(see also Protected Properties )
| Name | Description | |
|---|---|---|
.gif "Bb521935.pubproperty(en-US,WinEmbedded.60).gif") |
AllowThisPluginToBeFound | Set to TRUE if you wish this plug-in to be found via the FindPlugin method. |
|
CommandTransport | The transport for CommandPacket objects between the desktop and the device. |
|
CommandUI | Plugin-defined enhancements to the menu command UI. |
|
Connected | TRUE if this Plugin is connected to a device, FALSE otherwise. |
|
ContainedInForm | Indicates if this instance of the plug-in is contained in a Windows Form. |
|
ContainedInToolWindow | Indicates if this instance of the plugin is contained in a Visual Studio Tool Window. |
|
Description | Human readable description of the plug-in. |
|
DeviceConnection | The device connection from the desktop to the device that this plug-in is building its CommandTransport on. |
|
DeviceDatabase | Returns a description of this plug-in. |
|
DoesNotDeployDeviceComponent | Set to TRUE in the constructor if this plug-in does not deploy anything to the device. Defaults to FALSE. |
|
GuidPackage | The GUID of this plug-in. |
|
RequiresToolHelpDll | Set to TRUE in the constructor if the device side application for this plug-in requires the ToolHelp DLL. Defaults to FALSE. |
|
RunningInShell | Indicates if this instance of the plug-in is running under the Remote Tools Shell with a TreeView on the left and a view pane on the right. |
|
SettingsPath | Returns the folder on the user's hard drive where settings information for this plug-in should be saved. |
|
ShowPacketSniffer | Set to TRUE to display a packet sniffer window. |
|
Standalone | Indicates if this instance of the plug-in is running as its own tool (i.e. the user double-clicked on the .cetool file) in its own separate executable. |
|
StandaloneDescription | Text to use in the caption bar of the main window if this plug-in is loaded standalone (i.e. "Windows CE Remote Tool: My Plug-in"). Defaults to "Windows CE Unnamed Plug-in". |
|
SupportsVirtualData | Set to TRUE in the constructor if this plug-in can accept virtual data from a file (instead of from the device). If set to TRUE, the plug-in data items must override the AddDataItem method and handle the incoming data. Defaults to FALSE. |
|
UsingVirtualData | Indicates if this instance of the plug-in is connected to a live device, or if it is being used to view "virtual data" (loading from a file). |
Top
Protected Properties
| Name | Description | |
|---|---|---|
.gif "Bb521935.protproperty(en-US,WinEmbedded.60).gif") |
InvokeRequired | Returns TRUE if the caller of this property is not running on the primary UI thread. |
Top
Public Methods
(see also Protected Methods )
| Name | Description | |
|---|---|---|
.gif "Bb521935.pubmethod(en-US,WinEmbedded.60).gif") |
AddData | Call this method to add a data item to the list of data items for your plug-in. |
|
AddNode | Call this method to add a node to the list of nodes for your plug-in. |
|
ConnectDevice | Connects a device and deploys/executes all the currently loaded plug-ins to this device. |
|
Equals | Overloaded. (inherited from Object ) |
|
FindPlugin | Finds a Plug-in on a particular device. The plug-in will only be found if the plug-in P:Microsoft.RemoteToolSdk.PluginComponents.PluginComponent.AllowThisPluginToBeFound property was set to true, the plug-in is loaded and running at the time of this method call, and it is running on the device specified by the GUID of the device. |
|
GetHashCode | (inherited from Object ) |
|
GetType | (inherited from Object ) |
.gif "Bb521935.static(en-US,WinEmbedded.60).gif") |
ReferenceEquals | (inherited from Object ) |
|
RefreshData | Forces the plug-in to refresh all data from the device. |
|
Save | Saves the data for this plug-in to a file. The user is prompted for a filename. |
|
ToString | Overridden. Returns a description of this plug-in. |
Top
Protected Methods
| Name | Description | |
|---|---|---|
.gif "Bb521935.protmethod(en-US,WinEmbedded.60).gif") |
Finalize | (inherited from Object ) |
|
MemberwiseClone | (inherited from Object ) |
|
OnCommandPacketReceived | Override this function if you want your plug-in to be informed when a CommandPacket has been pushed asynchronously from the device. |
|
OnConnectionChanged | Override this method to be notifed by the framework when a device connection changes. |
|
OnGetAllDeviceData | Gets all the data from the device. |
|
OnInit | Override this function to initialize the plug-in by creating the data objects/views and adding them to the data array, and creating the nodes to display in the Remote Tools Shell TreeView. |
|
OnLeftClick | Override this function if your plug-in needs to react to the user left-clicking on a node in the treeview control. |
|
OnNodeSelected | Override this method to react to the user selecting a node in the treeview. |
|
OnNodeUnselected | Override this method to be notifed when a node in the treeivew is losing selection. Called when a node loses selection. |
|
OnRightClick | Override this function if your plug-in wishes to react to the user right clicking on a node in the treeview control. |
|
OnStart | This method is called after the OnInit method has been called, and the CommandTransport has been created. |
|
RunOnPrimaryThread | Invokes the code defined by the delegate on the primary UI thread. If the current thread already is the Primary UI Thread, then the code will be run without calling Invoke. |
Top
See Also
Reference
PluginComponent Class
Microsoft.RemoteToolSdk.PluginComponents Namespace