C# Class ICSharpCode.NRefactory.CSharp.CSharpFormatter

The C# Formatter generates a set of text replace actions to format a region in a C# document.

Public Methods

Method	Description
AddFormattingRegion ( DomRegion region ) : void	Adds a region in the document that should be formatted.
AnalyzeFormatting ( IDocument document, SyntaxTree syntaxTree, CancellationToken token = default(CancellationToken) ) : FormattingChanges	Analyzes the formatting of a given document and syntax tree.
CSharpFormatter ( CSharpFormattingOptions policy, ICSharpCode.NRefactory.CSharp.TextEditorOptions options = null ) : System	Initializes a new instance of the ICSharpCode.NRefactory.CSharp.CSharpFormatter class.
Format ( IDocument document ) : string	Format the specified document and gives back the formatted text as result.
Format ( string text ) : string	Format the specified text and gives back the formatted text as result.

Method	Description
InternalFormat ( IDocument document ) : string

Adds a region in the document that should be formatted.

public AddFormattingRegion ( DomRegion region ) : void
region	DomRegion
return	void

Analyzes the formatting of a given document and syntax tree.

public AnalyzeFormatting ( IDocument document, SyntaxTree syntaxTree, CancellationToken token = default(CancellationToken) ) : FormattingChanges
document	IDocument	Document.
syntaxTree	SyntaxTree	Syntax tree.
token	System.Threading.CancellationToken	The cancellation token.
return	FormattingChanges

Initializes a new instance of the ICSharpCode.NRefactory.CSharp.CSharpFormatter class.

public CSharpFormatter ( CSharpFormattingOptions policy, ICSharpCode.NRefactory.CSharp.TextEditorOptions options = null ) : System
policy	CSharpFormattingOptions	The formatting policy to use.
options	ICSharpCode.NRefactory.CSharp.TextEditorOptions	The text editor options (optional). Default is: TextEditorOptions.Default
return	System

Format the specified document and gives back the formatted text as result.

public Format ( IDocument document ) : string
document	IDocument
return	string

Format the specified text and gives back the formatted text as result.

public Format ( string text ) : string
text	string
return	string