PluginData Members (Windows Embedded CE 6.0)

1/5/2010

This is the base class that all plug-in data objects must be derived from if the Remote Tools Framework is going to interface with the object.

The following tables list the members exposed by the PluginData type.

Protected Constructors

	Name	Description
	PluginData	Constructs this object.

Top

(see also Protected Properties )

	Name	Description
	DataNotApplicable	Indicates if the data is not applicable for the current device. If TRUE, the Remote Tools Framework will automatically display a view stating that the data is not applicable for the device.
	Exception	The exception thrown
	ExceptionOccured	Set to TRUE if the framework caught an exception in the plug-in code. This must be set via property.
	Guid	The GUID specified in the constructor for this object. It should match the GUID of one of the nodes this data object is associated with.
	Host	The T:Microsoft.RemoteToolSdk.PluginComponents.PluginComponent that owns this data object. Set in the object constructor.
	InGetData	Set to true while the data object is comminicating with the device in a call to GetData. If your code calls GetData from a secondary thread while GetData is executing, the call to GetData will fail. You can use this property to wait for the other GetData calls to succeed.
	InitDataAtViewTime	Set to true to indicate the data should be loaded when the Plugin is created. Set to false to indicate the data should be loaded when the user clicks on a node for the first time that is associated with this data.
	Initialized	Indicates if the data is valid and ready for rendering. Once set to TRUE, any views associated with this data object will refresh.

Top

	Name	Description
	CommandTransport	Identifies the P:Microsoft.RemoteToolSdk.PluginComponents.PluginData.CommandTransport between the desktop and the device for this data object. This transport is automatically created by the Remote Tools Framework.
	InvokeRequired	Returns TRUE if the caller of this property is not running on the primary UI thread. If this property returns TRUE and your code needs to run on the Primary UI thread, use the RunOnPrimaryThread method.

Top

(see also Protected Methods )

	Name	Description
	CopyToClipboard	Copies data from this object to the clipboard.
	Equals	Overloaded. (inherited from Object )
	GetData	Call this function to get data from the device. The OnGetData method of the data object is called in response to this function call.
	GetHashCode	(inherited from Object )
	GetType	(inherited from Object )
	ReferenceEquals	(inherited from Object )
	RenderGeneric	Call this method to request that this object enumerates its data to a Generic Data Acceptor.
	RenderViews	Forces all views associated with this data object to refresh.
	ToString	(inherited from Object )

Top

	Name	Description
	Finalize	(inherited from Object )
	MemberwiseClone	(inherited from Object )
	OnAddVirtualDataItem	Overloaded.
	OnCopyToClipboard	Override this method if you wish to implement a custom clipboard copy.
	OnGetData	Override this method to implement the code that calls the device side application and retrieves data.
	OnLeftClick	Override this function if your plug-in wishes to react to the user left-clicking on a node in the treeview control.
	OnRenderGeneric	Required: This method must enumerate all of the data object's data, and send the data to the supplied T:Microsoft.RemoteToolSdk.PluginComponents.GenericDataAcceptor object. The Remote Tools Framework will call this function for serialization (saving), default clipboard copy, and for filling the built-in Generic View.
	OnRightClick	Override this function if your plug-in wishes to react to the user right-clicking on a node in the treeview control differently than the default action ("Copy to Clipboard").
	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