Share via

CodeEvent.StartPoint Property

  • Article

Gets the location in the source file marked as a beginning of the code event element.

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

Syntax

'Declaration
ReadOnly Property StartPoint As TextPoint

TextPoint StartPoint { get; }

property TextPoint^ StartPoint {
    TextPoint^ get ();
}

abstract StartPoint : TextPoint with get

function get StartPoint () : TextPoint

Property Value

Type: EnvDTE.TextPoint
A TextPoint object.

Remarks

The edit point location is immediately after the last character of the code event element (including any semicolon, terminating syntax, or separating syntax). Getting the property implicitly opens the source file if it can be opened. Some languages, however, cannot open arbitrary files on the disk and can only open files in currently open solution.

Note

The values of code model elements such as classes, structs, functions, attributes, delegates, and so forth can be non-deterministic after making certain kinds of edits, meaning that their values cannot be relied upon to always remain the same. For more information, see the section Code Model Element Values Can Change in Discovering Code by Using the Code Model (Visual Basic).

Examples

The following example demonstrates how to use the StartPoint property.

To test this property:

  1. Open the target project and select the code event element by placing the cursor on the event object.

  2. Run the add-in.

public static void StartPoint(EnvDTE80.DTE2 dte)
{
    TextSelection objTextSel;
    EnvDTE80.CodeEvent codeEvent;
    objTextSel = (TextSelection)dte.ActiveDocument.Selection;
    codeEvent = (EnvDTE80.CodeEvent)objTextSel.ActivePoint.get_CodeElement(vsCMElement.vsCMElementEvent);

    MessageBox.Show("\nStart point column number: " +
                    codeEvent.StartPoint.DisplayColumn, "Testing StartPoint Property");
}

.NET Framework Security

See Also

Reference

CodeEvent Interface

EnvDTE80 Namespace

Other Resources

How to: Compile and Run the Automation Object Model Code Examples

Discovering Code by Using the Code Model (Visual Basic)

Discovering Code by Using the Code Model (Visual C#)