IWordBreakFinder Interface
Provides the base requirements for an object that finds word breaks within an ITextSnapshot.
public interface IWordBreakFinder
Remarks
This interface type can be registered with an ISyntaxLanguage using the RegisterService(Object, Object) method. Once an object that implements this interface is registered with the language for this interface type, its features can be used by the language.
Methods
FindCurrentWordEnd(TextSnapshotOffset)
Returns the ITextSnapshot offset of the word end character that occurs at or after the specified start offset.
int FindCurrentWordEnd(TextSnapshotOffset snapshotOffset)
Parameter | Type | Description |
---|---|---|
snapshotOffset | TextSnapshotOffset | The TextSnapshotOffset from which to start parsing. |
Returns
- Int32:
The ITextSnapshot offset of the word end character that occurs at or after the specified start offset.
FindCurrentWordStart(TextSnapshotOffset)
Returns the ITextSnapshot offset of the word start character that occurs at or before the specified start offset.
int FindCurrentWordStart(TextSnapshotOffset snapshotOffset)
Parameter | Type | Description |
---|---|---|
snapshotOffset | TextSnapshotOffset | The TextSnapshotOffset from which to start parsing. |
Returns
- Int32:
The ITextSnapshot offset of the word start character that occurs at or before the specified start offset.
FindNextWordStart(TextSnapshotOffset)
Returns the ITextSnapshot offset of the word start character that occurs after the specified start offset.
int FindNextWordStart(TextSnapshotOffset snapshotOffset)
Parameter | Type | Description |
---|---|---|
snapshotOffset | TextSnapshotOffset | The TextSnapshotOffset from which to start parsing. |
Returns
- Int32:
The ITextSnapshot offset of the word start character that occurs after the specified start offset.
FindPreviousWordStart(TextSnapshotOffset)
Returns the ITextSnapshot offset of the word start character that occurs before the specified start offset.
int FindPreviousWordStart(TextSnapshotOffset snapshotOffset)
Parameter | Type | Description |
---|---|---|
snapshotOffset | TextSnapshotOffset | The TextSnapshotOffset from which to start parsing. |
Returns
- Int32:
The ITextSnapshot offset of the word start character that occurs before the specified start offset.