DelimiterIndentProvider Class

public class DelimiterIndentProvider : IIndentProvider, IEditorDocumentTextChangeEventSink

public DelimiterIndentProvider()

public bool CanAutoIndentCurlyBraces { get; set; }

Property Value

bool:

true if curly braces can be auto-indented; otherwise, false. The default value is true.

public bool CanAutoIndentSquareBraces { get; set; }

Property Value

bool:

true if square braces can be auto-indented; otherwise, false. The default value is false.

public int? CloseCurlyBraceTokenId { get; set; }

Property Value

int?:

The optional token ID value used to ensure that a close curly brace character is valid.

Remarks

Leave the value null if token validation is not required for curly braces.

public int CloseDelimiterIndentLevel { get; set; }

Property Value

int:

The additional indent level. The default value is 0.

Remarks

This property can be set to 1 if the close delimiter should be indented one tab stop beyond normal.

public int? CloseSquareBraceTokenId { get; set; }

Property Value

int?:

The optional token ID value used to ensure that a close square brace character is valid.

Remarks

Leave the value null if token validation is not required for square braces.

public virtual IndentMode Mode { get; }

Property Value

IndentMode:

The IndentMode that specifies the mode by which to indent text.

public int? OpenCurlyBraceTokenId { get; set; }

Property Value

int?:

The optional token ID value used to ensure that an open curly brace character is valid.

Remarks

Leave the value null if token validation is not required for curly braces.

public int? OpenSquareBraceTokenId { get; set; }

Property Value

int?:

The optional token ID value used to ensure that an open square brace character is valid.

Remarks

Leave the value null if token validation is not required for square braces.

public virtual int GetIndentAmount(TextSnapshotOffset snapshotOffset, int defaultAmount)

Parameter	Type	Description
snapshotOffset	TextSnapshotOffset	The TextSnapshotOffset whose line should be examined.
defaultAmount	int	The default indent amount, which is the amount used in Block mode.

Returns

int:

The ideal amount of indent, always in columns, for the line containing the snapshot offset.

Remarks

This method is called when the IndentMode is Smart. The containing ITextDocument is accessible via the snapshot range's ITextSnapshot.

protected virtual bool IsValidEndDelimiter(IToken token, char endDelimiter)

Parameter	Type	Description
token	IToken	The IToken to examine.
endDelimiter	char	The end delimiter.

Returns

bool:

true if the IToken represents the specified end delimiter; otherwise, false.

Remarks

The default implementation of this method compares the token ID to the ID specified in the CloseCurlyBraceTokenId property. This method is called when determining whether to perform delimiter auto-indent.

protected virtual bool IsValidStartDelimiter(IToken token, char startDelimiter)

Parameter	Type	Description
token	IToken	The IToken to examine.
startDelimiter	char	The start delimiter.

Returns

bool:

true if the IToken represents the specified start delimiter; otherwise, false.

Remarks

The default implementation of this method compares the token ID to the ID specified in the OpenCurlyBraceTokenId property. This method is called when determining whether to perform delimiter auto-indent.

protected virtual void OnDocumentTextChanged(SyntaxEditor editor, EditorSnapshotChangedEventArgs e)

Parameter	Type	Description
editor	SyntaxEditor	The SyntaxEditor whose IEditorDocument is changed.
e	EditorSnapshotChangedEventArgs	The EditorSnapshotChangedEventArgs that contains the event data.

protected virtual void OnDocumentTextChanging(SyntaxEditor editor, EditorSnapshotChangingEventArgs e)

Parameter	Type	Description
editor	SyntaxEditor	The SyntaxEditor whose IEditorDocument that is changing.
e	EditorSnapshotChangingEventArgs	The EditorSnapshotChangingEventArgs that contains the event data.