IVisualizerObjectProvider.ReplaceObject(Object) Method

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.DebuggerVisualizers
Assembly:
Microsoft.VisualStudio.DebuggerVisualizers.dll
Package:
Microsoft.VisualStudio.DebuggerVisualizers v17.6.1032901

Serializes the object using default serialization and then sets the data using ReplaceData

public:
 void ReplaceObject(System::Object ^ newObject);
public:
 void ReplaceObject(Platform::Object ^ newObject);
void ReplaceObject(winrt::Windows::Foundation::IInspectable const & newObject);
public void ReplaceObject (object newObject);
abstract member ReplaceObject : obj -> unit
Public Sub ReplaceObject (newObject As Object)

Parameters

newObject
Object

The new object to replace the object currently being visualized.

Examples

public class DebuggerSide : DialogDebuggerVisualizer
{
    override protected void Show(IDialogVisualizerService windowService, IVisualizerObjectProvider objectProvider)
    {
        // Get a string from the debuggee side and display it in a message box.  
        String myString = objectProvider.GetObject<string>();
        MessageBox.Show(myString);

        // Modify the string and send it back to the debuggee side.  
        String myNewString = myString.ToUpper();
        // Make sure the object is replaceable before you try to replace it.  
        // Otherwise, you will get an exception.  
        if (objectProvider.IsObjectReplaceable)
        {
            // This example assumes the object source is expecting a string.  
            objectProvider.ReplaceObject(myNewString);
        }
   }
    // Other DebuggerSide methods omitted for clarity.  
}

Remarks

Replaces the object being visualized with a new object that you specify. This results in the newObject parameter being serialized and passed to the ReplaceData(Stream) method.

Applies to