Lexem Documentation - more Verbose

[Marty Honea]

Can we get some more verbose documentation on the Lexem class in it's properties?

 

Namely LexemType, ScopeLevel, thier enums and what setting the different enums means to the Edit control?

 

By Trial and error, I've found out that setting the LexemType to EditTokenType.Keyword or EditTokenType.Operator doesn't put the Lexem in intellisense, but EditTokenType.CodeSnippet does.

 

I'm still not sure what ScopeLevel does.

[Marty Honea]

It appears NamespaceDeclaration and Preprocessor types get added to Intellisense also.

[Marty Honea]

In addition to this Forum Post, I sent several emails to Syncfusion reguarding the Lexem Documentation. Here is the text of the repsonse I recieved. I'm sure there will be others who will benefit from this being posted here.

 

Hi Marty,

 

We’re apologize for this issue. We assure you that we will take your comments into consideration and use them to improve our documentation. We have consolidated your queries in this message and addressed them below. Please let us know if we can be of further assistance.

 

Sincerely,

Syncfusion Documentation

 

----------------------------------------------------------

Lexem.ScopeLevel Property

 

1. What does the property control?

ScopeLevel is used to group your Lexem with Start and End Text. With Start Text set to “class” and End Text=”}”, and by setting ScopeLevel=”Class”, the Lexem will group the line based on the Start and End Text.

 

2. What does setting this property do to its parent?

The parent will get the following look and feel when ScopeLevel is set to “Class” and Start Text=”class” End Text=”}”. This is considered a single scope.

 

 

 

3. What are the uses for the different enumerations that can be used when setting this property?

 

None - This Lexem does not group the line based on Start and End Text.

 

Namespace - This Lexem groups the line based on Start Text=”namespace” and End Text=”End namespace or}” when ScopeLevel=”namespace”.

 

Class - This Lexem groups the line based on the Start Text=”class” and End Text=”End Class or}” when ScopeLevel=”Class”.

 

Member - This Lexem groups the line based on Start Text=”public, private, protected, or internal” and End Text=”}” when ScopeLevel=”Member”.

 

StaticMember - This Lexem groups the line based on Start Text=”public, private, protected, or internal” and End Text=”}” when ScopeLevel=”namespace”.

 

4. What is the default value?

 

The default value of ScopeLevel is None.

 

5. Is this set in conjunction with other properties?

a)      Start Text and End Text need to be set for the Lexems.

b)      ContainsEndText needs to be set to true for the Lexems.

 

 

 

Lexem.LexemType Property

 

1. What does the property control?

This property is used to set the correct formatter for the Lexem. When Lexem StartText is set to “class” and LexemType is set to the “Comment”, the word “class” will have the corresponding color.

 

2. What does setting this property do to its parent?

                The parent will have the following look and feel when LexemType is set to “comment”.

 

 

3. What are the uses for the different enumerations that can be used when setting this property?

 

Literals - Setting the look and feel for the StartText of Lexem to be the same as literals in C#.

Keyword - Setting the look and feel for the StartText of Lexem to be the same as keywords in C#.

Comment - Setting the look and feel for the StartText of Lexem to be the same as comments in C#.

Operator - Setting the look and feel for the StartText of Lexem to be the same as operators in C#.

Preprocessor - Setting the look and feel for the StartText of Lexem to be the same as preprocessors in C#.

Custom: referring - Setting the look and feel for the StartText of Lexem by the custom formatter.

CodeSnippet - Setting the look and feel for the StartText of Lexem to be the same as code snippets in C#.

Property - Setting the look and feel for the StartText of Lexem to be the same as a property in C#.

NamespaceDeclaration - Setting the look and feel for the StartText of Lexem to be the same as a namespace in C#.

 

4. What is the default value?

The default value of LexemType is Literals.

 

5. Is this set in conjunction with other properties?

                StartText needs to be set for the Lexem.

 

Lexem.IntellisenseDisplayText Property

1. When is this property used?

 This property is used to display custom DisplayText when IntelliSense is showing.

 

2. What other properties in the class prevent this from being displayed?

By setting the ShowAlternateIntellisenseText property to false, you can prevent it from being displayed.

 

 

[Antony Xavier D]

Hi Marty,

Thanks for your update.

Please let us know if you need any further assistance.

Regards,
Antony.