TextSelection.PadToColumn Method

Fills the current line in the buffer with empty characters (white space) to the given column.

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

Syntax

'Declaration
Sub PadToColumn ( _
    Column As Integer _
)

void PadToColumn(
    int Column
)

void PadToColumn(
    [InAttribute] int Column
)

abstract PadToColumn : 
        Column:int -> unit

function PadToColumn(
    Column : int
)

Parameters

• Column
  Type: System.Int32

  Required. The number of columns to pad, starting at one.

Remarks

PadToColumn inserts tabs and spaces, according to global settings, from the selection's display column to the specified display column. If the active end of the selection already lies beyond the specified column, PadToColumn does nothing. For TextSelection.PadToColumn, the selection immediately follows the inserted white space and is collapsed.

Examples

Sub PadToColumnExample(ByVal dte As DTE2)

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

    ' Create an EditPoint at the start of the new file.
    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 i

    point.StartOfDocument()

    ' Indent text to column 10.
    For i = 1 To 10
        point.PadToColumn(10)
        point.LineDown()
        point.StartOfLine()
    Next

End Sub

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

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

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

    point.StartOfDocument();

    // Indent text to column 10.
    for (int i = 0; i < 10; i++)
    {
        point.PadToColumn(10);
        point.LineDown(1);
        point.StartOfLine();
    }
}

.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

TextSelection Interface

EnvDTE Namespace

Other Resources

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