Interface IConfigLexem

Provides the functionality for lexem to control parsing of input stream.

Namespace: Syncfusion.Windows.Forms.Edit.Interfaces

Assembly: Syncfusion.Edit.Windows.dll

Syntax

public interface IConfigLexem

Properties

AllowTriggers

Gets a value indicating whether autoreplace triggers can be used or not.

Declaration

bool AllowTriggers { get; }

Property Value

Type	Description
System.Boolean

BeginBlock

Gets the begin symbol or word for lexem.

Declaration

string BeginBlock { get; }

Property Value

Type	Description
System.String

Condition

Gets the condition, needed to check the format. Format: name=ON|OFF

Declaration

string Condition { get; }

Property Value

Type	Description
System.String

ContentDivider

Gets a value indicating whether content divider should be shown below lexem or not.

Declaration

bool ContentDivider { get; }

Property Value

Type	Description
System.Boolean

ContinueBlock

If lexem can be divided on multi lines or has some special rules which can continue lexem then us this setting.

Declaration

string ContinueBlock { get; }

Property Value

Type	Description
System.String

DefaultInGroup

Gets a value indicating if lexem should be used if there are more than one config found on one priority level.

Declaration

bool DefaultInGroup { get; }

Property Value

Type	Description
System.Boolean

DropContextChoiceList

Gets a value indicating whether the dropping down context choice list after entering text of the current lexem.

Declaration

bool DropContextChoiceList { get; }

Property Value

Type	Description
System.Boolean

Remarks

Can be set only on non-complex lexems.

DropContextPrompt

Get a value indicating whether context prompt should be shown after typing text of the current lexem or not.

Declaration

bool DropContextPrompt { get; }

Property Value

Type	Description
System.Boolean

Remarks

Can be set only on non-complex lexems.

EndBlock

Gets the end symbol or word for lexem when it contains both begin and end block. If lemex is "keyword" then this property must be set to null value.

Declaration

string EndBlock { get; }

Property Value

Type	Description
System.String

Format

Gets the format by Type and FormatName.

Declaration

ISnippetFormat Format { get; }

Property Value

Type	Description
ISnippetFormat

FormatName

Gets the format name which must be used for coloring.

Declaration

string FormatName { get; }

Property Value

Type	Description
System.String

ID

Gets the static unique ID of configuration node.

Declaration

int ID { get; }

Property Value

Type	Description
System.Int32

Indent

Gets the sign of auto-indenting after lexem with such config.

Declaration

bool Indent { get; }

Property Value

Type	Description
System.Boolean

IndentationGuideline

Gets a value indicating whether IndentationGuideline should be shown or not.

Declaration

bool IndentationGuideline { get; }

Property Value

Type	Description
System.Boolean

IsBeginRegex

Gets a value indicating whether the BeginBlock property contains Regular expression or not.

Declaration

bool IsBeginRegex { get; }

Property Value

Type	Description
System.Boolean

IsComplex

Gets a value indicating whether the parser parse lexem internals or not. For complex constructions data between begin and end blocks can have own formats.

Declaration

bool IsComplex { get; }

Property Value

Type	Description
System.Boolean

IsContinueRegex

Gets a value indicating whether the ContinueBlock property contains Regular expression or not.

Declaration

bool IsContinueRegex { get; }

Property Value

Type	Description
System.Boolean

IsEndRegex

Gets a value indicating whether the EndBlock property contains Regular expression or not.

Declaration

bool IsEndRegex { get; }

Property Value

Type	Description
System.Boolean

IsPseudoEnd

Gets a value indicating whether the the end-block just the way to exit higher by stack, or it is real ending of lexem.

Declaration

bool IsPseudoEnd { get; }

Property Value

Type	Description
System.Boolean

Language

Gets the language, lexem belongs to.

Declaration

IConfigLanguage Language { get; }

Property Value

Type	Description
IConfigLanguage

NextID

GET ID of the lexem configuration, that follows right after current one is parsed. Such lexem must be complex and "OnlyLocalSublexems", without beginblock and with endblock.

Declaration

int NextID { get; }

Property Value

Type	Description
System.Int32

OnlyLocalSublexems

Gets a value indicating whether the parser should look for lexem`s config just in local array or also look into its parents.

Declaration

bool OnlyLocalSublexems { get; }

Property Value

Type	Description
System.Boolean

ParentConfig

Gets the parent configuration who keeps the current lexem.

Declaration

IConfigLexem ParentConfig { get; }

Property Value

Type	Description
IConfigLexem

Priority

Gets the priority when it contains many lexems that has the same begin string then on parsing must be controlled order in which lexem parser will try to interpret input as lexem.

Declaration

int Priority { get; }

Property Value

Type	Description
System.Int32

References

Gets the list of references of lexems.

Declaration

ArrayList References { get; }

Property Value

Type	Description
System.Collections.ArrayList

SubLexems

Gets the specific sublexems for complex lexem.

Declaration

ArrayList SubLexems { get; }

Property Value

Type	Description
System.Collections.ArrayList

Type

Gets the format type which must be used for coloring. If format is Custom then uses the FormatName property for format identification.

Declaration

FormatType Type { get; }

Property Value

Type	Description
FormatType

TypeCollapsed

Gets the name of the format to be used in collapsed state.

Declaration

string TypeCollapsed { get; }

Property Value

Type	Description
System.String

UseCustomControl

Gets a value indicating if custom control should be used instead of the simple lexem rendering or not.

Declaration

bool UseCustomControl { get; }

Property Value

Type	Description
System.Boolean

VirtualConfig

Gets the link to the virtual configuration for current lexem.

Declaration

IConfigLexem VirtualConfig { get; }

Property Value

Type	Description
IConfigLexem

Remarks

Gets the virtual configs does not support collapsed state.

Methods

FindConfigs(String)

Searches for configs in sub-lexems. Current lexem config is not tested for equalization. If config was not found in sub-lexems, it will be searched in parent.

Declaration

IList FindConfigs(string str)

Parameters

Type	Name	Description
System.String	str	String to find.

Returns

Type	Description
System.Collections.IList	List of config lexems.

IsEqualToBegin(String)

Gets a value indicating whether the string is equal to begin block or not. If begin block is regular expression, input string will be checked by RegExp

Declaration

bool IsEqualToBegin(string str)

Parameters

Type	Name	Description
System.String	str	String to be checked

Returns

Type	Description
System.Boolean	True if it can be treated as begin block.

IsEqualToContinue(String)

Gets a value indicating whether the string is equal to continue block or not. If continue block is regular expression, input string will be checked by RegExp

Declaration

bool IsEqualToContinue(string str)

Parameters

Type	Name	Description
System.String	str	String to be checked

Returns

Type	Description
System.Boolean	True if it can be treated as continue block.

IsEqualToEnd(String)

Gets a value indicating whether the string is equal to end block or not. If end block is regular expression, input string will be checked by RegExp

Declaration

bool IsEqualToEnd(string str)

Parameters

Type	Name	Description
System.String	str	String to be checked

Returns

Type	Description
System.Boolean	True if it can be treated as end block.