EditPoint.DeleteWhitespace Method (vsWhitespaceOptions)

 

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

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

void DeleteWhitespace(
	vsWhitespaceOptions Direction = vsWhitespaceOptions.vsWhitespaceOptionsHorizontal
)

Parameters

Direction
Type: EnvDTE.vsWhitespaceOptions

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

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.

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);
        }
    }
}
Return to top
Show: