Share via


Breakpoint.Tag Property

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

Namespace:  EnvDTE
Assembly:  EnvDTE (in EnvDTE.dll)

Syntax

'Declaration
Property Tag As String
string Tag { get; set; }
property String^ Tag {
    String^ get ();
    void set (String^ value);
}
abstract Tag : string with get, set
function get Tag () : String 
function set Tag (value : String)

Property Value

Type: System.String
A string value representing the Breakpoint.

Examples

The following example demonstrates how to use the Tag property.

To test this property:

  1. Set a breakpoint in the target application.

  2. Set various breakpoint properties in Properties/Hit Count Dialog Box.

  3. Run the add-in.

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();

    // dte is a reference to the DTE object passed to you by the
    // OnConnection method that you implement when you create an add-in.
    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

.NET Framework Security

See Also

Reference

Breakpoint Interface

EnvDTE Namespace