EditPoint2.DisplayColumn Property

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

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

Syntax

'Declaration
ReadOnly Property DisplayColumn As Integer

int DisplayColumn { get; }

property int DisplayColumn {
    int get ();
}

abstract DisplayColumn : int with get

function get DisplayColumn () : int

Property Value

Type: System.Int32
The number of the currently displayed column containing the EditPoint object.

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.

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

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

EditPoint2 Interface

EnvDTE80 Namespace

Other Resources

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