PluginData.OnAddVirtualDataItem Method (String, String, String) (Compact 7)

3/12/2014

Override this function if your plug-in supports loading virtual data (from a file). For each call to this method, one piece of data from the loading file will be indicated. Your implementation of this function should use the description parameter to determine how to process the value parameter and store it appropriately.

Namespace: Microsoft.RemoteToolSdk.PluginComponents
Assembly: Microsoft.RemoteToolSdk (in microsoft.remotetoolsdk.dll)

Syntax

protected virtual void OnAddVirtualDataItem (
    string description,
    string value,
    string identifier
)

'Declaration
Protected Overridable Sub OnAddVirtualDataItem ( _
    description As String, _
    value As String, _
    identifier As String _
)

Parameters

• description
  The description of the data.

• value
  The value of the data.

• identifier
  User-supplied identifier.

Remarks

Override only one of the two OnAddVirtualDataItem methods, as both would be called if you overrode them both and you would add all your data twice.

When the user loads a data file, the Remote Tools Framework checks to see if the plugin that created the file is available. If so, an instance of that plugin will be created, and the data will be sent to it, one item at a time through this function.

If the plugin is not found, or if the SupportsVirtualData property is false, then the Remote Tools Framework will display the data in a completely generic fashion. It is in the plugin developer's best interest to implement this function and set the SupportsVirtualData to true. This will allow for rich viewing of the data.

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

PluginData Class
PluginData Members
Microsoft.RemoteToolSdk.PluginComponents Namespace