EditPoint.DeleteWhitespace Method

Deletes the empty characters (white space) horizontally or vertically around the current location in the text buffer.

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

Syntax

'Declaration
Sub DeleteWhitespace ( _
    Direction As vsWhitespaceOptions _
)

void DeleteWhitespace(
    vsWhitespaceOptions Direction
)

void DeleteWhitespace(
    [InAttribute] vsWhitespaceOptions Direction
)

abstract DeleteWhitespace : 
        Direction:vsWhitespaceOptions -> unit

function DeleteWhitespace(
    Direction : vsWhitespaceOptions
)

Parameters

• Direction
  Type: EnvDTE.vsWhitespaceOptions

  Optional. A vsWhitespaceOptions constant that determines how and where to remove empty spaces.

Remarks

DeleteWhitespace removes white (empty) space around the edit point or TextSelection without first copying the text to the clipboard. If Direction is vsWhitespaceOptionsHorizontal, then DeleteWhitespace deletes spaces and tab characters on both sides of the edit point to the beginning and end of the edit point's line, or until a character that is not white space is encountered. If Direction is vsWhitespaceOptionsVertical, then DeleteWhitespace deletes blank lines on both sides of the edit point to the beginning and end of the document, or until a line that is not blank is encountered. If Direction is vsWhitespaceOptionsVertical, and the current line is not blank, then this method does nothing.

Examples

Sub DeleteWhitespaceExample(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, j As Integer

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

    If MsgBox("Remove all spaces between words?", MsgBoxStyle.YesNo) _
        = MsgBoxResult.Yes Then
        point.StartOfDocument()

        For i = 1 To 10
            For j = 1 To 3
                point.WordRight()
                point.DeleteWhitespace( _
                    vsWhitespaceOptions.vsWhitespaceOptionsHorizontal)
            Next
            point.StartOfLine()
            point.LineDown()
        Next
    End If

End Sub

public void DeleteWhitespaceExample(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");

    if (MessageBox.Show("Remove all spaces between words?", "", 
        MessageBoxButtons.YesNo) == DialogResult.Yes)
    {
        point.StartOfDocument();

        for (int i = 1; i <= 10; ++i)
        {
            for (int j = 1; j <= 3; ++j)
            {
                point.WordRight(1);
                point.DeleteWhitespace(
                    vsWhitespaceOptions.vsWhitespaceOptionsHorizontal);
            }
            point.StartOfLine();
            point.LineDown(1);
        }
    }
}

.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

EditPoint Interface

EnvDTE Namespace

Other Resources

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