How to: Add Standard Text Markers

Use the following procedure to create one of the default text marker types provided with the Visual Studio core editor.

To create a text marker

1. Depending on whether you are using a one or two- dimensional coordinate system, call the CreateLineMarker method or the CreateStreamMarker method to create a new text marker.

   In this method call, specify a marker type, a range of text to create the marker over, and an IVsTextMarkerClient interface. This method then returns a pointer to the newly created text marker. Marker types are taken from the MARKERTYPE enumeration. Specify an IVsTextMarkerClient interface if you want to be informed of marker events.

   Note

   Create text markers on the main UI thread only. The core editor relies on the contents of the text buffer to create text markers and the text buffer is not thread safe.

Adding a Custom Command

Implementing the IVsTextMarkerClient interface and providing a pointer to it from a marker enhances marker behavior in several ways. First, this allows you to provide tips for your marker and to execute commands. This also allows you to receive event notifications for individual markers and to create a custom context menu over the marker. Use the following procedure to add a custom command to the marker context menu.

To add a custom command to the context menu

1. Before the Context menu is displayed, the environment calls the GetMarkerCommandInfo method and passes you a pointer to the text marker affected and the number of the command item in the context menu.

   For example, the breakpoint-specific commands on the context menu include Remove Breakpoint through New Breakpoint, as displayed in the following screenshot.

   

2. Pass back some text identifying the name of the custom command. For example, Remove Breakpoint might be a custom command if the environment did not already provide it. You also pass back whether the command is supported, available and enabled, and/or an on-off toggle. The environment uses this information to display the custom command in the context menu in the correct way.

3. To execute the command, the environment calls the ExecMarkerCommand method, passing you a pointer to the text marker and the number of the command selected from the context menu.

   Use this information from this call to execute whatever actions of the text marker your custom command dictates.

See Also

Using Text Markers with the Legacy API
How to: Implement Error Markers
How to: Create Custom Text Markers
How to: Use Text Markers