NotifyDataChanged method

Description

The plugin calls the NotifyDataChanged method to tell VWorks software that the user changed a property in the plugin’s diagnostics dialog box. VWorks software can perform operations on this information, such as writing a message to the Main Log.

Syntax

 

HRESULT NotifyDataChanged( [in] IControllerClient *Source, [in] BSTR ObjectDataChanged );

Parameters

 

Source	[in] The plugin’s pointer to itself.
ObjectDataChanged	[in] An ObjectDataChanged XML element that contains the new value of the property.

NotifyDataChanged method output

The plugin sends an ObjectDataChanged XML element in the Source parameter of the NotifyDataChanged method. This XML element provides information about the old property and its new value.

ObjectDataChanged element

The ObjectDataChanged element has the following attributes:

 

Name	Value
Message	The message in the following format, where <ObjectType> is the name of the property that was changed and ObjectName is the new value. The characters following New object and the space are in escaped format. New object <ObjectType>: ObjectName Required: Yes
NewValue	The new value of the property. Required: Yes
ObjectName	The property name. Required: Yes
ObjectType	The property type, in escaped format. Required: Yes
OldValue	The old value of the property. Required: Yes
PropertyName	The name of the property in the diagnostics dialog box that was changed. Required: Yes

Example of NotifyDataChanged method output

The following sample code is an ObjectDataChanged XML element that is sent by the plugin to VWorks software as a string in the ObjectDataChanged parameter of the NotifyDataChanged method. The plugin returns the new value of 50 for the property named X/Y Offset Pipetting:East/west offset.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='111f2066886efab8e46ef32de9284e25' version='1.0' > <ObjectDataChanged Message='New object &lt;Pipette technique&gt;: →&quot;technique&quot;' NewValue='50' ObjectName='technique' ObjectType='&lt;Pipette →technique&gt;' OldValue='0' PropertyName='X/Y Offset Pipetting:East/west offset' /> </Velocity11>

Un-escaped attribute values

The following code is the un-escaped portion of the Message attribute value from the previous NotifyDataChanged method output example.

 

<Pipette technique>: "technique"

The following code is the un-escaped value of the ObjectType attribute from the previous NotifyDataChanged method output example.

 

<Pipette technique>

Related information

 

For information about...	See...
IControllerClient interface	“IControllerClient interface”