Class VirtualConfigLexem

Represents a class that contain virtual lexem configuration.

Inheritance

System.Object

VirtualConfigLexem

Implements

IConfigLexem

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Syncfusion.Windows.Forms.Edit.Implementation.Config

Assembly: Syncfusion.Edit.Windows.dll

Syntax

public class VirtualConfigLexem : IConfigLexem

Remarks

Virtual lexem configuration is such kind of IConfigLexem implementation, when just link to real configuration is kept in memory. Virtual configurations does not support collapsing.

Constructors

VirtualConfigLexem(IConfigLexem)

Initializes a new instance of the VirtualConfigLexem class.

Declaration

public VirtualConfigLexem(IConfigLexem parent)

Parameters

Type	Name	Description
IConfigLexem	parent	Parent config.

Properties

AllowTriggers

Gets a value indicating whether autoreplace triggers can be used in EditControl.

Declaration

public bool AllowTriggers { get; }

Property Value

Type	Description
System.Boolean

BeginBlock

Gets the begin symbol or word for lexem.

Declaration

public string BeginBlock { get; }

Property Value

Type	Description
System.String

Condition

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

Declaration

public string Condition { get; }

Property Value

Type	Description
System.String

ContentDivider

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

Declaration

public bool ContentDivider { get; }

Property Value

Type	Description
System.Boolean

ContinueBlock

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

Declaration

public string ContinueBlock { get; }

Property Value

Type	Description
System.String

DefaultInGroup

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

Declaration

public bool DefaultInGroup { get; }

Property Value

Type	Description
System.Boolean

DropContextChoiceList

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

Declaration

public bool DropContextChoiceList { get; }

Property Value

Type	Description
System.Boolean

Remarks

Can be set only on non-complex lexems.

DropContextPrompt

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

Declaration

public bool DropContextPrompt { get; }

Property Value

Type	Description
System.Boolean

Remarks

Can be set only on non-complex lexems.

EndBlock

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

Declaration

public string EndBlock { get; }

Property Value

Type	Description
System.String

Format

Gets or sets the format based on its type and FormatName.

Declaration

public ISnippetFormat Format { get; }

Property Value

Type	Description
ISnippetFormat

FormatName

Gets the FormatName which must be used for coloring.

Declaration

public string FormatName { get; }

Property Value

Type	Description
System.String

ID

Gets the static unique ID of configuration node.

Declaration

public int ID { get; }

Property Value

Type	Description
System.Int32

Indent

Gets a value indicating whether the auto-indenting after lexem with such config.

Declaration

public bool Indent { get; }

Property Value

Type	Description
System.Boolean

IndentationGuideline

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

Declaration

public bool IndentationGuideline { get; }

Property Value

Type	Description
System.Boolean

IsBeginRegex

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

Declaration

public bool IsBeginRegex { get; }

Property Value

Type	Description
System.Boolean

IsCollapsable

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

Declaration

public bool IsCollapsable { 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

public bool IsComplex { get; }

Property Value

Type	Description
System.Boolean

IsContinueRegex

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

Declaration

public bool IsContinueRegex { get; }

Property Value

Type	Description
System.Boolean

IsEndRegex

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

Declaration

public bool IsEndRegex { get; }

Property Value

Type	Description
System.Boolean

IsPseudoEnd

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

Declaration

public bool IsPseudoEnd { get; }

Property Value

Type	Description
System.Boolean

Language

Gets the Language, lexem belongs to.

Declaration

public IConfigLanguage Language { get; }

Property Value

Type	Description
IConfigLanguage

NextID

Gets the 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

public 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 in its parent.

Declaration

public bool OnlyLocalSublexems { get; }

Property Value

Type	Description
System.Boolean

Parent

Gets the parent of the virtual lexem configuration.

Declaration

public IConfigLexem Parent { get; }

Property Value

Type	Description
IConfigLexem

ParentConfig

Gets the parent configuration of the lexem.

Declaration

public 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

public int Priority { get; }

Property Value

Type	Description
System.Int32

References

Gets the List of references.

Declaration

public ArrayList References { get; }

Property Value

Type	Description
System.Collections.ArrayList

SubLexems

Gets the sub-lexems which must be skipped if they found after BeginBlock string till EndBock string.

Declaration

public ArrayList SubLexems { get; }

Property Value

Type	Description
System.Collections.ArrayList

Type

Gets the FormatType which must be used for coloring. If format is Custom, then use the FormatName property for format identification

Declaration

public FormatType Type { get; }

Property Value

Type	Description
FormatType

TypeCollapsed

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

Declaration

public string TypeCollapsed { get; }

Property Value

Type	Description
System.String

UseCustomControl

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

Declaration

public bool UseCustomControl { get; }

Property Value

Type	Description
System.Boolean

VirtualConfig

Gets the virtual config for current lexem.

Declaration

public IConfigLexem VirtualConfig { get; }

Property Value

Type	Description
IConfigLexem

Remarks

Virtual configs does not support collapsed state.

Methods

FindConfigs(String)

Searches for configs in sub-lexems. If config was not found in sub-lexems, it will be searched in parent.

Declaration

public 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)

Checks whether the specified string is equal to to begin block. If begin block is regular expression, input string will be checked by RegExp.

Declaration

public 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)

Checks whether the specified string is equal to to continue block. If continue block is regular expression, input string will be checked by RegExp.

Declaration

public 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)

Checks whether the specified string is equal to end block. If end block is regular expression, input string will be checked by RegExp.

Declaration

public 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.

Implements

IConfigLexem