EditPoint.SmartFormat Method

Formats the specified range of text based on the current language.

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

Syntax

'Declaration
Sub SmartFormat ( _
    Point As TextPoint _
)

void SmartFormat(
    TextPoint Point
)

void SmartFormat(
    [InAttribute] TextPoint^ Point
)

abstract SmartFormat : 
        Point:TextPoint -> unit

function SmartFormat(
    Point : TextPoint
)

Parameters

• Point
  Type: EnvDTE.TextPoint

  Required. A TextPoint object representing the end of the specified range of text.

Remarks

Smart formatting is autoformatting of code done by the particular language. The edit point and Point are the boundaries for smart formatting. You can select smart formatting options separately for each language under the Text Editor node in the Options dialog box on the Tools menu.

The reformatting includes the lines containing the endpoints and adheres to global settings for smart formatting style (vsSmartFormatOptions).

Examples

Sub SmartFormatExample()
   Dim objTextDoc As TextDocument
   Dim objMovePt As EditPoint
   Dim objEditPt As EditPoint, iCtr As Integer

   ' Create a new text file.
   DTE.ItemOperations.NewFile("General\Text File")

   ' Get a handle to the new document and create an EditPoint.
   objTextDoc = DTE.ActiveDocument.Object("TextDocument")
   objMovePt = objTextDoc.EndPoint.CreateEditPoint
   objEditPt = objTextDoc.StartPoint.CreateEditPoint

   ' Insert ten lines of text.
   For iCtr = 1 To 10
      objEditPt.Insert("This is a test." & Chr(13))
   Next iCtr
   objEditPt.StartOfDocument()
   objMovePt.EndOfDocument()
   objEditPt.SmartFormat(objMovePt)
End Sub

.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