C# Class Alsing.SourceCode.Row

The row class represents a row in a SyntaxDocument
Inheritance: IEnumerable
Mostra file Open project: vchelaru/FlatRedBall Class Usage Examples

Public Properties

Property Type Description
Document SyntaxDocument
Expansion_EndChar int
Expansion_PixelEnd int
Expansion_PixelStart int
Expansion_StartChar int
FormattedWords WordList
Images ImageIndexList
InKeywordQueue bool
InQueue bool
Indent int
Tag object
endSpan Span
endSpans SpanList
expansion_EndSpan Span
expansion_StartSpan Span
startSpan Span
startSpans SpanList

Public Methods

Method Description
Add ( string text ) : Word
Add ( Word word ) : void

Adds a word object to this row

AddToParseQueue ( ) : void

Adds this row to the parse queue

Clear ( ) : void
EnsureVisible ( ) : void

If the row is hidden inside a collapsed span , call this method to make the collapsed segments expanded.

FindLeftWordByBlockType ( SpanDefinition spanDefinition, Word StartWord, bool IgnoreStartWord ) : Word

For public use only

FindLeftWordByBlockTypeName ( string BlockTypeName, Word StartWord, bool IgnoreStartWord ) : Word

For public use only

FindLeftWordByPatternList ( PatternList PatternList, Word StartWord, bool IgnoreStartWord ) : Word

For public use only

FindLeftWordByPatternListName ( string PatternListName, Word StartWord, bool IgnoreStartWord ) : Word

For public use only

FindRightWordByBlockType ( SpanDefinition spanDefinition, Word StartWord, bool IgnoreStartWord ) : Word

For public use only

FindRightWordByBlockTypeName ( string BlockTypeName, Word StartWord, bool IgnoreStartWord ) : Word

For public use only

FindRightWordByPatternList ( PatternList PatternList, Word StartWord, bool IgnoreStartWord ) : Word

For public use only

FindRightWordByPatternListName ( string PatternListName, Word StartWord, bool IgnoreStartWord ) : Word

For public use only

GetEnumerator ( ) : IEnumerator

Get the Word enumerator for this row

GetLeadingWhitespace ( ) : string

Returns the whitespace string at the begining of this row.

GetVirtualLeadingWhitespace ( ) : string
IndexOf ( Word word ) : int

Returns the index of a specific Word object

MatchCase ( ) : void

Call this method to make all words match the case of their patterns. (this only applies if the row is fully parsed)

Parse ( ) : void

Force a span parse on the row.

Parse ( bool ParseKeywords ) : void

Forces the parser to parse this row directly

SetExpansionSegment ( ) : void
SetText ( string text ) : void

Assigns a new text to the row.

this ( int index ) : Word

Return the Word object at the specified index.

Method Details

Add() public method

public Add ( string text ) : Word
text string
return Word

Add() public method

Adds a word object to this row
public Add ( Word word ) : void
word Word Word object
return void

AddToParseQueue() public method

Adds this row to the parse queue
public AddToParseQueue ( ) : void
return void

Clear() public method

public Clear ( ) : void
return void

EnsureVisible() public method

If the row is hidden inside a collapsed span , call this method to make the collapsed segments expanded.
public EnsureVisible ( ) : void
return void

FindLeftWordByBlockType() public method

For public use only
public FindLeftWordByBlockType ( SpanDefinition spanDefinition, Word StartWord, bool IgnoreStartWord ) : Word
spanDefinition SpanDefinition
StartWord Word
IgnoreStartWord bool
return Word

FindLeftWordByBlockTypeName() public method

For public use only
public FindLeftWordByBlockTypeName ( string BlockTypeName, Word StartWord, bool IgnoreStartWord ) : Word
BlockTypeName string
StartWord Word
IgnoreStartWord bool
return Word

FindLeftWordByPatternList() public method

For public use only
public FindLeftWordByPatternList ( PatternList PatternList, Word StartWord, bool IgnoreStartWord ) : Word
PatternList PatternList
StartWord Word
IgnoreStartWord bool
return Word

FindLeftWordByPatternListName() public method

For public use only
public FindLeftWordByPatternListName ( string PatternListName, Word StartWord, bool IgnoreStartWord ) : Word
PatternListName string
StartWord Word
IgnoreStartWord bool
return Word

FindRightWordByBlockType() public method

For public use only
public FindRightWordByBlockType ( SpanDefinition spanDefinition, Word StartWord, bool IgnoreStartWord ) : Word
spanDefinition SpanDefinition
StartWord Word
IgnoreStartWord bool
return Word

FindRightWordByBlockTypeName() public method

For public use only
public FindRightWordByBlockTypeName ( string BlockTypeName, Word StartWord, bool IgnoreStartWord ) : Word
BlockTypeName string
StartWord Word
IgnoreStartWord bool
return Word

FindRightWordByPatternList() public method

For public use only
public FindRightWordByPatternList ( PatternList PatternList, Word StartWord, bool IgnoreStartWord ) : Word
PatternList PatternList
StartWord Word
IgnoreStartWord bool
return Word

FindRightWordByPatternListName() public method

For public use only
public FindRightWordByPatternListName ( string PatternListName, Word StartWord, bool IgnoreStartWord ) : Word
PatternListName string
StartWord Word
IgnoreStartWord bool
return Word

GetEnumerator() public method

Get the Word enumerator for this row
public GetEnumerator ( ) : IEnumerator
return IEnumerator

GetLeadingWhitespace() public method

Returns the whitespace string at the begining of this row.
public GetLeadingWhitespace ( ) : string
return string

GetVirtualLeadingWhitespace() public method

public GetVirtualLeadingWhitespace ( ) : string
return string

IndexOf() public method

Returns the index of a specific Word object
public IndexOf ( Word word ) : int
word Word Word object to find
return int

MatchCase() public method

Call this method to make all words match the case of their patterns. (this only applies if the row is fully parsed)
public MatchCase ( ) : void
return void

Parse() public method

Force a span parse on the row.
public Parse ( ) : void
return void

Parse() public method

Forces the parser to parse this row directly
public Parse ( bool ParseKeywords ) : void
ParseKeywords bool true if keywords and operators should be parsed
return void

SetExpansionSegment() public method

public SetExpansionSegment ( ) : void
return void

SetText() public method

Assigns a new text to the row.
public SetText ( string text ) : void
text string
return void

this() public method

Return the Word object at the specified index.
public this ( int index ) : Word
index int
return Word

Property Details

Document public_oe property

The owner document
public SyntaxDocument,Alsing.SourceCode Document
return SyntaxDocument

Expansion_EndChar public_oe property

For public use only
public int Expansion_EndChar
return int

Expansion_PixelEnd public_oe property

For public use only
public int Expansion_PixelEnd
return int

Expansion_PixelStart public_oe property

For public use only
public int Expansion_PixelStart
return int

Expansion_StartChar public_oe property

For public use only
public int Expansion_StartChar
return int

FormattedWords public_oe property

public WordList FormattedWords
return WordList

Images public_oe property

Collection of Image indices assigned to a row.
public ImageIndexList Images
return ImageIndexList

InKeywordQueue public_oe property

Returns true if the row is in the owner documents keyword parse queue
public bool InKeywordQueue
return bool

InQueue public_oe property

Returns true if the row is in the owner documents parse queue
public bool InQueue
return bool

Indent public_oe property

For public use only
public int Indent
return int

Tag public_oe property

Object tag for storage of custom user data..
public object Tag
return object

endSpan public_oe property

The first span that terminates on this row.
public Span,Alsing.SourceCode endSpan
return Span

endSpans public_oe property

Segments that ends in this row
public SpanList endSpans
return SpanList

expansion_EndSpan public_oe property

public Span,Alsing.SourceCode expansion_EndSpan
return Span

expansion_StartSpan public_oe property

public Span,Alsing.SourceCode expansion_StartSpan
return Span

startSpan public_oe property

The first collapsable span on this row.
public Span,Alsing.SourceCode startSpan
return Span

startSpans public_oe property

Segments that start on this row
public SpanList startSpans
return SpanList