Breakpoint.Tag Property

Definition

Namespace:

EnvDTE

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Sets or gets a user-defined string identifying the Breakpoint.

public:
 property System::String ^ Tag { System::String ^ get(); void set(System::String ^ value); };

public:
 property Platform::String ^ Tag { Platform::String ^ get(); void set(Platform::String ^ value); };

[System.Runtime.InteropServices.DispId(114)]
public string Tag { [System.Runtime.InteropServices.DispId(114)] get; [System.Runtime.InteropServices.DispId(114)] set; }

[<System.Runtime.InteropServices.DispId(114)>]
[<get: System.Runtime.InteropServices.DispId(114)>]
[<set: System.Runtime.InteropServices.DispId(114)>]
member this.Tag : string with get, set

Public Property Tag As String

Property Value

String

A string value representing the Breakpoint.

Attributes

DispIdAttribute

Examples

The following example demonstrates how to use the Tag property.

public static void Tag(DTE dte)  
{  
    // Setup debug Output window.  
    Window w = (Window)dte.Windows.Item(EnvDTE.Constants.vsWindowKindOutput);  
    w.Visible = true;  
    OutputWindow ow = (OutputWindow)w.Object;  
    OutputWindowPane owp = ow.OutputWindowPanes.Add("Tag Property Test: ");  
    owp.Activate();  

    EnvDTE.Debugger debugger = (EnvDTE.Debugger)dte.Debugger;  
    owp.OutputString("HitCountTarget: " +   
                        debugger.Breakpoints.Item(1).HitCountTarget);  
    owp.OutputString("\nHitCountType: " +   
                        debugger.Breakpoints.Item(1).HitCountType);  
    owp.OutputString("\nLocationType: " +   
                        debugger.Breakpoints.Item(1).LocationType);  
    owp.OutputString("\nName: " + debugger.Breakpoints.Item(1).Name);  
    debugger.Breakpoints.Item(1).Tag = "My Breakpoint";  
    owp.OutputString("\nTag: " + debugger.Breakpoints.Item(1).Tag);  
    owp.OutputString("\nType: " + debugger.Breakpoints.Item(1).Type);  
}  

Shared Sub Tag(ByRef dte As EnvDTE.DTE)  
    Dim strHitCountTarget As String  
    Dim strHitCountType As String  
    Dim strLocationType As String  
    Dim strName As String  
    Dim strType As String  
    Dim strTag As String  

    strHitCountTarget = dte.Debugger.Breakpoints.Item(1).HitCountTarget.ToString()  
    strHitCountType = dte.Debugger.Breakpoints.Item(1).HitCountType.ToString()  
    strLocationType = dte.Debugger.Breakpoints.Item(1).LocationType.ToString()  
    strName = dte.Debugger.Breakpoints.Item(1).Name.ToString()  
    strType = dte.Debugger.Breakpoints.Item(1).Type.ToString()  
    dte.Debugger.Breakpoints.Item(1).Tag = "My Breakpoint"  
    strTag = dte.Debugger.Breakpoints.Item(1).Tag.ToString()  
    MessageBox.Show("HitCountTarget: " + strHitCountTarget + vbCrLf + _  
                    "HitCountType: " + strHitCountType + vbCrLf + _  
                    "LocationType: " + strLocationType + vbCrLf + _  
                    "Name: " + strName + vbCrLf + _  
                    "Type: " + strType + vbCrLf + _  
                    "Tag: " + strTag + vbCrLf)  
End Sub