CodeEvent.StartPoint Property

Reference

Definition

Namespace:: EnvDTE80

Assembly:: EnvDTE80.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 property EnvDTE::TextPoint ^ StartPoint { EnvDTE::TextPoint ^ get(); };

public:
 property EnvDTE::TextPoint ^ StartPoint { EnvDTE::TextPoint ^ get(); };

[System.Runtime.InteropServices.DispId(10)]
public EnvDTE.TextPoint StartPoint { [System.Runtime.InteropServices.DispId(10)] [System.Runtime.InteropServices.TypeLibFunc(1024)] get; }

[<System.Runtime.InteropServices.DispId(10)>]
[<get: System.Runtime.InteropServices.DispId(10)>]
[<get: System.Runtime.InteropServices.TypeLibFunc(1024)>]
member this.StartPoint : EnvDTE.TextPoint

Public ReadOnly Property StartPoint As TextPoint

Property Value

TextPoint

A TextPoint object.

Attributes: DispIdAttribute TypeLibFuncAttribute

Examples

The following example demonstrates how to use the StartPoint property.

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");  
}

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.

Applies to

Partager via