0% found this document useful (0 votes)
53 views14 pages

Code Editor Configuration Guide

The document discusses code editor configuration files for Enterprise Architect. Configuration files are located in the Config directory and contain properties to customize code editor features. Properties are organized by type and category, with general properties applying across languages and lexer-specific properties styling language elements. Configuration is done by assigning key-value pairs in the files.

Uploaded by

Active88
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
53 views14 pages

Code Editor Configuration Guide

The document discusses code editor configuration files for Enterprise Architect. Configuration files are located in the Config directory and contain properties to customize code editor features. Properties are organized by type and category, with general properties applying across languages and lexer-specific properties styling language elements. Configuration is done by assigning key-value pairs in the files.

Uploaded by

Active88
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd

Code Editor Configuration

A variety of code editor features can be customized through setting properties in the code
editor configuration files.

Configuration Files
Code editor configuration files are located in the Configdirectory under the Enterprise
Architect installation directory. The Config directory contains a configuration file for
each language supported by Enterprise Architect.

Loading of code editor properties is done in two steps


1. The global configuration file global.propertiesis parsed
2. The language specific configuration file (eg javaSyntax.properties,
cppSyntax.properties) is parsed. In the event that a property assignment
is specified in both the global and language specific configuration, the language
specific version will be used. Thus the language specific configuration file can be
used to override any properties set in the global configuration file.

The configuration file syntax consists of one key/value pair per line. The key and value
are seperated by the equals (=) operator. Lines that begin with the hash (#) or exclamation
(!) symbols are regarded as comment lines and are not parsed.

NOTE: Property assignments that span over multiple lines are not supported.

Configuration Property Types


A Configuration Property will have a certain type, which determines the format its value
should take. The table below lists the set of valid Configuration Property Types

Type Description
boolean Either true or false
number Any numeric value
string A sequence of characters that form a string literal
style A list of style elements delimited by a comma (,). Colors are
defined in HTML notation (eg #FFFFFF)

Valid style elements are:


● font:fontname
● size:fontsize
● fore:color
● back:color
● bold
● italic
● eolfilled
Configuration Properties
Configuration properties fall into either one of two categories: GeneralPropertiesor
Lexer Specific Properties.

The lexer is the mechanism used to lexically analyze the editor contents and advise the
editor to apply various styles according to its rules. Generally a lexer applies to a specific
language, however semantically similar languages (such as C++ and Java) may share
lexers.

A lexer will often define its own unique set of style classes (eg operators, keywords,
pragma statements). Thus Lexer SpecificProperties specify how these unique classes are
to be styled.

Conversely, General Properties can be set in all configuration files regardless of which
lexer is used.

General Properties
Property Type Description
AUTO_BRACKETS boolean Specifies whether a terminating bracket is
automatically entered when an opening bracket is
typed.
BRACE_HIGHLIGHTING boolean Specifies whether automatic brace highlighting is
performed.

Automatic brace highlighting will visually


highlight both the brace that the cursor neighbours
and its matching brace.
COMMENT_LINECOMMENT_TOKEN string Specifies the token to be added to the start of a line
when it is block commented (CTRL-SHIFT-C)
COMMENT_STREAMCOMMENTSTART_TOKEN string Specifies the token to be added to the start of the
selection when it is stream commented (CTRL-
SHIFT-X).
COMMENT_STREAMCOMMENTEND_TOKEN string Specifies the token to be added to the end of the
selection when it is stream commented (CTRL-
SHIFT-X).
FOLD_AT_ELSE boolean Specifies whether the folding routine will create a
new foldable code section for each else
if/else in an if block.
FOLD_COMMENT boolean Specifies whether the folding routine will treat
comments as foldable code sections.
FOLD_COMPACT boolean Specifies whether the folding routine will consider
blank lines.
FOLD_PREPROCESSOR boolean Specifies whether the folding routine will treat
preprocessor statements as foldable code sections.
LEXER string Instructs the editor to use the specified lexer to
decorate the editor contents. The choice of lexer
determines which set of lexer specific properties
can be set.
Supported lexers are:
● ada
● bat
● cpp
● diff
● eacgt
● html
● mbnf
● pascal
● props
● python
● sql
● vb
● vbscript
● verilog
● vhdl
● xml
INDENT_AUTOMATIC boolean Specifies whether the editor will perform automatic
indentation, based on the scope of the current
control block.

Please consult the property definitions for the


following properties for further customization:
INDENT_BLOCK_START_CHAR
INDENT_BLOCK_END_CHAR
INDENT_STATEMENT_END
INDENT_STATEMENT_KEYWORDS
INDENT_STATEMENT_LOOKBACK
INDENT_BLOCK_START_CHAR string Specifies the token that is used to open a control
block (usually an open brace).

This value is used for calculating automatic


indentation.
INDENT_BLOCK_END_CHAR string Specifies the token that is used to terminate a
control block (usually an closing brace).

This value is used for calculating automatic


indentation.
INDENT_GUIDES boolean Specifies whether vertical guides are drawn at each
indent on the line.

Indent guides can be useful in identifying the scope


of control blocks if they are correctly indented.
INDENT_STATEMENT_END string Specifies the token used to end a statement.

This value is used for calculating automatic


indentation.
INDENT_STATEMENT_KEYWORDS string A space seperated list of keywords that should
cause an increase in indentation if the control block
is not terminated on the same line.
For example:
case default do else for if
private protected public while
INDENT_STATEMENT_LOOKBACK number Specifies the maximum number of lines the editor
will check back on when calculating automatic
indentation.
INDENT_WIDTH number Sets the size of indentation with respect to the
width of a space character. Setting this value to 0
will result in the indentation size being set to the
same size as a tab.
INTELLISENSE_AUTOCOMPLETE_ITEMS number Sets the maximum number of items that are visible
in the autocomplete list. If the amount of items in
the autocomplete list exceeds this value a vertical
scrollbar will be shown.
MARGIN_COLUMN number Specifies which line the margin line is drawn at. A
value of 0 will turn the margin line off.
STYLE_BRACEBAD style Specifies the style for an unmatched brace.
STYLE_BRACELIGHT style Specifies the style for a currently highlighted
brace.
STYLE_CALLTIP style Specifies the style for intellisense calltips.
TAB_USE_SPACES boolean Specifies whether indentation is based soley on
spaces. If set to false indentation will be based on a
combination of tabs and spaces.
TAB_WIDTH number Defines the width of a tab in characters.
WORD_CHARACTERS string Within the context of the editor, the notion of a
word is defined as a contiguous sequence of
characters that are found in the set of characters
defined by the WORD_CHARACTERS property.

Any editor functions that operate on words refer to


this character set when determining what the word
is.

For example if WORD_CHARACTERS did not


contain the underscore character (_) then the literal
sequence TEST_HARNESS would be considered
to be two words.
WHITESPACE_VISIBLE boolean Specifies whether whitespace characters (eg tab,
space) are displayed.

Lexer Specific Properties


The following sections list the Lexer Specific Propertiesfor each lexer.

Ada Lexer Properties


The Ada lexer (LEXER=ada) is used by the common code editor control to decorate code
written in the Ada language. Lexer Specific Properties for the Ada Lexer are listed in the
following table.

Property Type Description


KEYWORDS string A space delimited list of Ada keywords that will be
decorated in the STYLE_WORD style.
STYLE_CHARACTER style Style definition for characters (eg 'c')
STYLE_CHARACTEREOL style Style definition for characters that are not terminated
before the end of the current line.
STYLE_COMMENTLINE style Style definition for Ada comments
STYLE_DEFAULT style Style definition for ordinary text
STYLE_DELIMITER style Style definition for delimiters (eg &\()*+,-/:;<>=| )
STYLE_IDENTIFIER style Style definition for identifers
STYLE_ILLEGAL style Style definition for illegal control labels (eg a label that
shares the same name as a keyword)
STYLE_LABEL style Style definition for control labels (eg
<<Clean_Exit>>)
STYLE_NUMBER style Style definition for numbers
STYLE_STRING style Style definition for strings (eg “Hello World!”)
STYLE_STRINGEOL style Style definition for strings that are not terminated before
the end of the current line.
STYLE_WHITESPACE style Style definition for whitespace characters
STYLE_WORD style Style definition for keywords (eg any word that appears
in the KEYWORDS list)

Bat Lexer Properties


The Bat lexer (LEXER=bat) is used by the common code editor control to decorate the
commands of DOS-style batch files. Lexer Specific Properties for the Bat Lexer are listed
in the following table.

Property Type Description


COMMANDS string A space delimited list of shell commands that will be
decorated in the STYLE_COMMAND style
KEYWORDS string A space delimited list of batch keywords that will be
decorated in the STYLE_WORD style.
STYLE_COMMAND style Style definition for shell commands (eg any word that
appears in the COMMANDS list)
STYLE_COMMENT style Style definition for remarks
STYLE_DEFAULTS style Style definition for ordinary text
STYLE_HIDE style Style definition for hidden lines (eg @echo off)
STYLE_IDENTIFIER style Style definition for identifiers
STYLE_LABEL style Style definition for control labels (eg :Clean_Exit)
STYLE_OPERATOR style Style definition for operators (eg =+><|?*)
STYLE_WHITESPACE style Style definition for whitespace characters
STYLE_WORD style Style definition for keywords (eg any word that appears
in the KEYWORDS list)

Cpp Lexer Properties


The Cpp lexer (LEXER=cpp) is used used by the common code editor control to decorate
code written in C++ style languages (eg C++, Java, JavaScript, C#) . Lexer Specific
Properties for the Cpp Lexer are listed in the following table.

Property Type Description


CASE_SENSITIVE boolean Specifies whether the lexer considers text case when
matching keywords
KEYWORDS string A space delimited list of language keywords that will be
decorated in the STYLE_WORD style.
KEYWORDS_DOC_COMMENT string A space delimited list of documentation keywords that
will be decorated in the
STYLE_COMMENTDOCKEYWORD style.
KEYWORDS_EXTENDED string A space delimited list of user keywords that will be
decorated in the STYLE_WORD_EXTENDED style.
STYLE_CHARACTER style Style definition for characters (eg 'c')
STYLE_COMMENT style Style definition for stream comments (eg /* this is
a comment */)
STYLE_COMMENTDOC style Style definition for documentation sections that appear
within a stream comment
STYLE_COMMENTDOCKEYWORD style Style definition for documentation keywords (eg any
word that appears in the KEYWORDS_DOC_COMMENT)
list
STYLE_COMMENTDOCKEYWORDERROR style Style definition for invalid documentation keywords
STYLE_COMMENTLINE style Style definition for block comments (eg // this is
a comment)
STYLE_COMMENTLINEDOC style Style definition for documentation sections that appear
within a block comment
STYLE_DEFAULT style Style definition for ordinary text
STYLE_IDENTIFIER style Style definition for identifiers
STYLE_NUMBER style Style definition for numbers
STYLE_OPERATOR style Style definition for operators (eg =+><|?*)
STYLE_PREPROCESSOR style Style definition for preprocessor directives
STYLE_REGEX style Style definition for regular expressions
STYLE_STRING style Style definition for strings (eg “Hello World!”)
STYLE_STRINGEOL style Style definition for strings that are not terminated before
the end of the current line.
STYLE_UUID style Style definition for Universally Unique Identifiers
STYLE_VERBATIM style Style definition for verbatim style strings (eg
@”http://www.sparxsystems.com”)
STYLE_WHITESPACE style Style definition for whitespace characters
STYLE_WORD style Style definition for keywords (eg any word that appears
in the KEYWORDS list)
STYLE_WORD_EXTENDED style Style definition for user keywords (eg any word that
appears in the KEYWORDS_EXTENDED list)
STYLING_WITHIN_PREPROCESSOR boolean Specifies whether the lexer should decorate code within a
preprocessor block

Diff Lexer Properties


The Diff lexer (LEXER=diff) is used by the common code editor control to decorate the
results of the GNU diff utility. Lexer Specific Properties for the Diff Lexer are listed in
the following table.

Property Type Description


STYLE_ADDED style Style definition for added sections
STYLE_COMMAND style Style definition for command sections
STYLE_COMMENT style Style definition for comments
STYLE_DEFAULT style Style definition for ordinary text
STYLE_DELETED style Style definition for deleted sections
STYLE_HEADER style Style definition for header sections
STYLE_POSITION style Style definition for position markers
STYLE_WHITESPACE style Style definition for whitespace characters

EACGT Lexer Properties


The EACGT lexer (LEXER=eacgt) is used by the common code editor control to decorate
Enterprise Architect's Code Generation and Transformation templates. Lexer Specific
Properties for the EACGT Lexer are listed in the following table. Please consult the Code
Template Syntax help section for more details on the different template macros and
variables.

Property Type Description


CONTROL_MACROS string A space delimited list of control value macro keywords
that will be decorated in the STYLE_CONTROL_MACRO
style.
FIELD_MACROS string A space delimited list of field macro keywords that will
be decorated in the STYLE_FIELD_MACRO style.
FUNCTION_MACROS string A space delimited list of function value macro keywords
that will be decorated in the
STYLE_FUNCTION_MACRO style.
TAGGEDVALUE_MACROS string A space delimited list of tagged value macro keywords
that will be decorated in the
STYLE_TAGGEDVALUE_MACRO style.
TEMPLATE_MACROS string A space delimited list of template macro keywords that
will be decorated in the STYLE_TEMPLATE_MACRO
style.
STYLE_CONTROL_MACRO style Style definition for control macros
STYLE_DEFAULT style Style definition for ordinary text
STYLE_DIRECTIVE style Style definition for template directives (eg
%list="InnerClass" @indent="\t"%)
STYLE_FIELD_MACRO style Style definition for field macros
STYLE_FUNCTION_MACRO style Style definition for function macros
STYLE_IDENTIFIER style Style definition for identifiers
STYLE_STRING style Style definition for strings (eg “Hello World!”)
STYLE_TAGGEDVALUE_MACRO style Style definition for tagged value macros
STYLE_TEMPLATE_MACRO style Style definition for template macros
STYLE_VARIABLE style Style definition for template variables (eg $ops)

HTML Lexer Properties


The HTML lexer (LEXER=html) is used used by the common code editor control to
decorate the source code of HTML documents and any embedded JavaScript, VBScript
or PHP scripts contained within. The HTML lexer can also be used to decorate DTD
files, and self contained PHP scripts.

Lexer Specific Properties for the HTML Lexer are listed in the following table.

Property Type Description


INDENTATION_GUIDE string Advises the automatic indentation routine what
indentation rules to apply based on the primary language
being displayed is.

NOTE: This value only needs to be set when displaying


self contained script files.

Accepted Values: php, javascript,


javascriptasp
KEYWORDS string A space delimited list of keywords that will be decorated
in the STYLE_TAG style.
KEYWORDS_JAVASCRIPT string A space delimited list of JavaScript keywords that will be
decorated in the STYLE_JS_KEYWORD and
STYLE_JSA_KEYWORD styles.
KEYWORDS_VBSCRIPT string A space delimited list of VBScript keywords that will be
decorated in the STYLE_VB_KEYWORD style
KEYWORDS_PHP string A space delimited list of PHP keywords that will be
decorated in the STYLE_PHP_KEYWORD style
KEYWORDS_DTD string A space delimited list of DTD keywords that will be
decorated in the STYLE_TAG style
STYLE_DEFAULT style Style definition for ordinary text
STYLE_TAG style Style definition for tags
STYLE_TAGUNKNOWN style Style definition for tags that do not appear in the keyword
list
STYLE_ATTRIBUTE style Style definition for attributes
STYLE_ATTRIBUTEUNKNOWN style Style definition for attributes that do not appear in the
keyword list
STYLE_NUMBER style Style definition for numbers
STYLE_DOUBLESTRING style Style definition for double quoted strings (eg “Hello
World!”)
STYLE_SINGLESTRING style Style definition for single quoted strings (eg 'Hello
World!')
STYLE_OTHER style Style definition for text that appears outside of the
document's root tags
STYLE_COMMENT style Style definition for SGML style comments (eg <!--
this is a comment -->)
STYLE_ENTITY style Style definition for entity text (eg &nbsp; &gt;)
STYLE_TAGEND style Style definition for a self-terminating tag (eg <br/>)
STYLE_XMLDECL style Style definition for the XML declaration (eg <?xml
version=”1.0”?>)
STYLE_SCRIPT style Style definition for miscellaneous script sections.
STYLE_ASP style Style definition for Active Server Page blocks
STYLE_ASPAT style Style definition for Active Server Page @ blocks
STYLE_CDATA style Style definition for CDATA blocks
STYLE_QUESTION style Style definition for blocks (excluding the XML
declaration) that begin with <?
STYLE_UNQUOTEDVALUE style Style definition for unquoted attribute values
STYLE_JSPCOMMENT style Style definition for Java Server Pages style comments (eg
<%-- this is a comment --%>)
STYLE_SGML_1ST_PARAM style Style definitions for SGML DTD blocks
STYLE_SGML_1ST_PARAM_COMMENT
STYLE_SGML_COMMAND
STYLE_SGML_COMMENT
STYLE_SGML_DEFAULT
STYLE_SGML_DOUBLESTRING
STYLE_SGML_ENTITY
STYLE_SGML_ERROR
STYLE_SGML_SIMPLESTRING
STYLE_SGML_SPECIAL
STYLE_JS_COMMENT style Style definitions for JavaScript blocks
STYLE_JS_COMMENTDOC
STYLE_JS_COMMENTLINE
STYLE_JS_DEFAULT
STYLE_JS_DOUBLESTRING
STYLE_JS_KEYWORD
STYLE_JS_NUMBER
STYLE_JS_OPERATOR
STYLE_JS_REGEX
STYLE_JS_SINGLESTRING
STYLE_JS_START
STYLE_JS_STRINGEOL
STYLE_JS_WORD
STYLE_JSA_COMMENT style Style definitions for ASP JavaScript blocks
STYLE_JSA_COMMENTDOC
STYLE_JSA_COMMENTLINE
STYLE_JSA_DEFAULT
STYLE_JSA_DOUBLESTRING
STYLE_JSA_KEYWORD
STYLE_JSA_NUMBER
STYLE_JSA_OPERATOR
STYLE_JSA_REGEX
STYLE_JSA_SINGLESTRING
STYLE_JSA_START
STYLE_JSA_STRINGEOL
STYLE_JSA_WORD
STYLE_VB_COMMENTLINE style Style definitions for VBScript blocks
STYLE_VB_DEFAULT
STYLE_VB_DOUBLESTRING
STYLE_VB_IDENTIFIER
STYLE_VB_KEYWORD
STYLE_VB_NUMBER
STYLE_VB_START
STYLE_VB_STRINGEOL
STYLE_PHP_DEFAULT style Style definitions for PHP blocks
STYLE_PHP_COMPLEX
STYLE_PHP_DOUBLESTRING
STYLE_PHP_SINGLESTRING
STYLE_PHP_KEYWORD
STYLE_PHP_NUMBER
STYLE_PHP_VARIABLE
STYLE_PHP_COMMENT
STYLE_PHP_COMMENTLINE
STYLE_PHP_STRINGVARIABLE
STYLE_PHP_OPERATOR

MBNF Lexer Properties


The MBNF lexer (LEXER=mbnf) is used by the common code editor control to decorate
grammar files written in Modified Backus-Naur Form. Lexer Specific Properties for the
MBNF Lexer are listed in the following table.

Property Type Description


STYLE_COMMENT style Style definition for comments
STYLE_DEFAULT style Style definition for ordinary text
STYLE_HIGHLIGHT style Style definition for highlighted sections
STYLE_PRAGMA style Style definition for pragma directives
STYLE_STRING style Style definition for strings (eg “Hello World!”)

Pascal Lexer Properties


The Pascal lexer (LEXER=pascal) is used by the common code editor control to decorate
code written in the Pascal and Delphi languages. Lexer Specific Properties for the Pascal
Lexer are listed in the following table.

Property Type Description


CLASSWORDS string A space delimited list of class qualifier keywords that will
be decorated in the STYLE_WORD style.
KEYWORDS string A space delimited list of language keywords that will be
decorated in the STYLE_WORD style.
STYLE_CHARACTER style Style definition for characters (eg 'c')
STYLE_COMMENT style Style definition for stream comments (eg /* this is
a comment */)
STYLE_COMMENTDOC style Style definition for documentation sections that appear
within a stream comment
STYLE_COMMENTLINE style Style definition for block comments (eg // this is
a comment)
STYLE_DEFAULT style Style definition for ordinary text
STYLE_INLINEASM style Style definition for inline assembly blocks
STYLE_OPERATOR style Style definition for operators (eg =+><|?*)
STYLE_PREPROCESSOR style Style definition for preprocessor directives
STYLE_STRING style Style definition for strings (eg “Hello World!”)
STYLE_WHITESPACE style Style definition for whitespace characters
STYLE_WORD style Style definition for keywords (eg any word that appears
in the KEYWORDS or CLASSWORDS lists)

Props Lexer Properties


The Props lexer (LEXER=props) is used by the common code editor control to decorate
Windows style property files. Lexer Specific Properties for the Props Lexer are listed in
the following table.

Property Type Description


STYLE_ASSIGNMENT style Style definition for the assignment operator
STYLE_COMMENT style Style definition for comments (eg # this is a
comment)
STYLE_DEFAULT style Style definition for ordinary text
STYLE_DEFVAL style Style definition for default values (eg @true)
STYLE_KEY style Style definition for property key names
STYLE_SECTION style Style definition for section headers (eg [System])
STYLE_WHITESPACE style Style definition for whitespace characters
Python Lexer Properties
The Python lexer (LEXER=python) is used by the common code editor control to decorate
code written in the Python language. Lexer Specific Properties for the Python Lexer are
listed in the following table.

Property Type Description


KEYWORDS string A space delimited list of Python keywords that will be
decorated in the STYLE_WORD style.
STYLE_CHARACTER style Style definition for characters (eg 'c')
STYLE_CLASSNAME style Style definition for class names
STYLE_COMMENT style Style definition for block comments
STYLE_COMMENTLINE style Style definition for line comments (eg # this is a
comment)
STYLE_DECORATOR style Style definition for decorators (eg @classmethod)
STYLE_DEFAULT style Style definition for ordinary text
STYLE_DEFNAME style Style definition for def statements
STYLE_NUMBER style Style definition for numbers
STYLE_OPERATOR style Style definition for operators (eg =+><|?*)
STYLE_STRING style Style definition for strings (eg “Hello World!”)
STYLE_STRINGEOL style Style definition for strings that are not terminated before
the end of the current line.
STYLE_TRIPLEDOUBLESTRING style Style definition for triple quoted strings with double
quotation marks (eg “””Hello World!”””)
STYLE_TRIPLESINGLESTRING style Style definition for triple quoted strings with single
quotation marks (eg '''Hello World!''')
STYLE_WHITESPACE style Style definition for whitespace characters
STYLE_WORD style Style definition for keywords (eg any word that appears
in the KEYWORDS list)

SQL Lexer Properties


The SQL lexer (LEXER=sql) is used by the common code editor control to decorate
queries written in the Structured Query Language. Lexer Specific Properties for the SQL
Lexer are listed in the following table.

Property Type Description


KEYWORDS string A space delimited list of SQL keywords that will be
decorated in the STYLE_WORD style.
STYLE_CHARACTER style Style definition for characters (eg 'c')
STYLE_COMMENT style Style definition for C-style stream comments (eg /*
this is a comment */)
STYLE_COMMENTDOC style Style definitions for Doxygen style comment blocks (eg
STYLE_COMMENTDOC_KEYWORD /** This is a documentation comment */)
STYLE_COMMENTDOC_KEYWORD_ERROR
STYLE_COMMENTLINE style Style definition for line comments (eg -- this is a
comment)
STYLE_COMMENTLINEDOC style Style definition for SQL documentation comments (eg #
this is a documentation comment)
STYLE_DEFAULT style Style definition for ordinary text
STYLE_IDENTIFIER style Style definition for identifiers
STYLE_OPERATOR style Style definition for operators (eg =+><|?*)
STYLE_STRING style Style definition for strings (eg “Hello World!”)
STYLE_STRINGEOL style Style definition for strings that are not terminated before
the end of the current line.
STYLE_WHITESPACE style Style definition for whitespace characters
STYLE_WORD style Style definition for keywords (eg any word that appears
in the KEYWORDS list)
TABLES string A space delimited list of user defined table names that
will be decorated in the STYLE_TABLE style.

VB Lexer Properties
The VB lexer (LEXER=vb) is used by the common code editor control to decorate code
written in the Visual Basic and VB.NET languages. Lexer Specific Properties for the VB
Lexer are listed in the following table.

Property Type Description


KEYWORDS string A space delimited list of language keywords that will be
decorated in the STYLE_WORD style.
KEYWORDS_CONSTANT string A space delimited list of constant keywords that will be
decorated in the STYLE_WORD_CONSTANT style.
KEYWORDS_EXTENDED string A space delimited list of extended language keywords
that will be decorated in the STYLE_WORD_EXTENDED
style.
STYLE_COMMENT style Style definition for VB comments (eg 'this is a
comment)
STYLE_DATE style Style definition for dates
STYLE_DEFAULT style Style definition for ordinary text
STYLE_IDENTIFIER style Style definition for identifiers
STYLE_NUMBER style Style definition for numbers
STYLE_OPERATOR style Style definition for operators (eg =+><|?*)
STYLE_PREPROCESSOR style Style definition for preprocessor directives
STYLE_STRING style Style definition for strings (eg “Hello World!”)
STYLE_STRINGEOL style Style definition for strings that are not terminated before
the end of the current line.
STYLE_WORD style Style definition for keywords (eg any word that appears
in the KEYWORDS list)
STYLE_WORD_CONSTANT style Style definition for constant keywords (eg any word that
appears in the KEYWORDS_CONSTANT list)
STYLE_WORD_EXTENDED style Style definition for extended keywords (eg any word that
appears in the KEYWORDS_EXTENDED list)

VBScript Lexer Properties


The VBScript lexer (LEXER=vbscript) is used by the common code editor control to
decorate scripts written in the VBScript language.

The VBScript lexer shares the same Lexer Specific Properties as the VB lexer.
Verilog Lexer Properties
The Verilog lexer (LEXER=verilog) is used by the common code editor control to
decorate code written in the Verilog language. Lexer Specific Properties for the Verilog
Lexer are listed in the following table.

Property Type Description


KEYWORDS string A space delimited list of language keywords that will be
decorated in the STYLE_WORD style.
KEYWORDS_EXTENDED string A space delimited list of extended language keywords
that will be decorated in the STYLE_WORD_EXTENDED
style.
STYLE_COMMENT style Style definition for comments (eg /* this is a
comment */)
STYLE_COMMENTLINE style Style definition for line comments (eg // this is a
comment)
STYLE_COMMENTLINEBANG style Style definition for bang line comments (eg //! this
is a comment)
STYLE_DEFAULT style Style definition for ordinary text
STYLE_IDENTIFIER style Style definition for identifiers
STYLE_NUMBER style Style definition for numbers
STYLE_OPERATOR style Style definition for operators (eg =+><|?*)
STYLE_PREPROCESSOR style Style definition for preprocessor directives
STYLE_STRING style Style definition for strings (eg “Hello World!”)
STYLE_STRINGEOL style Style definition for strings that are not terminated before
the end of the current line.
STYLE_TASK style Style definition for task keywords (eg any word that
appears in the TASKS list)
STYLE_TASK_EXTENDED style Style definition for extendedtask keywords (eg any word
that appears in the TASKS_EXTENDED list)
STYLE_WHITESPACE style Style definition for whitespace characters
STYLE_WORD style Style definition for keywords (eg any word that appears
in the KEYWORDS list)
STYLE_WORD_EXTENDED style Style definition for extended keywords (eg any word that
appears in the KEYWORDS_EXTENDED list)
TASKS string A space delimited list of task keywords that will be
decorated in the STYLE_TASK style.
TASKS_EXTENDED string A space delimited list of extended task keywords that will
be decorated in the STYLE_TASK_EXTENDED style.

VHDL Lexer Properties


The VHDL lexer (LEXER=vhdl) is used by the common code editor control to decorate
code written in the VHSIC Hardware Description Language. Lexer Specific Properties
for the VHDL Lexer are listed in the following table.

Property Type Description


KEYWORDS string A space delimited list of language keywords that will be
decorated in the STYLE_WORD style.
STANDARD_OPERATORS string A space delimited list of language operators that will be
decorated in the STYLE_WORD_OPERATOR style.
STANDARD_ATTRIBUTES string A space delimited list of language attributes that will be
decorated in the STYLE_WORD_ATTRIBUTE style.
STANDARD_FUNCTIONS string A space delimited list of language functions that will be
decorated in the STYLE_WORD_FUNCTION style.
STANDARD_PACKAGES string A space delimited list of language packages that will be
decorated in the STYLE_WORD_PACKAGE style.
STANDARD_TYPES string A space delimited list of language types that will be
decorated in the STYLE_WORD_TYPE style.
KEYWORDS_EXTENDED string A space delimited list of extended language keywords
that will be decorated in the STYLE_WORD_EXTENDED
style.
STYLE_DEFAULT style Style definition for ordinary text
STYLE_WHITESPACE style Style definition for whitespace characters
STYLE_COMMENT style Style definition for comments (eg -- this is a
comment */)
STYLE_COMMENTLINEBANG style Style definition for bang line comments (eg --! this
is a comment)
STYLE_NUMBER style Style definition for numbers
STYLE_STRING style Style definition for strings (eg “Hello World!”)
STYLE_OPERATOR style Style definition for operators (eg =+><|?*)
STYLE_IDENTIFIER style Style definition for identifiers
STYLE_STRINGEOL style Style definition for strings that are not terminated before
the end of the current line.
STYLE_WORD style Style definition for keywords (eg any word that appears
in the KEYWORDS list)
STYLE_WORD_OPERATOR style Style definition for language operators (eg any word that
appears in the STANDARD_OPERATORS list)
STYLE_WORD_ATTRIBUTE style Style definition for language attributes (eg any word that
appears in the STANDARD_ATTRIBUTES list)
STYLE_WORD_FUNCTION style Style definition for language functions (eg any word that
appears in the STANDARD_FUNCTIONS list)
STYLE_WORD_PACKAGE style Style definition for language packages (eg any word that
appears in the STANDARD_PACKAGES list)
STYLE_WORD_TYPE style Style definition for language types (eg any word that
appears in the STANDARD_TYPES list)
KEYWORDS_EXTENDED string A space delimited list of extended language keywords
that will be decorated in the STYLE_WORD_EXTENDED
style.

XML Lexer Properties


The XML lexer (LEXER=xml) is used by the common code editor control to decorate
XML documents.

The XML lexer shares the same Lexer Specific Properties as the HTML lexer.

You might also like