Interface ILexemParser
Provides the basic functionality of each Lexem parser for our control.
Namespace: Syncfusion.Windows.Forms.Edit.Interfaces
Assembly: Syncfusion.Edit.Windows.dll
Syntax
public interface ILexemParserProperties
BaseStream
Gets the reference on base stream which used as source for Parser.
Declaration
StreamsWrapper BaseStream { get; }Property Value
| Type |
|---|
| StreamsWrapper |
CurrentLine
Gets the current line index. This property can be used for fast move to need line in file.
Declaration
int CurrentLine { get; set; }Property Value
| Type |
|---|
| System.Int32 |
Formats
Gets the collection of available formats. Reference on base collection of formats.
Declaration
IFormatManager Formats { get; }Property Value
| Type |
|---|
| IFormatManager |
TotalLines
Gets the quantity of lines in input stream.
Declaration
int TotalLines { get; }Property Value
| Type |
|---|
| System.Int32 |
Methods
GetCoordinatePoint(IParsePoint)
Gets CoordinatePoint by given IParsePoint.
Declaration
CoordinatePoint GetCoordinatePoint(IParsePoint point)Parameters
| Type | Name | Description |
|---|---|---|
| IParsePoint | point | IParsePoint that points to physical position in stream. |
Returns
| Type | Description |
|---|---|
| CoordinatePoint | CoordinatePoint that points to the given position. |
GetCoordinatePoint(IParsePoint, Boolean)
Gets CoordinatePoint by given IParsePoint.
Declaration
CoordinatePoint GetCoordinatePoint(IParsePoint point, bool bRedirectToStart)Parameters
| Type | Name | Description |
|---|---|---|
| IParsePoint | point | IParsePoint that points to physical position in stream. |
| System.Boolean | bRedirectToStart |
Returns
| Type | Description |
|---|---|
| CoordinatePoint | CoordinatePoint that points to the given position. |
GetCoordinatePoint(IParsePoint, Boolean, Boolean)
Gets CoordinatePoint by given IParsePoint.
Declaration
CoordinatePoint GetCoordinatePoint(IParsePoint point, bool bRedirectToStart, bool bTrackPosition)Parameters
| Type | Name | Description |
|---|---|---|
| IParsePoint | point | IParsePoint that points to physical position in stream. |
| System.Boolean | bRedirectToStart | |
| System.Boolean | bTrackPosition | Specifies whether coordinate point should track position. |
Returns
| Type | Description |
|---|---|
| CoordinatePoint | CoordinatePoint that points to the given position. |
GetCoordinatePoint(Int32, Int32)
Gets CoordinatePoint class instance, that represents some coordinates in stream.
Declaration
CoordinatePoint GetCoordinatePoint(int iLine, int iColumn)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iLine | Virtual line. |
| System.Int32 | iColumn | Virtual column. |
Returns
| Type | Description |
|---|---|
| CoordinatePoint | CoordinatePoint class instance. |
GetEnumerator(ConfigStack)
Gets the enumerator of lexems.
Declaration
IEnumerator GetEnumerator(ConfigStack stack)Parameters
| Type | Name | Description |
|---|---|---|
| ConfigStack | stack | Stack for the current position. |
Returns
| Type |
|---|
| System.Collections.IEnumerator |
GetEnumerator(ConfigStack, IParsePoint)
Gets the enumerator of lexems.
Declaration
IEnumerator GetEnumerator(ConfigStack stack, IParsePoint point)Parameters
| Type | Name | Description |
|---|---|---|
| ConfigStack | stack | Stack for the current position. |
| IParsePoint | point | New current position. |
Returns
| Type |
|---|
| System.Collections.IEnumerator |
GetLine()
Get the current line lexems.
Declaration
IList GetLine()Returns
| Type | Description |
|---|---|
| System.Collections.IList | lexems array of current line |
GetLineEnumerator()
Gets the enumerator of the lexem lines.
Declaration
IEnumerator GetLineEnumerator()Returns
| Type | Description |
|---|---|
| System.Collections.IEnumerator | Enumerator. |
GetLineEnumerator(ILexemLine)
Gets the enumerator of the lexem lines.
Declaration
IEnumerator GetLineEnumerator(ILexemLine line)Parameters
| Type | Name | Description |
|---|---|---|
| ILexemLine | line | Starting line. |
Returns
| Type | Description |
|---|---|
| System.Collections.IEnumerator | Enumerator. |
GetNearestParsePointLeft(Int32, Int32)
Searches for the IParsePoint at the given position.
Declaration
CoordinatePoint GetNearestParsePointLeft(int iLine, int iColumn)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iLine | Line index the ParsePoint is needed for. |
| System.Int32 | iColumn | Column index the ParsePoint is needed for. Can be 0. |
Returns
| Type | Description |
|---|---|
| CoordinatePoint | ParsePoint to the given position. |
Remarks
If it can not be found ( or column is 0), and if it is in virtual space, then you will get parse point to the end of given line; If column is 0, then you will get parse point to the end of the previous line( if it is one ).
GetNearestParsePointRight(Int32, Int32)
Searches for the IParsePoint at the given position.
Declaration
CoordinatePoint GetNearestParsePointRight(int iLine, int iColumn)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iLine | Line index, the ParsePoint is needed for. |
| System.Int32 | iColumn | Column index, the ParsePoint is needed for. Can be 0. |
Returns
| Type | Description |
|---|---|
| CoordinatePoint | ParsePoint to the given position. |
Remarks
If it can not be found (it is in virtual space), then you will get parse point, pointing to the beginning of the next line. If it can not be done, ParsePoint, pointing to the end of current line will be returned.
NextLine()
Reads the next line from input stream and set CurrentLine index to new value.
Declaration
IList NextLine()Returns
| Type | Description |
|---|---|
| System.Collections.IList | array of lexems in line, null if end of stream reached |
PreviousLine()
Read the previous line from input stream and set CurrentLine index to new value. When method reach start of stream it will return first line lexems only and will not change CurrentLine property to new value.
Declaration
IList PreviousLine()Returns
| Type | Description |
|---|---|
| System.Collections.IList | array of lexems |