EditPoint.DisplayColumn Property

Definition

Namespace:

EnvDTE

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.11.40262

Gets the number of the column number of the EditPoint object.

public:
 property int DisplayColumn { int get(); };

public:
 property int DisplayColumn { int get(); };

[System.Runtime.InteropServices.DispId(14)]
public int DisplayColumn { [System.Runtime.InteropServices.DispId(14)] get; }

[<System.Runtime.InteropServices.DispId(14)>]
[<get: System.Runtime.InteropServices.DispId(14)>]
member this.DisplayColumn : int

Public ReadOnly Property DisplayColumn As Integer

Property Value

Int32

The number of the currently displayed column containing the EditPoint object.

Implements

DisplayColumn

Attributes

DispIdAttribute

Examples

Sub DisplayColumnExample(ByVal dte As DTE2)  

    ' Create a new text file.  
    dte.ItemOperations.NewFile()  

    ' Create an EditPoint at the start of the new document.  
    Dim doc As TextDocument = _  
        CType(dte.ActiveDocument.Object("TextDocument"), TextDocument)  
    Dim point As EditPoint = doc.StartPoint.CreateEditPoint  
    Dim i As Integer  

    ' Insert 10 lines of text.  
    For i = 1 To 10  
        point.Insert("This is a test." & vbCrLf)  
    Next  

    ' Display EditPoint properties.  
    MsgBox( _  
        "AbsoluteCharOffset: " & point.AbsoluteCharOffset & vbCrLf & _  
        "DisplayColumn: " & point.DisplayColumn & vbCrLf & _  
        "AtEndOfDocument: " & point.AtEndOfDocument & vbCrLf & _  
        "AtEndOfLine: " & point.AtEndOfLine & vbCrLf & _  
        "AtStartOfDocument: " & point.AtStartOfDocument & vbCrLf & _  
        "AtStartOfLine: " & point.AtStartOfLine)  

    End Sub  

public void DisplayColumnExample(DTE2 dte)  
{  
    // Create a new text file.  
    dte.ItemOperations.NewFile(@"General\Text File", "",   
        Constants.vsViewKindPrimary);  

    // Create an EditPoint at the start of the new document.  
    TextDocument doc =   
        (TextDocument)dte.ActiveDocument.Object("TextDocument");  
    EditPoint point = doc.StartPoint.CreateEditPoint();  

    // Insert 10 lines of text.  
    for (int i = 1; i <= 10; ++i)  
        point.Insert("This is a test.\n");  

    // Display EditPoint properties.  
    MessageBox.Show(  
        "AbsoluteCharOffset: " + point.AbsoluteCharOffset + "\n" +   
        "DisplayColumn: " + point.DisplayColumn + "\n" +   
        "AtEndOfDocument: " + point.AtEndOfDocument + "\n" +   
        "AtEndOfLine: " + point.AtEndOfLine + "\n" +   
        "AtStartOfDocument: " + point.AtStartOfDocument + "\n" +   
        "AtStartOfLine: " + point.AtStartOfLine);  
}  

Remarks

The column numbering starts at one. The display column may be different from the value of the LineCharOffset if the line contains tab characters. DisplayColumn uses the global setting for tab size to determine the displayed column.