Namespace List

The namespaces specified in this document are:

Namespace	Assembly
ScintillaDotNet	ScintillaDotNet

Namespace : ScintillaDotNet

ScintillaDotNet Type List

Delegates

Type	Summary
AutocSelectionEventHandler	Represents the method that will handle the event.
CallTipClickEventHandler	Represents the method that will handle the event.
CharAddedEventHandler	Represents the method that will handle the event.
DwellEndEventHandler	Represents the method that will handle the event.
DwellStartEventHandler	Represents the method that will handle the event.
HotSpotClickEventHandler	Represents the method that will handle the event.
HotSpotDoubleClickEventHandler	Represents the method that will handle the event.
MacroRecordEventHandler	Represents the method that will handle the event.
MarginClickEventHandler	Represents the method that will handle the event.
ModifiedEventHandler	Represents the method that will handle the event.
NeedShownEventHandler	Represents the method that will handle the event.
StyleNeededEventHandler	Represents the method that will handle the event.
UserListSelectionEventHandler	Represents the method that will handle the event.

Structs

Type	Summary
Caching	Contains constants to do with caching (SC_CACHE_*).
CaretPolicy	Struct containing caret policy constants (CARET_*).
Case	Struct containing case constants (SC_CASE_*).
CharacterSet	Struct containing character set constants (SC_CHARSET_*).
CodePage	Struct containing codepage constants (SC_CP_*).
Commands	This struct contains message constants for messages that can be sent to Scintilla but didn't really make sense to be added as a method of the control, for example moving the cursor to the end of the line, etc. These can be sent to the control by calling . Most of these messages are keyboard commands (See the Scintilla documentation for keyboard commands).
Cursor	Struct containing cursor constants (SC_CURSOR*).
EdgeModes	Struct containing long line edge mode constants.
Eol	Struct containing End-of-line (EOL) constants.
Find	Struct containing find constants (SCFIND_*).
FoldFlag	Struct containing fold flag constants (SC_FOLDFLAG_*).
FoldLevel	Struct containing fold level constants (SC_FOLDLEVEL*).
Indicator	Struct containing indicator constants (INDIC_* and INDICS_*).
Keys	Struct containing Scintilla key constants.
Keywords.Batch	Keyword groups for Batch files.
Keywords.BlitzBasic	Keyword groups for BlitzBasic.
Keywords.Config	Keyword groups for configuration files (e.g. Apache config files).
Keywords.Cpp	Keyword groups for C and CPP derived languages e.g. C, C++, Java, JavaScript, etc.
Keywords.Css	Keyword groups for CSS1 and CSS2.
Keywords.FreeBasic	Keyword groups for FreeBasic.
Keywords.Html	Keyword groups for HTML and it's embedded languages e.g. PHP, ASP, JavaScript, Python, VBScript, etc.
Keywords.Lua	Keyword groups for Lua.
Keywords.Perl	Keyword groups for Perl.
Keywords.PowerBasic	Keyword groups for PowerBasic.
Keywords.PureBasic	Keyword groups for PureBasic.
Keywords.Python	Keyword groups for Python.
Keywords.Ruby	Keyword groups for Ruby.
Keywords.Sql	Keyword groups for SQL, PL/SQL and SQL*Plus.
Keywords.TSql	Keyword groups for Transact-SQL (MS-TSQL).
Keywords.VisualBasic	Keyword groups for Visual Basic and VBScript.
Lexers	This struct contains the lexer constants used by the Scintilla control.
Margin	Struct containing margin constants (SC_MARGIN_*).
Marker	Struct containing marker constants (SC_MARK_*).
Modification	Struct containing modification constants (SC_MOD_*).
Modifiers	Struct containing key modifiers. See the enumeration for an example of where these are used.
Print	Struct containing printing constants (SC_PRINT_*).
Selection	Struct containing selection style constants (SC_SEL_*).
Styles	This class holds the style constants used for setting styles in Scintilla. Language styles have been grouped into structs differentiating the different languages, so it's easier to find styles with intellisense.
Styles.Ada	Struct holding constants for the ADA language.
Styles.Asp	Struct holding constants for Active Server Pages (ASP) languages. Supported languages are VBScript, JavaScript and Python. This should be used in conjunction with the struct.
Styles.Basic	Struct holding constants for Basic style languages. Supported languages are Visual Basic, FreeBasic, BlitzBasic, PowerBasic and PureBasic.
Styles.Batch	Struct holding constants for batch files (.bat).
Styles.C	Struct holding constants for the C language and it's derivatives (C++, Java, C#, JavaScript, etc). Only set the styles you want when using this lexer e.g. line documentation comment styles should not be set for JavaScript.
Styles.Config	Configuration styles e.g. for Apache configuration files (.conf, .htaccess).
Styles.Css	Struct holding constants for Cascading stylesheets (CSS).
Styles.Diff	Struct holding constants for Diff files (.diff, .patch).
Styles.ErrorList	This struct defines styles that can be used for common error lists.
Styles.Html	Struct holding constants for HTML and similar markup languages. This struct should be used for most markup languages e.g. HTML, XML, SGML, etc. It also contains the styles to be used for embedded client-side scripting languages e.g. JavaScript, VbScript, Python, etc. Server-side languages (ASP, PHP) etc. are dealt separately.
Styles.Latex	Struct holding constants for Latex.
Styles.Lua	Struct holding constants for Lua.
Styles.Makefile	Struct holding constants for Make files.
Styles.Perl	Struct holding constants for Perl.
Styles.Php	Struct holding constants for the PHP language that can be embedded in HTML. This struct declares PHP-specific style groups - see the struct for the style used for colouring PHP tags ( embedded into HTML.
Styles.Properties	Struct holding constants for properties files e.g. .properties files, .ini files, .cfg files, etc.
Styles.Python	Struct holding constants for the Python language.
Styles.Ruby	Struct holding constants for Ruby.
Styles.Sql	Struct holding constants for SQL (Structured Query Language). These styles should be used for SQL*Plus and PL/SQL. Use the struct for Microsoft's Transact-SQL.
Styles.TSql	Struct holding constants for Transact-SQL (T-SQL). These styles should be used for Microsoft's Transact-SQL only - use the struct standard SQL, PL/SQL, etc..
VisiblePolicy	Struct containing visible policy constants (VISIBLE_*).
Whitespace	Struct containing whitespace visibility constants (SCWS_*).
Wrap	Struct containing wrapping constants (SC_WRAP_*).

Classes

Type	Summary
AutocSelectionEventArgs	This class is used to store data when an item is selected in an autocompletion list.
CallTipClickEventArgs	Stores data when call tips are clicked.
CharAddedEventArgs	This class is used to store data when a character is added to a scintilla control.
DwellEventArgs	Stores data when the user keeps the mouse in one position for the dwell period, which is set using .
HotSpotClickEventArgs	Stores data when hot spots are clicked or double-clicked.
Keywords	When setting keywords in Scintilla, you need to provide a number that tells Scintilla which keyword group you are setting. These are determined by looking in the individual lexers at what index in the arrays the keyword groups belong. This class provides convenience constants for setting keyword groups for individual lexers.
MacroRecordEventArgs	Stores data required for MacroRecord events.
MarginClickEventArgs	Stores data when sensitive margins are clicked.
ModifiedEventArgs	ModifiedEventArgs class - this is used to store data when the contents of the Scintilla control are modified.
NeedShownEventArgs	Stores data when Scintilla has determined that a range of lines that is currently invisible should be made visible.
OS	This class handles calls to the underlying operating system. It was called "OS" rather than "Win32" as GTK support will hopefully be added at a later stage.
Scintilla	This forms a wrapper over the Scintilla control written in C++. This class takes care of loading the library using the SciLexer DLL - the method must be called before anything else is done. Properties and methods of the control are implemented in a more standard .NET way.
StyleNeededEventArgs	This class encapsulates the arguments required for the StyleNeeded event.
UserListSelectionEventArgs	This class is used to store data when an item is selected in a user list.

ScintillaDotNet Delegates

UserListSelectionEventHandler Delegate

Summary

public delegate UserListSelectionEventHandler

Represents the method that will handle the event.

AutocSelectionEventHandler Delegate

Summary

public delegate AutocSelectionEventHandler

Represents the method that will handle the event.

CallTipClickEventHandler Delegate

Summary

public delegate CallTipClickEventHandler

Represents the method that will handle the event.

CharAddedEventHandler Delegate

Summary

public delegate CharAddedEventHandler

Represents the method that will handle the event.

DwellStartEventHandler Delegate

Summary

public delegate DwellStartEventHandler

Represents the method that will handle the event.

DwellEndEventHandler Delegate

Summary

public delegate DwellEndEventHandler

Represents the method that will handle the event.

HotSpotClickEventHandler Delegate

Summary

public delegate HotSpotClickEventHandler

Represents the method that will handle the event.

HotSpotDoubleClickEventHandler Delegate

Summary

public delegate HotSpotDoubleClickEventHandler

Represents the method that will handle the event.

MacroRecordEventHandler Delegate

Summary

public delegate MacroRecordEventHandler

Represents the method that will handle the event.

MarginClickEventHandler Delegate

Summary

public delegate MarginClickEventHandler

Represents the method that will handle the event.

ModifiedEventHandler Delegate

Summary

public delegate ModifiedEventHandler

Represents the method that will handle the event.

NeedShownEventHandler Delegate

Summary

public delegate NeedShownEventHandler

Represents the method that will handle the event.

StyleNeededEventHandler Delegate

Summary

public delegate StyleNeededEventHandler

Represents the method that will handle the event.

ScintillaDotNet Structs

Commands Structure

Summary

public structure Commands

This struct contains message constants for messages that can be sent to Scintilla but didn't really make sense to be added as a method of the control, for example moving the cursor to the end of the line, etc. These can be sent to the control by calling . Most of these messages are keyboard commands (See the Scintilla documentation for keyboard commands).

Field Members

Name	Access	Summary
BackTab : Int32	public	Untabs/unindents from the current cursor position. This is the same as "Shift-Tab" on the keyboard.
Cancel : Int32	public	Cancels the current selection operation.
CharLeft : Int32	public	Shifts the cursor one character to the left.
CharLeftExtend : Int32	public	Moves one character left with select keyboard command (on windows - Shift+LeftArrow).
CharLeftRectExtend : Int32	public	Extends the selection one character left in rectangular mode.
CharRight : Int32	public	Shifts the cursor one character to the right.
CharRightExtend : Int32	public	Moves one character right with select keyboard command (on windows - Shift+RightArrow).
CharRightRectExtend : Int32	public	Extends the selection one character right in rectangular mode.
DeleteBack : Int32	public	Deletes the previous character (same as pressing the backspace key).
DeleteBackNotLine : Int32	public	Deletes the previous character (same as pressing the backspace key), but does not delete back over line endings.
DeleteLineLeft : Int32	public	Deletes all characters on the line to the left of the cursor.
DeleteLineRight : Int32	public	Deletes all characters on the line to the right of the cursor.
DeleteWordLeft : Int32	public	Deletes the previous word.
DeleteWordRight : Int32	public	Deletes the next word.
DocumentEnd : Int32	public	Moves the caret to the end of the document.
DocumentEndExtend : Int32	public	Extends the selection to the end of the document.
DocumentStart : Int32	public	Moves the caret to the beginning of the document.
DocumentStartExtend : Int32	public	Extends the selection to the beginning of the document.
FormFeed : Int32	public	Inserts a formfeed character into the document.
Home : Int32	public	Moves the cursor to the beginning of the line.
HomeDisplay : Int32	public	Moves the cursor to the beginning of the wrapped portion of the line.
HomeDisplayExtend : Int32	public	Extends the selection to the beginning of the wrapped portion of the line.
HomeExtend : Int32	public	Extends the selection to the beginning of the current line.
HomeRectExtend : Int32	public	Extends the selection to the beginning of the current line in rectangular mode.
HomeWrap : Int32	public	Moves the cursor to the beginning of the wrapped portion of the line, and then to the beginning of the line.
HomeWrapExtend : Int32	public	Extends the selection to the beginning of the wrapped portion of the line, and then to the beginning of the line.
LineCopy : Int32	public	Copies the current line to the clipboard.
LineCut : Int32	public	Deletes the current line and places it on the clipboard.
LineDelete : Int32	public	Deletes the current line.
LineDown : Int32	public	Moves the cursor down a line.
LineDownExtend : Int32	public	Moves down a line and selecting at the same time.
LineDownRectExtend : Int32	public	Extends the selection down a line in rectangle mode.
LineEnd : Int32	public	Moves the cursor to the end of the line.
LineEndDisplay : Int32	public	Moves the cursor to the end of the wrapped portion of the line.
LineEndDisplayExtend : Int32	public	Extends the selection to the end of the wrapped portion of the line.
LineEndExtend : Int32	public	Extends the selection to the end of the current line.
LineEndRectExtend : Int32	public	Extends the selection to the end of the current line in rectangular mode.
LineEndWrap : Int32	public	Moves the cursor to the end of the wrapped portion of the line, and then to the end of the line.
LineEndWrapExtend : Int32	public	Extends the selection to the end of the wrapped portion of the line, and then to the end of the line.
LineScrollDown : Int32	public	Scrolls the display down a line.
LineScrollUp : Int32	public	Scrolls the display up a line.
LineTranspose : Int32	public	Changes the text of the current line with the text of the previous line. Does nothing when the caret is on the first line of the document.
LineUp : Int32	public	Moves up a line.
LineUpExtend : Int32	public	Moves up a line and selecting at the same time.
LineUpRectExtend : Int32	public	Extends the selection up a line in rectangle mode.
NewLine : Int32	public	Inserts a new line at the current cursor position (same has hitting the enter/return key on the keyboard).
PageDown : Int32	public	Moves the cursor down a page (same as pressing the Page Down key).
PageDownExtend : Int32	public	Moves the cursor down a page, and also selects the text between the two locations (Same as Shift-Page Down).
PageDownRectExtend : Int32	public	Moves the cursor down a page in rectangular mode.
PageUp : Int32	public	Moves the cursor up a page (same as pressing the Page Up key).
PageUpExtend : Int32	public	Moves the cursor up a page, and also selects the text between the two locations (Same as Shift-Page Up).
PageUpRectExtend : Int32	public	Moves the cursor up a page in rectangular mode.
ParaDown : Int32	public	Moves the cursor down a paragraph.
ParaDownExtend : Int32	public	Moves the cursor down a paragraph, and also selects the text between the two locations.
ParaUp : Int32	public	Moves the cursor up a paragraph.
ParaUpExtend : Int32	public	Moves the cursor up a paragraph, and also selects the text between the two locations.
SelectionDuplicate : Int32	public	Duplicates the current selection.
StutteredPageDown : Int32	public	Moves the caret down a page, but only so far as the visible area allows.
StutteredPageDownExtend : Int32	public	Moves the caret down a page in rectangular mode, but only so far as the visible area allows.
StutteredPageUp : Int32	public	Moves the caret up a page, but only so far as the visible area allows.
StutteredPageUpExtend : Int32	public	Moves the caret up a page in rectangular mode, but only so far as the visible area allows.
Tab : Int32	public	Inserts a tab character at the current location or at the beginning of each line if the selection spans multiple lines. Same as pressing the Tab key.
VcHome : Int32	public	Sends the caret to the first non-whitespace character on the current line.
VcHomeExtend : Int32	public	Extends the selection to the first non-whitespace character on the current line.
VcHomeRectExtend : Int32	public	Extends the selection to the first non-whitespace character on the current line in rectangular mode.
VcHomeWrap : Int32	public	Sends the caret to the first non-whitespace character on the wrapped portion of the current line.
VcHomeWrapExtend : Int32	public	Extends the selection to the first non-whitespace character on the wrapped portion of the current line.
WordLeft : Int32	public	Moves the cursor one word to the left.
WordLeftEnd : Int32	public	Moves the cursor to the end of the previous word in the editor.
WordLeftEndExtend : Int32	public	Extends the current selection to the end of the previous word in the editor.
WordLeftExtend : Int32	public	Extends the current selection to the beginning of the previous word in the editor.
WordPartLeft : Int32	public	Moves the cursor the previous part of the current word, for example in camel-case statements it will move the cursor to the previous capital letter in the word.
WordPartLeftExtend : Int32	public	Extends the current selection to the previous part of the previous/current word e.g. to the previous capital letter.
WordPartRight : Int32	public	Moves the cursor the next part of the current word, for example in camel-case statements it will move the cursor to the next capital letter in the word.
WordPartRightExtend : Int32	public	Extends the current selection to the next part of the next/current word e.g. to the next capital letter.
WordRight : Int32	public	Moves the cursor one word to the right i.e. to the beginning of the next word.
WordRightEnd : Int32	public	Moves the cursor to the end of the next/current word in the editor.
WordRightEndExtend : Int32	public	Extends the current selection to the end of the next word in the editor.
WordRightExtend : Int32	public	Extends the current selection to the beginning of the next word in the editor.

Method Members

Name	Access	Summary

Caching Structure

Summary

public structure Caching

Contains constants to do with caching (SC_CACHE_*).

Field Members

Name	Access	Summary
Caret : Int32	public	Layout caching policy: The line containing the text caret (Layout policy default).
Document : Int32	public	Layout caching policy: all lines in the document.
None : Int32	public	Layout caching policy: no lines are cached.
Page : Int32	public	Layout caching policy: visible lines plus the line containing the caret.

Method Members

Name	Access	Summary

CaretPolicy Structure

Summary

public structure CaretPolicy

Struct containing caret policy constants (CARET_*).

Field Members

Name	Access	Summary
Even : Int32	public	If not set, instead of having symmetrical UZs, the left and bottom UZs are extended up to right and top UZs respectively. This way, we favour the displaying of useful information: the beginning of lines, where most code reside, and the lines after the caret, for example, the body of a function.
Jumps : Int32	public	If set, the display is moved more energetically so the caret can move in the same direction longer before the policy is applied again. '3UZ' notation is used to indicate three time the size of the UZ as a distance to the margin.
Slop : Int32	public	This value defines an unwanted zone (UZ) where the caret is... unwanted. This zone is defined as a number of pixels near the vertical margins, and as a number of lines near the horizontal margins. By keeping the caret away from the edges, it is seen within its context. This makes it likely that the identifier that the caret is on can be completely seen, and that the current line is seen with some of the lines following it, which are often dependent on that line.
Strict : Int32	public	If set, the policy set by is enforced strictly. The caret is centred on the display if caretSlop is not set, and cannot go in the UZ if caretSlop is set.

Method Members

Name	Access	Summary

Case Structure

Summary

public structure Case

Struct containing case constants (SC_CASE_*).

Field Members

Name	Access	Summary
Lower : Int32	public	Display characters in lower case.
Mixed : Int32	public	Display characters in normal/mixed case.
Upper : Int32	public	Display characters in upper case.

Method Members

Name	Access	Summary

CharacterSet Structure

Summary

public structure CharacterSet

Struct containing character set constants (SC_CHARSET_*).

Field Members

Name	Access	Summary
Ansi : Int32	public	ANSI character set.
Arabic : Int32	public	Arabic character set.
Baltic : Int32	public	Baltic character set.
ChineseBig5 : Int32	public	Traditional Chinese Big5 character set.
Cyrillic : Int32	public	Cyrillic character set.
Default : Int32	public	Default character set.
EasternEurope : Int32	public	East europe character set.
GB2312 : Int32	public	GB2312 (Simplified Chinese) character set.
Greek : Int32	public	Greek character set.
Hangul : Int32	public	Hangul character set.
Hebrew : Int32	public	Hebrew character set.
ISO8859_15 : Int32	public	ISO 8859-15 character set.
Johab : Int32	public	Johab (Korean) character set.
Mac : Int32	public	MAC character set.
OEM : Int32	public	OEM character set.
Russian : Int32	public	Russian character set.
ShiftJis : Int32	public	ShiftJis (Japanese) character set.
Symbol : Int32	public	Character set symbol constant.
Thai : Int32	public	Thai character set.
Turkish : Int32	public	Turkish character set.
Vietnamese : Int32	public	Vietnamese character set.

Method Members

Name	Access	Summary

CodePage Structure

Summary

public structure CodePage

Struct containing codepage constants (SC_CP_*).

Field Members

Name	Access	Summary
DBCS : Int32	public	Sets Scintilla into multi byte character mode on GTK+ as is required for Japanese language processing with the EUC encoding
UTF8 : Int32	public	Sets Scintilla into Unicode mode with the document treated as a sequence of characters expressed in UTF-8.

Method Members

Name	Access	Summary

Cursor Structure

Summary

public structure Cursor

Struct containing cursor constants (SC_CURSOR*).

Field Members

Name	Access	Summary
Normal : Int32	public	Normal cursor.
Wait : Int32	public	Wait cursor.

Method Members

Name	Access	Summary

EdgeModes Structure

Summary

public structure EdgeModes

Struct containing long line edge mode constants.

Field Members

Name	Access	Summary
Background : Int32	public	The background colour of characters after the column limit is changed to the colour set by . This is recommended for proportional fonts.
Line : Int32	public	A vertical line is drawn at the column number set by . This works well for monospaced fonts. The line is drawn at a position based on the width of a space character in , so it may not work very well if your styles use proportional fonts or if your style have varied font sizes or you use a mixture of bold, italic and normal text.
None : Int32	public	Long lines are not marked. This is the default state.

Method Members

Name	Access	Summary

Eol Structure

Summary

public structure Eol

Struct containing End-of-line (EOL) constants.

Field Members

Name	Access	Summary
Cr : Int32	public	Constant for line endings (Macintosh - carriage return only).
CrLf : Int32	public	Constant for line endings (Windows - carriage return and line feed).
Lf : Int32	public	Constant for line endings (Linux/Unix - line feed only).

Method Members

Name	Access	Summary

Find Structure

Summary

public structure Find

Struct containing find constants (SCFIND_*).

Field Members

Name	Access	Summary
MatchCase : Int32	public	Used for text searches - a match only occurs with text that matches the case of the search string.
Posix : Int32	public	Used for text searches - treats regular expression in a more POSIX compatible manner by interpreting bare ( and ) for tagged sections rather than $ and $.
RegExp : Int32	public	Used for text searches - the search string should be interpreted as a regular expression.
WholeWord : Int32	public	Used for text searches - a match only occurs if the characters before and after are not word characters.
WordStart : Int32	public	Used for text searches - a match only occurs if the character before is not a word character.

Method Members

Name	Access	Summary

FoldFlag Structure

Summary

public structure FoldFlag

Struct containing fold flag constants (SC_FOLDFLAG_*).

Field Members

Name	Access	Summary
Box : Int32	public	Draw a box around expanded areas.
LevelNumbers : Int32	public	Displays hexadecimal fold levels in line margin to aid debugging of folding. Not recommended for use in production applications.
LineAfterContracted : Int32	public	Draw a line below the toggle line if the area is contracted.
LineAfterExpanded : Int32	public	Draw a line below the toggle line if the area is expanded.
LineBeforeContracted : Int32	public	Draw a line above the toggle line if the area is contracted.
LineBeforeExpanded : Int32	public	Draw a line above the toggle line if the area is expanded.

Method Members

Name	Access	Summary

FoldLevel Structure

Summary

public structure FoldLevel

Struct containing fold level constants (SC_FOLDLEVEL*).

Field Members

Name	Access	Summary
Base : Int32	public	Initial fold level.
BoxFooterFlag : Int32	public	Box footer flag fold level.
BoxHeaderFlag : Int32	public	Box header flag fold level.
Contracted : Int32	public	Contracted flag fold level - indicates that a fold is contracted.
HeaderFlag : Int32	public	Header flag fold level - indicates that the line is a header (fold point).
NumberMask : Int32	public	Fold level number mask - this is used to get the fold level of a line.
Unindent : Int32	public	Unindent flag fold level.
WhiteFlag : Int32	public	White flag fold level - indicates that the line is blank and allows it to be treated slightly different then its level may indicate.

Method Members

Name	Access	Summary

Indicator Structure

Summary

public structure Indicator

Struct containing indicator constants (INDIC_* and INDICS_*).

Field Members

Name	Access	Summary
Box : Int32	public	Indicator style - a rectangle around the text.
Diagonal : Int32	public	Indicator style - diagonal hatching.
Hidden : Int32	public	Indicator style - an indicator with no visual effect.
IndicatorsMask : Int32	public	Indicators mask.
Mask0 : Int32	public	Indicator mask 0.
Mask1 : Int32	public	Indicator mask 1.
Mask2 : Int32	public	Indicator mask 2.
Max : Int32	public	Maximum possible indicator number.
Plain : Int32	public	Indicator style - underlined with a single, straight line.
Squiggle : Int32	public	Indicator style - a squiggly underline.
Strike : Int32	public	Indicator style - strike out.
Tt : Int32	public	Indicator style - a line of small T shapes.

Method Members

Name	Access	Summary

Margin Structure

Summary

public structure Margin

Struct containing margin constants (SC_MARGIN_*).

Field Members

Name	Access	Summary
Number : Int32	public	Uses to set a margin type to that of number (i.e. displays numbers).
Symbol : Int32	public	Used to set a margin type to that of symbol (i.e. displays symbols).

Method Members

Name	Access	Summary

Marker Structure

Summary

public structure Marker

Struct containing marker constants (SC_MARK_*).

Field Members

Name	Access	Summary
Arrow : Int32	public	Arrow marker.
ArrowDown : Int32	public	Arrow down marker
Arrows : Int32	public	Arrows marker.
Background : Int32	public	Background marker - changes the background colour of the line only.
BoxMinus : Int32	public	Minus box marker.
BoxMinusConnected : Int32	public	Minus box marker with connecting lines.
BoxPlus : Int32	public	Plus box marker.
BoxPlusConnected : Int32	public	Plus box marker with connecting lines.
Character : Int32	public	Constant to allow the adding of ASCII characters as markers.
Circle : Int32	public	Circle marker.
CircleMinus : Int32	public	Minus circle marker.
CircleMinusConnected : Int32	public	Minus circle marker with connecting lines.
CirclePlus : Int32	public	Plus circle marker.
CirclePlusConnected : Int32	public	Plus circle marker with connecting lines.
DotDotDot : Int32	public	Ellipses marker (three dots).
Empty : Int32	public	Empty marker.
FullRect : Int32	public	Changes the background colour of the margin.
LowerCorner : Int32	public	Lower corner marker - meets up with .
LowerCornerCurve : Int32	public	Lower corner curve marker - meets up with other connecting markers.
Max : Int32	public	Signifies the last possible marker number.
Minus : Int32	public	Minux marker.
NumFolder : Int32	public	Shows that a fold is present and closed.
NumFolderEnd : Int32	public	Indicates a fold region that has been contracted, that is inside a parent fold region. This would usually display a plus box with connecting lines.
NumFolderMidTail : Int32	public	Indicates the end of a fold region that is inside a parent fold region. This would usually display a vertical line with a top connector.
NumFolderOpen : Int32	public	Shows that a fold is present and open.
NumFolderOpenMid : Int32	public	Indicates a fold region that has been expanded, that is inside a parent fold region. This would usually display a minus box with connecting lines.
NumFolderSub : Int32	public	Used for folding regions - usually a vertical line.
NumFolderTail : Int32	public	Indicates the end of a fold region that has no parent folder regions (i.e. no folding below).
Pixmap : Int32	public	Pixmap marker.
Plus : Int32	public	Plus marker.
RoundRect : Int32	public	Rounded rectangular marker.
ShortArrow : Int32	public	Short arrow marker.
SmallRect : Int32	public	Small rectangular marker.
TopCorner : Int32	public	Top corner marker - meets up with .
TopCornerCurve : Int32	public	Top corner curve marker - meets up with other connecting markers.
VLine : Int32	public	Vertical line marker.

Method Members

Name	Access	Summary

Modification Structure

Summary

public structure Modification

Struct containing modification constants (SC_MOD_*).

Field Members

Name	Access	Summary
BeforeDelete : Int32	public	Modification type: Text is about to be deleted from the document.
BeforeInsert : Int32	public	Modification type: Text is about to be inserted into the document.
ChangeFold : Int32	public	Modification type: A folding change has occurred.
ChangeMarker : Int32	public	Modification type: One or more markers has changed in a line.
ChangeStyle : Int32	public	Modification type: A style change has occurred.
DeleteText : Int32	public	Modification type: Text has been removed from the document.
EventMaskAll : Int32	public	Modification type: This is a mask for all valid flags. This is the default mask state set by SCI_SETMODEVENTMASK.
InsertText : Int32	public	Modification type: Text has been inserted into the document.
LastStepInUndoRedo : Int32	public	Modification information: This is the final step in an Undo or Redo.
MultiLineUndoRedo : Int32	public	Modification information: This is part of an Undo or Redo with multi-line changes.
MultiStepUndoRedo : Int32	public	Modification information: This is part of a multi-step Undo or Redo
PerformedRedo : Int32	public	Modification information: this was the result of a Redo.
PerformedUndo : Int32	public	Modification information: this was the result of an Undo.
PerformedUser : Int32	public	Modification information: the operation was done by the user.

Method Members

Name	Access	Summary

Print Structure

Summary

public structure Print

Struct containing printing constants (SC_PRINT_*).

Field Members

Name	Access	Summary
BlackOnWhite : Int32	public	Print colour mode - print all text as black on a white background.
ColourOnWhite : Int32	public	Print colour mode - everything prints in its own colour on a white background.
ColourOnWhiteDefaultBg : Int32	public	Print colour mode - everything prints in its own colour on a white background except that line numbers use their own background colour.
InvertLight : Int32	public	Print colour mode - if you use a dark screen background this saves ink by inverting the light value of all colours and printing on a white background.
Normal : Int32	public	Print colour mode - Print using the current screen colours. This is the print mode default.

Method Members

Name	Access	Summary

Selection Structure

Summary

public structure Selection

Struct containing selection style constants (SC_SEL_*).

Field Members

Name	Access	Summary
Lines : Int32	public	Line selection mode.
Rectangle : Int32	public	Rectangular selection mode.
Stream : Int32	public	Stream selection mode.

Method Members

Name	Access	Summary

VisiblePolicy Structure

Summary

public structure VisiblePolicy

Struct containing visible policy constants (VISIBLE_*).

Field Members

Name	Access	Summary
Slop : Int32	public	Visible policy slop.
Strict : Int32	public	Visible policy strict.

Method Members

Name	Access	Summary

Whitespace Structure

Summary

public structure Whitespace

Struct containing whitespace visibility constants (SCWS_*).

Field Members

Name	Access	Summary
Invisible : Int32	public	White space display constant - the normal display mode with white space displayed as an empty background colour.
VisibleAfterIndent : Int32	public	White space display constant - white space used for indentation is displayed normally but after the first visible character, it is shown as dots and arrows.
VisibleAlways : Int32	public	White space display constant - white space characters are drawn as dots and arrows.

Method Members

Name	Access	Summary

Wrap Structure

Summary

public structure Wrap

Struct containing wrapping constants (SC_WRAP_*).

Field Members

Name	Access	Summary
Char : Int32	public	Wrapping occurs at the last character in the visible area.
None : Int32	public	No wrapping on the editor.
VisualFlagEnd : Int32	public	Visual flag at end of subline of a wrapped line.
VisualFlagLocDefault : Int32	public	Visual flags drawn near border.
VisualFlagLocEndByText : Int32	public	Visual flag at end of subline drawn near text.
VisualFlagLocStartByText : Int32	public	Visual flag at begin of subline drawn near text.
VisualFlagNone : Int32	public	No visual flags when text is wrapped.
VisualFlagStart : Int32	public	Visual flag at begin of subline of a wrapped line. Subline is indented by at least 1 to make room for the flag.
Word : Int32	public	Wrapping occurs at the last word in the visible area.

Method Members

Name	Access	Summary

Keys Structure

Summary

public structure Keys

Struct containing Scintilla key constants.

Field Members

Name	Access	Summary
Add : Int32	public	Plus/addition key.
Back : Int32	public	Backspace key.
Delete : Int32	public	Delete key.
Divide : Int32	public	Division key.
Down : Int32	public	Constant for the down arrow key.
End : Int32	public	End key.
Escape : Int32	public	Escape key.
Home : Int32	public	Home key.
Insert : Int32	public	Insert key.
Left : Int32	public	Constant for the left arrow key.
PageDown : Int32	public	Page down key.
PageUp : Int32	public	Page up key.
Return : Int32	public	Enter key.
Right : Int32	public	Constant for the right arrow key.
Subtract : Int32	public	Minus/subtract key.
Tab : Int32	public	Tab key.
Up : Int32	public	Constant for the up arrow key.

Method Members

Name	Access	Summary

Modifiers Structure

Summary

public structure Modifiers

Struct containing key modifiers. See the enumeration for an example of where these are used.

Field Members

Name	Access	Summary
Alt : Int32	public	Alt modifier.
Ctrl : Int32	public	Control modifier.
None : Int32	public	Generally used as a modifier - value of 0.
Shift : Int32	public	Shift modifier.

Method Members

Name	Access	Summary

Keywords.Batch Structure

Summary

nestedPublic structure Keywords.Batch

Keyword groups for Batch files.

Field Members

Name	Access	Summary
Keywords : Int32	public	Keywords (0).

Method Members

Name	Access	Summary

Keywords.BlitzBasic Structure

Summary

nestedPublic structure Keywords.BlitzBasic

Keyword groups for BlitzBasic.

Field Members

Name	Access	Summary
Keywords : Int32	public	Keywords (0).
UserKeywords1 : Int32	public	User-defined keywords (1).
UserKeywords2 : Int32	public	User-defined keywords (2).
UserKeywords3 : Int32	public	User-defined keywords (3).

Method Members

Name	Access	Summary

Keywords.Config Structure

Summary

nestedPublic structure Keywords.Config

Keyword groups for configuration files (e.g. Apache config files).

Field Members

Name	Access	Summary
Directives : Int32	public	Directives (0).
Parameters : Int32	public	Parameters (1).

Method Members

Name	Access	Summary

Keywords.Cpp Structure

Summary

nestedPublic structure Keywords.Cpp

Keyword groups for C and CPP derived languages e.g. C, C++, Java, JavaScript, etc.

Field Members

Name	Access	Summary
Docs : Int32	public	Documentation comment keywords with the CPP lexer (2).
Primary : Int32	public	Primary keywords and identifiers with the CPP lexer (0).
Secondary : Int32	public	Secondary keywords and identifiers with the CPP lexer (1).
TypeDefs : Int32	public	Global classes and typedefs with the CPP lexer (4).

Method Members

Name	Access	Summary

Keywords.Css Structure

Summary

nestedPublic structure Keywords.Css

Keyword groups for CSS1 and CSS2.

Field Members

Name	Access	Summary
KeywordsCss1 : Int32	public	CSS1 keywords (0).
KeywordsCss2 : Int32	public	CSS2 keywords (2).
PseudoClasses : Int32	public	Pseudo classes (1).

Method Members

Name	Access	Summary

Keywords.FreeBasic Structure

Summary

nestedPublic structure Keywords.FreeBasic

Keyword groups for FreeBasic.

Field Members

Name	Access	Summary
Keywords : Int32	public	Keywords (0).
PreprocessorKeywords : Int32	public	Preprocessors/directives (1).
UserKeywords1 : Int32	public	User-defined keywords (2).
UserKeywords2 : Int32	public	User-defined keywords (3).

Method Members

Name	Access	Summary

Keywords.Html Structure

Summary

nestedPublic structure Keywords.Html

Keyword groups for HTML and it's embedded languages e.g. PHP, ASP, JavaScript, Python, VBScript, etc.

Field Members

Name	Access	Summary
JavaScript : Int32	public	JavaScript keywords within the HTML lexer (1).
Php : Int32	public	PHP keywords in the HTML lexer (4).
Python : Int32	public	Python keywords in the HTML lexer (2).
SgmlDtd : Int32	public	SGML and DTD keywords in the HTML lexer (5).
Tags : Int32	public	HTML elements and attributes (0).
VbScript : Int32	public	VBScript keywords in the HTML lexer (3).

Method Members

Name	Access	Summary

Keywords.Lua Structure

Summary

nestedPublic structure Keywords.Lua

Keyword groups for Lua.

Field Members

Name	Access	Summary
CoRoutines : Int32	public	Coroutines, I/O and system facilities (3).
Functions : Int32	public	Basic functions (1).
FunctionsMath : Int32	public	String, (table) and math functions (2).
Keywords : Int32	public	Keywords (0).
KeywordsUser1 : Int32	public	User-defined keywords (4).
KeywordsUser2 : Int32	public	User-defined keywords (5).
KeywordsUser3 : Int32	public	User-defined keywords (6).
KeywordsUser4 : Int32	public	User-defined keywords (7).

Method Members

Name	Access	Summary

Keywords.Perl Structure

Summary

nestedPublic structure Keywords.Perl

Keyword groups for Perl.

Field Members

Name	Access	Summary
Keywords : Int32	public	Keywords (0).

Method Members

Name	Access	Summary

Keywords.PowerBasic Structure

Summary

nestedPublic structure Keywords.PowerBasic

Keyword groups for PowerBasic.

Field Members

Name	Access	Summary
Keywords : Int32	public	Keywords (0).

Method Members

Name	Access	Summary

Keywords.PureBasic Structure

Summary

nestedPublic structure Keywords.PureBasic

Keyword groups for PureBasic.

Field Members

Name	Access	Summary
Keywords : Int32	public	Keywords (0).
PreprocessorKeywords : Int32	public	Preprocessors/directives (1).
UserKeywords1 : Int32	public	User-defined keywords (2).
UserKeywords2 : Int32	public	User-defined keywords (3).

Method Members

Name	Access	Summary

Keywords.Python Structure

Summary

nestedPublic structure Keywords.Python

Keyword groups for Python.

Field Members

Name	Access	Summary
Identifiers : Int32	public	Highlighted identifiers (1).
Keywords : Int32	public	Keywords (0).

Method Members

Name	Access	Summary

Keywords.Ruby Structure

Summary

nestedPublic structure Keywords.Ruby

Keyword groups for Ruby.

Field Members

Name	Access	Summary
Keywords : Int32	public	Keywords (0).

Method Members

Name	Access	Summary

Keywords.Sql Structure

Summary

nestedPublic structure Keywords.Sql

Keyword groups for SQL, PL/SQL and SQL*Plus.

Field Members

Name	Access	Summary
DatabaseObjects : Int32	public	Database Objects (1).
KeywordDoc : Int32	public	PL/SQL Documentation keywords (2).
Keywords : Int32	public	SQL Keywords (0).
SqlPlus : Int32	public	SQL*Plus keywords (3).
User1 : Int32	public	User keywords group 1 (4).
User2 : Int32	public	User keywords group 2 (5).
User3 : Int32	public	User keywords group 3 (6).
User4 : Int32	public	User keywords group 4 (7).

Method Members

Name	Access	Summary

Keywords.TSql Structure

Summary

nestedPublic structure Keywords.TSql

Keyword groups for Transact-SQL (MS-TSQL).

Field Members

Name	Access	Summary
DataTypes : Int32	public	Data Types (1).
Functions : Int32	public	Functions (4).
GlobalVariables : Int32	public	Global variables (3).
Operators : Int32	public	Operators (6).
Statements : Int32	public	Statements (0).
StoredProcedures : Int32	public	System stored procedures (5).
SystemTables : Int32	public	System tables (2).

Method Members

Name	Access	Summary

Keywords.VisualBasic Structure

Summary

nestedPublic structure Keywords.VisualBasic

Keyword groups for Visual Basic and VBScript.

Field Members

Name	Access	Summary
Keywords : Int32	public	Keywords (0).
UserKeywords1 : Int32	public	User-defined keywords (1).
UserKeywords2 : Int32	public	User-defined keywords (2).
UserKeywords3 : Int32	public	User-defined keywords (3).

Method Members

Name	Access	Summary

Lexers Structure

Summary

public structure Lexers

This struct contains the lexer constants used by the Scintilla control.

Field Members

Name	Access	Summary
Ada : Int32	public	Lexer for ADA 95.
ApacheConf : Int32	public	Lexer for Apache configuration files.
Apdl : Int32	public	Lexer for APDL.
Asn1 : Int32	public	Lexer for ASN.1.
Asp : Int32	public	ASP lexer. This should NOT be used in new code - use the HTML lexer instead.
Assembler : Int32	public	Lexer for Assembler, just for the MASM syntax (See ).
AssemblerMmix : Int32	public	Lexer for MMIX Assembler Language (see ).
AutoIt3 : Int32	public	Lexer for AutoIt3.
Avennue : Int32	public	Lexer for Avennue.
Baan : Int32	public	Lexer for Baan.
Bash : Int32	public	Lexer for Bash.
Batch : Int32	public	Lexer for batch files.
BlitzBasic : Int32	public	Lexer for BlitzBasic (See and ).
Bullant : Int32	public	Lexer for Bullant.
Caml : Int32	public	Lexer for Objective Caml.
Clarion : Int32	public	Lexer for Clarion (See ClarionNoCase).
ClarionNoCase : Int32	public	Lexer for Clarion without case sensitivity (See ).
Container : Int32	public	Used to signify that styling is not done by a lexer, but by the container itself. If this is set, you need to do your own styling - the container is sent a StyleNeeded event each time text needs styling for display. This is the default lexer.
Cpp : Int32	public	Lexer for the C++ programming language. This lexer can be used for any language with syntax like C++ e.g. C, C#, Java, JavaScript, etc.
CppNoCase : Int32	public	Lexer for C++-style languages that are not case-sensitive.
Csound : Int32	public	Lexer for Csound (Orchestra and Score).
Css : Int32	public	Lexer for Cascading Style Sheets (CSS).
Diff : Int32	public	Lexer for diff results.
Eiffel : Int32	public	Lexer for Eiffel - folding occurs on indents (See ).
EiffelKw : Int32	public	Lexer for Eiffel - folding occurs on keywords (See ).
Erlang : Int32	public	Lexer for Erlang.
ErrorList : Int32	public	Lexer for error lists.
EScript : Int32	public	Lexer for ESCRIPT.
F77 : Int32	public	Lexer for Fortran with fixed format folding.
FlagShip : Int32	public	Lexer for FlagShip.
Forth : Int32	public	Lexer for Forth.
Fortran : Int32	public	Lexer for Fortran.
FreeBasic : Int32	public	Lexer for FreeBasic (See and ).
Gui4Cli : Int32	public	Lexer for Gui4Cli.
Haskell : Int32	public	Lexer for Haskell.
Html : Int32	public	Lexer for HTML language and embedded scripting languages e.g. PHP, ASP, Python etc.
Kix : Int32	public	Lexer for KIX-Scripts.
Latex : Int32	public	Lexer for the Latex language.
Lisp : Int32	public	Lexer for Lisp.
Lot : Int32	public	Lexer for MPT specific LOT files i.e. the text log file created by the MPT application while running a test program.
Lout : Int32	public	Lexer for the Basser Lout (>= version 3) typesetting language.
Lua : Int32	public	Lexer for the Lua language.
MakeFile : Int32	public	Lexer for make files.
Matlab : Int32	public	Lexer for Matlab (See Octave).
Metapost : Int32	public	Lexer for Metapost.
NnCrontab : Int32	public	Lexer to use with extended crontab files used by a powerful Windows scheduler/event monitor/automation manager nnCron.
Nsis : Int32	public	Lexer for NSIS.
Null : Int32	public	Null lexer.
Octave : Int32	public	Lexer for Octave (See ).
Pascal : Int32	public	Lexer for Pascal. Note that this uses the lexer with different keyword groups.
Perl : Int32	public	Lexer for the Perl programming language.
Php : Int32	public	PHP lexer. This should NOT be used in new code - use the HTML lexer instead.
PhpScript : Int32	public	Lexer for PHP scripts.
PostScript : Int32	public	Lexer for PostScript.
PovRay : Int32	public	Lexer for POV-Ray.
PowerBasic : Int32	public	Lexer for PowerBasic.
Properties : Int32	public	Lexer for Properties files - e.g. the .properties files used by Scite.
PureBasic : Int32	public	Lexer for PureBasic (See and ).
Python : Int32	public	Lexer for Python.
Rebol : Int32	public	Lexer for REBOL.
Ruby : Int32	public	Lexer for Ruby.
Scriptol : Int32	public	Lexer for Scriptol.
Smalltalk : Int32	public	Lexer for Smalltalk.
SpecmanE : Int32	public	Lexer for Specman E.
Sql : Int32	public	Lexer for SQL, including PL/SQL and SQL*Plus. Use the struct member for T-SQL.
TadS3 : Int32	public	Lexer for TADS3.
Tcl : Int32	public	Lexer for Tcl.
TeX : Int32	public	Lexer for TeX.
TSql : Int32	public	Lexer for Microsoft's Transact-SQL (See SQL).
Vb : Int32	public	Lexer for Visual Basic and VBScript.
VBScript : Int32	public	Lexer for VBScript - this is the same as the lexer.
Verilog : Int32	public	Lexer for Verilog.
Vhdl : Int32	public	Lexer for VHDL.
XCode : Int32	public	Lexer for XCode.
Xml : Int32	public	Lexer for XML.
Yaml : Int32	public	Lexer for YAML.

Method Members

Name	Access	Summary

Styles Structure

Summary

public structure Styles

This class holds the style constants used for setting styles in Scintilla. Language styles have been grouped into structs differentiating the different languages, so it's easier to find styles with intellisense.

Remarks

Note that due to the ongoing development of Scintilla and the addition of lexers, this struct is unlikely to ever cater for all styles for all languages - you will need to look in SciLexer.h (included with the original Scintilla source) for the value you want if it is not provided here. Probably the easiest way to work out what style numbers to use is to load up Scite and look for the relevant options file. These generally contain comments for the various styles that apply to the relevant language.

Field Members

Name	Access	Summary
BraceBad : Int32	public	This style sets the display attributes used when marking an unmatched brace with the message.
BraceLight : Int32	public	This style sets the attributes used when highlighting braces with the message and when highlighting the corresponding indentation with .
ControlChar : Int32	public	This style sets the font used when drawing control characters. Only the font, size, bold, italics, and character set attributes are used and not the colour attributes.
Default : Int32	public	This style defines the attributes that all styles receive when the method is called.
IndentGuide : Int32	public	This style sets the foreground and background colours used when drawing the indentation guides.
LastPredefined : Int32	public	To make it easier for client code to discover the range of styles that are predefined, this is set to the style number of the last predefined style. This is currently set to 39 and the last style with an identifier is 37, which reserves space for future predefined styles.
LineNumber : Int32	public	This style sets the attributes of the text used to display line numbers in a line number margin. The background colour set for this style also sets the background colour for all margins that do not have any folding mask bits set i.e. any margin with the mask & set to 0. See Scintilla documentation and for more about masks.
Max : Int32	public	This is not a style but is the number of the maximum style that can be set. Styles between and would be appropriate if you used to set more than 5 style bits.

Method Members

Name	Access	Summary

Styles.Ada Structure

Summary

nestedPublic structure Styles.Ada

Struct holding constants for the ADA language.

Field Members

Name	Access	Summary
Character : Int32	public	Characters.
CharacterEol : Int32	public	End of line where character is not closed.
CommentLine : Int32	public	Line comments.
Default : Int32	public	Default style for the lexer.
Identifier : Int32	public	Identifiers.
Illegal : Int32	public	Illegal tokens.
Keyword : Int32	public	Keywords.
Label : Int32	public	Labels.
Number : Int32	public	Numbers.
Operator : Int32	public	Operators/Delimiters.
String : Int32	public	Strings.
StringEol : Int32	public	End of line where string is not closed.

Method Members

Name	Access	Summary

Styles.Asp Structure

Summary

nestedPublic structure Styles.Asp

Struct holding constants for Active Server Pages (ASP) languages. Supported languages are VBScript, JavaScript and Python. This should be used in conjunction with the struct.

Field Members

Name	Access	Summary
JsCommentBlock : Int32	public	JavaScript block comment.
JsCommentDoc : Int32	public	JavaScript documentation comment.
JsCommentLine : Int32	public	JavaScript line comment.
JsDefault : Int32	public	JavaScript default.
JsKeyword : Int32	public	JavaScript keywords.
JsNumber : Int32	public	JavaScript number.
JsRegEx : Int32	public	JavaScript regular expressions.
JsStart : Int32	public	JavaScript Start - allows eol filled background to not start on same line as SCRIPT tag.
JsStringDouble : Int32	public	JavaScript double-quoted strings.
JsStringEol : Int32	public	JavaScript end-of-line area after unclosed strings.
JsStringSingle : Int32	public	JavaScript single-quoted strings.
JsSymbol : Int32	public	JavaScript symbols.
JsWord : Int32	public	JavaScript words i.e. any words that are not keywords.
PyCharacter : Int32	public	Python character (single-quotes).
PyClassName : Int32	public	Python Class name definition.
PyCommentLine : Int32	public	Python line comment.
PyDefault : Int32	public	Python default.
PyDefName : Int32	public	Python function or method name definition.
PyIdentifier : Int32	public	Python identifier.
PyKeyword : Int32	public	Python keyword.
PyNumber : Int32	public	Python number.
PyOperator : Int32	public	Python operator.
PyStart : Int32	public	Python start - allows eol filled background to not start on same line as SCRIPT tag.
PyString : Int32	public	Python string (double-quotes).
PyTriple : Int32	public	Python triple quotes.
PyTripleDouble : Int32	public	Python triple double quotes.
VbsCommentLine : Int32	public	VbScript line comment.
VbsDefault : Int32	public	VbScript default.
VbsIdentifier : Int32	public	VbScript identifier.
VbsKeyword : Int32	public	VbScript keyword.
VbsNumber : Int32	public	VbScript number.
VbsStart : Int32	public	VbScript start - allows eol filled background to not start on same line as SCRIPT tag.
VbsString : Int32	public	VbScript string.
VbsStringEol : Int32	public	VbScript string end-of-line area after unclosed strings.

Method Members

Name	Access	Summary

Styles.Basic Structure

Summary

nestedPublic structure Styles.Basic

Struct holding constants for Basic style languages. Supported languages are Visual Basic, FreeBasic, BlitzBasic, PowerBasic and PureBasic.

Field Members

Name	Access	Summary
Assembler : Int32	public	In-line assembler (not used by all basic lexers).
Comment : Int32	public	Comments.
Constant : Int32	public	Constants (not used by all basic lexers).
Date : Int32	public	Dates.
Default : Int32	public	Default style for the lexer.
Error : Int32	public	Errors (not used by all basic lexers).
Identifier : Int32	public	Identifiers.
Keyword : Int32	public	Keywords.
KeywordUser1 : Int32	public	Other user-defined keywords.
KeywordUser2 : Int32	public	Other user-defined keywords.
KeywordUser3 : Int32	public	Other user-defined keywords.
Label : Int32	public	Labels (not used by all basic lexers).
Number : Int32	public	Numbers.
NumberBinary : Int32	public	Binary numbers (not used by all basic lexers).
NumberHex : Int32	public	Hex numbers (not used by all basic lexers).
Operator : Int32	public	Operators.
PreProcessor : Int32	public	Preprocessor (directives).
String : Int32	public	Strings.
StringEol : Int32	public	End of line where string is not closed.

Method Members

Name	Access	Summary

Styles.Batch Structure

Summary

nestedPublic structure Styles.Batch

Struct holding constants for batch files (.bat).

Field Members

Name	Access	Summary
Command : Int32	public	External commands.
Comment : Int32	public	Comment (rem or ::).
Default : Int32	public	Default style.
Hide : Int32	public	Hide command character ('@').
Identifier : Int32	public	Identifiers/variables: %%x (x is almost whatever, except space and %), %n (n in [0-9]), %EnvironmentVar% commands.
Keyword : Int32	public	Keywords.
Label : Int32	public	Label (line beginning with ':').
Operator : Int32	public	Operator: * ? < > \|.

Method Members

Name	Access	Summary

Styles.C Structure

Summary

nestedPublic structure Styles.C

Struct holding constants for the C language and it's derivatives (C++, Java, C#, JavaScript, etc). Only set the styles you want when using this lexer e.g. line documentation comment styles should not be set for JavaScript.

Field Members

Name	Access	Summary
Character : Int32	public	Characters or single-quoted strings.
CommentBlock : Int32	public	Block comment /* */.
CommentBlockDoc : Int32	public	Documentation comment: block comments beginning with /** or /*!
CommentLine : Int32	public	Line Comment: //
CommentLineDoc : Int32	public	Documentation comment line: line comments beginning with /// or //!.
Default : Int32	public	Default style for the lexer.
GlobalClass : Int32	public	Unknown: unclear as to what this style constant is for as it is not used in the version of SciTE.
Identifier : Int32	public	Identifiers.
KeywordDoc : Int32	public	Documentation keyword.
KeywordDocError : Int32	public	Documentation keyword error.
KeywordPrimary : Int32	public	Keywords.
KeywordSecondary : Int32	public	Secondary keywords.
Number : Int32	public	Number.
Operator : Int32	public	Operators.
PreProcessor : Int32	public	Preprocessors.
RegEx : Int32	public	Regular expressions for JavaScript.
String : Int32	public	Double-quoted strings.
StringEol : Int32	public	End of line where string is not closed.
Uuid : Int32	public	UUIDs (only in IDL)
Verbatim : Int32	public	Verbatim strings for C#.

Method Members

Name	Access	Summary

Styles.Config Structure

Summary

nestedPublic structure Styles.Config

Configuration styles e.g. for Apache configuration files (*.conf, *.htaccess).

Field Members

Name	Access	Summary
Comment : Int32	public	Comments.
Default : Int32	public	Default style for the lexer.
Directive : Int32	public	Apache runtime directive.
Extension : Int32	public	Extensions (e.g. .gz, .tgz, .html).
Identifier : Int32	public	Identifiers.
IPAddress : Int32	public	IP addresses.
Number : Int32	public	Numbers.
Operator : Int32	public	Operators.
Parameter : Int32	public	Parameters for Apache Runtime directives.
String : Int32	public	Strings (double-quoted).

Method Members

Name	Access	Summary

Styles.Css Structure

Summary

nestedPublic structure Styles.Css

Struct holding constants for Cascading stylesheets (CSS).

Field Members

Name	Access	Summary
Attribute : Int32	public	Attribute selection ([att='val']).
Class : Int32	public	Class selector (<HtmlTag>.classSelector).
Comment : Int32	public	Comments.
Default : Int32	public	Default style for the lexer. This colours whitespace, and is only visible if whitespace is made visible in Scintilla, or if it has a background colour.
Directive : Int32	public	Directive / at-rule (@).
Id : Int32	public	ID selector (#divId).
Identifier : Int32	public	Identifiers / properties.
Identifier2 : Int32	public	CSS2 Identifiers / properties.
IdentifierUnknown : Int32	public	Unknown identifiers / properties.
Important : Int32	public	Important.
Operator : Int32	public	Operators.
PseudoClass : Int32	public	Pseudo class (<HtmlTag>:pseudoClass).
PseudoClassUnknown : Int32	public	Unknown pseudo class.
Selector : Int32	public	Selector / Html tag.
StringDouble : Int32	public	Double-quoted strings.
StringSingle : Int32	public	Single-quoted strings.
Value : Int32	public	Values.

Method Members

Name	Access	Summary

Styles.Diff Structure

Summary

nestedPublic structure Styles.Diff

Struct holding constants for Diff files (*.diff, *.patch).

Field Members

Name	Access	Summary
Added : Int32	public	Lines added (+...).
Command : Int32	public	Commands (diff ...).
Comment : Int32	public	Comments (part before "diff ..." or "--- ..." and , Only in ..., Binary file...).
Default : Int32	public	Default style for the lexer.
Deleted : Int32	public	Lines deleted (-...).
Header : Int32	public	Headers: Source file (--- ...) and Destination file (+++ ...).
Position : Int32	public	Position setting (@@ ...).

Method Members

Name	Access	Summary

Styles.ErrorList Structure

Summary

nestedPublic structure Styles.ErrorList

This struct defines styles that can be used for common error lists.

Field Members

Name	Access	Summary
AbsoftFortran : Int32	public	Absoft Pro Fortran 90/95 v8.2 error or warning.
Borland : Int32	public	Borland error and warning messages.
Command : Int32	public	Command or return status.
CTag : Int32	public	CTags.
Default : Int32	public	Default style for the lexer.
DiffAddition : Int32	public	Diff addition (+).
DiffChanged : Int32	public	Diff changed (!).
DiffDeletion : Int32	public	Diff deletion (-).
DiffMessage : Int32	public	Diff message (---).
DotNet : Int32	public	.NET tracebacks.
Gcc : Int32	public	GCC error.
IntelFortranCompiler : Int32	public	Intel Fortran Compiler error.
IntelFortranCompiler8 : Int32	public	Intel Fortran Compiler v8.0 error/warning.
JavaStack : Int32	public	Java runtime stack trace.
LaheyFortran90 : Int32	public	Essential Lahey Fortran 90 error.
Lua : Int32	public	Lua error and warning messages.
Microsoft : Int32	public	Microsoft error.
Perl : Int32	public	Perl error and warning messages.
Php : Int32	public	PHP error.
Python : Int32	public	Python error.
Tidy : Int32	public	HTML Tidy.

Method Members

Name	Access	Summary

Styles.Html Structure

Summary

nestedPublic structure Styles.Html

Struct holding constants for HTML and similar markup languages. This struct should be used for most markup languages e.g. HTML, XML, SGML, etc. It also contains the styles to be used for embedded client-side scripting languages e.g. JavaScript, VbScript, Python, etc. Server-side languages (ASP, PHP) etc. are dealt separately.

Field Members

Name	Access	Summary
AspTag : Int32	public	ASP tags ('<%' and '%>').
AspTag2 : Int32	public	ASP tags ('<%' and '%>'). Updating this style does not seem to affect visible styles - use .
Attribute : Int32	public	Attributes. These are also set in the keywords property (the same as items.
AttributeUnknown : Int32	public	Unknown attributes.
CData : Int32	public	CDATA.
Comment : Int32	public	Comments.
CommentJsp : Int32	public	JSP comments (<%-- ... --%>).
Default : Int32	public	Default style i.e. text in the document.
Entity : Int32	public	Entities.
JsCommentBlock : Int32	public	Embedded JavaScript block comment.
JsCommentDoc : Int32	public	Embedded JavaScript documentation comment.
JsCommentLine : Int32	public	Embedded JavaScript line comment.
JsDefault : Int32	public	Embedded JavaScript default.
JsKeyword : Int32	public	Embedded JavaScript keywords.
JsNumber : Int32	public	Embedded JavaScript number.
JsRegEx : Int32	public	Embedded JavaScript regular expressions.
JsStart : Int32	public	Start of embedded JavaScript - allows eol filled background to not start on same line as SCRIPT tag.
JsStringDouble : Int32	public	Embedded JavaScript double-quoted strings.
JsStringEol : Int32	public	Embedded JavaScript end-of-line area after unclosed strings.
JsStringSingle : Int32	public	Embedded JavaScript single-quoted strings.
JsSymbol : Int32	public	Embedded JavaScript symbols.
JsWord : Int32	public	Embedded JavaScript words i.e. any words that are not keywords.
Number : Int32	public	Numbers.
PhpTag : Int32	public	Php tags ('<?' and '?>').
PyCharacter : Int32	public	Embedded Python character (single-quotes).
PyClassName : Int32	public	Embedded Python Class name definition.
PyCommentLine : Int32	public	Embedded Python line comment.
PyDefault : Int32	public	Embedded Python default.
PyDefName : Int32	public	Embedded Python function or method name definition.
PyIdentifier : Int32	public	Embedded Python identifier.
PyKeyword : Int32	public	Embedded Python keyword.
PyNumber : Int32	public	Embedded Python number.
PyOperator : Int32	public	Embedded Python operator.
PyStart : Int32	public	Embedded Python start - allows eol filled background to not start on same line as SCRIPT tag.
PyString : Int32	public	Embedded Python string (double-quotes).
PyTriple : Int32	public	Embedded Python triple quotes.
PyTripleDouble : Int32	public	Embedded Python triple double quotes.
Script : Int32	public	Client-side script area.
SgmlBlock : Int32	public	SGML block.
SgmlCommand : Int32	public	SGML commands.
SgmlComment : Int32	public	SGML comments.
SgmlCommentFirstParam : Int32	public	SGML first parameter comment.
SgmlEntity : Int32	public	SGML entities.
SgmlError : Int32	public	SGML errors.
SgmlFirstParam : Int32	public	SGML 1st parameter.
SgmlSpecial : Int32	public	SGML special items.
SgmlStringDouble : Int32	public	SGML double-quoted string.
SgmlStringSingle : Int32	public	SGML single-quoted string.
SgmlTag : Int32	public	SGML tags (<! ... >).
StringDouble : Int32	public	Double-quoted strings.
StringSingle : Int32	public	Single-quoted strings.
Tag : Int32	public	Tags. These need to be set as .
TagEnd : Int32	public	XML style tag ends '/>'.
TagOther : Int32	public	Other tokens within a tag.
TagUnknown : Int32	public	Unknown tags i.e. tags not set as one of the keywords.
ValueUnquoted : Int32	public	Unquoted values.
VbsCommentLine : Int32	public	Embedded VbScript line comment.
VbsDefault : Int32	public	Embedded VbScript default.
VbsIdentifier : Int32	public	Embedded VbScript identifier.
VbsKeyword : Int32	public	Embedded VbScript keyword.
VbsNumber : Int32	public	Embedded VbScript number.
VbsStart : Int32	public	Embedded VbScript start - allows eol filled background to not start on same line as SCRIPT tag.
VbsString : Int32	public	Embedded VbScript string.
VbsStringEol : Int32	public	Embedded VbScript string end-of-line area after unclosed strings.
XmlEnd : Int32	public	XML identifier end '?>'.
XmlStart : Int32	public	XML identifier start '<?'.

Method Members

Name	Access	Summary

Styles.Latex Structure

Summary

nestedPublic structure Styles.Latex

Struct holding constants for Latex.

Field Members

Name	Access	Summary
Command : Int32	public	Commands.
Comment : Int32	public	Comments.
Default : Int32	public	Default style.
Math : Int32	public	Math.
Tag : Int32	public	Tags.

Method Members

Name	Access	Summary

Styles.Lua Structure

Summary

nestedPublic structure Styles.Lua

Struct holding constants for Lua.

Field Members

Name	Access	Summary
Character : Int32	public	Characters (single-quoted strings).
CommentBlock : Int32	public	Block comment (Lua 5.0).
CommentDoc : Int32	public	Documentation comments - not used in Lua yet.
CommentLine : Int32	public	Line comments.
Default : Int32	public	Default style.
Identifier : Int32	public	Identifiers (everything else).
Keyword : Int32	public	Keywords.
KeywordUser1 : Int32	public	User defined keywords.
KeywordUser2 : Int32	public	User defined keywords.
KeywordUser3 : Int32	public	User defined keywords.
KeywordUser4 : Int32	public	User defined keywords.
KeywordUser5 : Int32	public	User defined keywords.
KeywordUser6 : Int32	public	User defined keywords.
KeywordUser7 : Int32	public	User defined keywords.
Number : Int32	public	Numbers.
Operator : Int32	public	Operators.
Preprocessor : Int32	public	Preprocessor (obsolete in Lua 4.0 and up).
String : Int32	public	Strings (double-quoted).
StringEol : Int32	public	End of line where string is not closed
StringLiteral : Int32	public	Literal strings.

Method Members

Name	Access	Summary

Styles.Makefile Structure

Summary

nestedPublic structure Styles.Makefile

Struct holding constants for Make files.

Field Members

Name	Access	Summary
Comment : Int32	public	Comments: #.
Default : Int32	public	Default style for the lexer.
Error : Int32	public	Errors.
Identifier : Int32	public	Identifiers/variables: $(x).
Operator : Int32	public	Operators..
Preprocessor : Int32	public	Pre-processor or other comment: !
Target : Int32	public	Targets.

Method Members

Name	Access	Summary

Styles.Perl Structure

Summary

nestedPublic structure Styles.Perl

Struct holding constants for Perl.

Field Members

Name	Access	Summary
Array : Int32	public	Array: @var.
BackTicks : Int32	public	Back ticks.
Character : Int32	public	Characters (single-quoted strings).
CommentLine : Int32	public	Line comments.
DataSection : Int32	public	Data Section: __DATA__ or __END__ at beginning of line.
Default : Int32	public	Default style i.e. whitespace.
Error : Int32	public	Errors.
Hash : Int32	public	Hash: %var.
HereDelimiter : Int32	public	Here-doc delimiter.
HereQBackTick : Int32	public	Here-doc back ticks, qx.
HereQDouble : Int32	public	Here-doc double-quoted, qq.
HereQSingle : Int32	public	Here-doc single-quoted, q.
Identifier : Int32	public	Identifiers.
Keyword : Int32	public	Keywords.
LongQuote : Int32	public	Long Quote (qq, qr, qw, qx) -- obsolete: replaced by qq, qx, qr, qw.
Number : Int32	public	Numbers.
Operator : Int32	public	Operators.
Pod : Int32	public	POD: = at beginning of line.
PodVerbatim : Int32	public	POD: verbatim paragraphs.
PreProcessor : Int32	public	Preprocessor. Currently not used by the lexer.
Punctuation : Int32	public	Symbols / Punctuation. Currently not used by the lexer.
RegEx : Int32	public	Regular expressions: /re/ or m{re} indexer.
RegSubst : Int32	public	Regular expressions substitution: s/re/ore/.
Scalar : Int32	public	Scalars: $var.
String : Int32	public	Strings (double-quoted).
StringQuoteArray : Int32	public	qw = string quote array.
StringQuoteBackTick : Int32	public	qx = Back ticks.
StringQuoteDouble : Int32	public	qq = Double quoted string.
StringQuoteRegEx : Int32	public	qr = string quote regular expressions.
StringQuoteSingle : Int32	public	Single quoted string, generic.
SymbolTable : Int32	public	Symbol table: *var.
VariableIndexer : Int32	public	Variable indexer.

Method Members

Name	Access	Summary

Styles.Php Structure

Summary

nestedPublic structure Styles.Php

Struct holding constants for the PHP language that can be embedded in HTML. This struct declares PHP-specific style groups - see the struct for the style used for colouring PHP tags ( embedded into HTML.

Field Members

Name	Access	Summary
CommentBlock : Int32	public	PHP block comments style number.
CommentLine : Int32	public	PHP line comments style number.
ComplexVariable : Int32	public	PHP complex variable.
Default : Int32	public	Default for PHP text (i.e. text between preprocessor tags)
KeywordPrimary : Int32	public	PHP keywords.
Number : Int32	public	Number.
Operator : Int32	public	PHP Operator.
StringDouble : Int32	public	Double-quoted string.
StringSingle : Int32	public	Single-quoted string.
Variable : Int32	public	PHP variable.
VariableString : Int32	public	PHP variable in a double-quoted string.

Method Members

Name	Access	Summary

Styles.Properties Structure

Summary

nestedPublic structure Styles.Properties

Struct holding constants for properties files e.g. .properties files, .ini files, .cfg files, etc.

Field Members

Name	Access	Summary
Assignment : Int32	public	Assignment operator.
Comment : Int32	public	Comments.
Default : Int32	public	Default style.
DefaultValue : Int32	public	Default value (@).
Section : Int32	public	Sections.

Method Members

Name	Access	Summary

Styles.Python Structure

Summary

nestedPublic structure Styles.Python

Struct holding constants for the Python language.

Field Members

Name	Access	Summary
Character : Int32	public	Characters (single-quoted string).
ClassName : Int32	public	Class name definition.
CommentBlock : Int32	public	Block comments.
CommentLine : Int32	public	Line comments.
Decorator : Int32	public	Decorators.
Default : Int32	public	Default for white space.
Function : Int32	public	Function or method name definition.
Identifier : Int32	public	Identifiers.
KeywordPrimary : Int32	public	Primary keywords.
KeywordSecondary : Int32	public	Secondary keywords / highlighted identifiers.
Number : Int32	public	Numbers.
Operator : Int32	public	Operators.
String : Int32	public	Strings.
StringEol : Int32	public	End of line where string is not closed.
TripleDoubleQuote : Int32	public	Triple double quotes.
TripleQuote : Int32	public	Triple quotes.

Method Members

Name	Access	Summary

Styles.Ruby Structure

Summary

nestedPublic structure Styles.Ruby

Struct holding constants for Ruby.

Field Members

Name	Access	Summary
BackTicks : Int32	public
Character : Int32	public	Characters (single-quoted strings).
ClassName : Int32	public	Class names.
ClassVariable : Int32	public	Class variables.
CommentLine : Int32	public	Line comments.
DataSection : Int32	public
Default : Int32	public	Default style i.e. whitespace.
Error : Int32	public	Errors.
Global : Int32	public
HereDelimiter : Int32	public
HereQDouble : Int32	public
HereQSingle : Int32	public
HereQX : Int32	public
Identifier : Int32	public	Identifiers.
InstanceVariable : Int32	public	Instance variables.
Keyword : Int32	public	Keywords.
KeywordDemoted : Int32	public
ModuleName : Int32	public	Module names.
Number : Int32	public	Numbers.
Operator : Int32	public	Operators.
Pod : Int32	public	POD: = at beginning of line.
PreProcessor : Int32	public	Def name.
RegEx : Int32	public	Regular expressions.
StdErr : Int32	public
StdIn : Int32	public
StdOut : Int32	public
String : Int32	public	Strings (double-quoted).
StringQuoteArray : Int32	public
StringQuoteBackTick : Int32	public
StringQuoteDouble : Int32	public
StringQuoteRegEx : Int32	public
StringQuoteSingle : Int32	public
Symbol : Int32	public	Symbols
UpperBound : Int32	public

Method Members

Name	Access	Summary

Styles.Sql Structure

Summary

nestedPublic structure Styles.Sql

Struct holding constants for SQL (Structured Query Language). These styles should be used for SQL*Plus and PL/SQL. Use the struct for Microsoft's Transact-SQL.

Field Members

Name	Access	Summary
Character : Int32	public	Character (single-quoted strings).
CommentBlock : Int32	public	Block comment.
CommentDoc : Int32	public	Documentation comment.
CommentLine : Int32	public	Line comment.
CommentLineDoc : Int32	public	Hash line comment.
Default : Int32	public	Default style.
Identifier : Int32	public	Identifiers.
KeywordCommentDoc : Int32	public	Comment documentation keywords.
KeywordCommentDocError : Int32	public	Comment documentation keyword errors.
KeywordPrimary : Int32	public	Keyword.
KeywordSecondary : Int32	public	Secondary keywords.
KeywordUser1 : Int32	public	User defined keywords (Group 1).
KeywordUser2 : Int32	public	User defined keywords (Group 2).
KeywordUser3 : Int32	public	User defined keywords (Group 3).
KeywordUser4 : Int32	public	User defined keywords (Group 4).
Number : Int32	public	Number.
Operator : Int32	public	Operators.
QuotedIdentifier : Int32	public	Quoted identifiers.
SqlPlus : Int32	public	SQL*Plus.
SqlPlusComment : Int32	public	SQL*Plus comment.
SqlPlusPrompt : Int32	public	SQL*Plus prompt.
String : Int32	public	String (double-quoted strings).

Method Members

Name	Access	Summary

Styles.TSql Structure

Summary

nestedPublic structure Styles.TSql

Struct holding constants for Transact-SQL (T-SQL). These styles should be used for Microsoft's Transact-SQL only - use the struct standard SQL, PL/SQL, etc..

Field Members

Name	Access	Summary
CommentBlock : Int32	public	Block comment.
CommentLine : Int32	public	Line comment.
DataType : Int32	public	Data types - these must be declared as keywords for the relevant lexer group.
Default : Int32	public	Default style.
Function : Int32	public	Functions - these must be declared as keywords for the relevant lexer group e.g. fn_get_sql.
GlobalVariable : Int32	public	Global variables - these must be declared as keywords for the relevant lexer group e.g. connections.
Identifier : Int32	public	Identifiers.
Number : Int32	public	Number.
Object : Int32	public	Objects names declared in double quotes.
Object2 : Int32	public	Objects names declared in square brackets ([..]).
Operator : Int32	public	Operators - these must be declared as keywords for the relevant lexer group.
PrefDataType : Int32	public	Pref. data type. TODO: What does this highlight?
Statement : Int32	public	Statements - these must be declared as keywords for the relevant lexer group.
StoredProcedure : Int32	public	System stored procedures - these must be declared as keywords for the relevant lexer group e.g. sp_catalogs.
String : Int32	public	String.
SystemTable : Int32	public	System tables - these must be declared as keywords for the relevant lexer group e.g. sysallocations.
Variable : Int32	public	Variables.

Method Members

Name	Access	Summary

ScintillaDotNet Classes

Scintilla Class

Summary

public class Scintilla : UserControl, System.ComponentModel.IComponent, System.IDisposable, System.ComponentModel.ISynchronizeInvoke, System.Windows.Forms.IWin32Window, System.Windows.Forms.IContainerControl

This forms a wrapper over the Scintilla control written in C++. This class takes care of loading the library using the SciLexer DLL - the method must be called before anything else is done. Properties and methods of the control are implemented in a more standard .NET way.

Remarks

Setting Styles:

See the property for an example of how to set styles.

Missing Members:

If something is not implemented, you can use the property along with the class to send your own messages to the control, for example:

OS.SendMessage(scintilla.ScintillaHandle, messageNumber, wPARAM, lPARAM);

Notes on the design of ScintillaDotNet:Enumerations and Constants Scintilla constants are all declared as numbers. For .NET, many of these would be better represented as enumerations, but this then causes a problem when implementing properties - there's no point implementing properties/methods to receive these enumerations as parameter types because then if new constants are added to Scintilla, they won't be available to users of the wrapper. So, properties and methods always use the same data type as Scintilla. Enumerations could still be used and cast as ints, but this means continually casting, which can get messy with bitwise operations. As such, constants have been grouped into structs in the Constants.cs file - this allows similar constants to be grouped together, but still be declared as the correct data type. For example:

    scintilla.EolMode = Eol.CrLf;    // Eol is a ScintillaDotNet struct

Methods/Properties I've tried to keep consistent with how I implement the Scintilla instructions. I've probably not always been 100% successful, but the general theory behind the implementation is:

If an instruction performs something or requires multiple parameters, it is a method.
If an instruction just gets/sets information that applies to the control, and requires 0 or 1 arguments, it is a property.
In some cases, instructions have not been implemented as methods, but have been added as constants in the class. The main reason here was to try and limit the amount of methods of the , for example implementing methods for every call to move to the end of the line, beginning of the line, page up, etc just added too much bloat to the class.

Constructor Members

Name	Access	Summary
Scintilla()	public	Constructor for class Scintilla control.

Field Members

Name	Access	Summary
CallTipDown : String	public	String representation of the up arrow used for call tips.
CallTipUp : String	public	String representation of the up arrow used for call tips.
InvalidPosition : Int32	public	Signifies an invalid position in the document.
MaskFolders : Int32	public	A mask for the 7 logical symbols used to denote folding. Matches the Scintilla constant SC_MASK_FOLDERS (-33554432).
Null : Int32	public	Does nothing and is the value assigned to keys that perform no action.
TimeForever : Int32	public	Setting to this value turns of the and events.

Property Members

Name	Access	Summary
AnchorPos : Int32	public	Gets/sets the current anchor position. When setting, this sets the anchor position and creates a selection between the anchor position and the current position. The caret is not scrolled into view. NOTE: The inconsistent naming here (unlike other properties, it is named differently to the Scintilla GETANCHOR/SETANCHOR messages on which it is based) is due to the fact that there is already an Anchor property on the control which should not be hidden.
AutocActive : Boolean	public	Gets whether there is an active autocompletion list.
AutocAutoHide : Boolean	public	By default, the list is cancelled if there are no viable matches (the user has typed characters that no longer match a list entry). If you want to keep displaying the original list, set this property to false. This also effects .
AutocCancelAtStart : Boolean	public	The default behavior is for autocompletion lists is to be cancelled if the caret moves before the location it was at when the list was displayed. By calling this message with a false argument, the list is not cancelled until the caret moves before the first character of the word being completed.
AutocChooseSingle : Boolean	public	If set to true and a list has only one item, the item is automatically added and no list is displayed. The default is to display the list even if there is only a single item i.e. false.
AutocCurrent : Int32	public	Gets the current autocomplete selection index (where 0 is the first item).
AutocDropRestOfWord : Boolean	public	When an item is selected, any word characters following the caret are first erased if set true. The default is false.
AutocFillUps : String	public	Sets autocompletion fillup characters. If a fillup character is typed with an autocompletion list active, the currently selected item in the list is added into the document, then the fillup character is added. Common fillup characters are '(', '[' and '.' but others are possible depending on the language. By default, no fillup characters are set.
AutocIgnoreCase : Boolean	public	Gets/sets whether autocompletion lists are case-sensitive. By default, they are.
AutocMaxHeight : Int32	public	Get or set the maximum number of rows that will be visible in an autocompletion list. If there are more rows in the list, then a vertical scrollbar is shown. The default is 5.
AutocMaxWidth : Int32	public	Gets/sets the maximum width of an autocompletion list expressed as the number of characters in the longest item that will be totally visible. If zero (the default) then the list's width is calculated to fit the item with the most characters. Any items that cannot be fully displayed within the available width are indicated by the presence of ellipsis.
AutocPosStart : Int32	public	Gets the position of the character when autocompletion was initiated.
AutocSeparator : Char	public	Gets/sets the separator used between autocompletion words. This defaults to a space.
AutocStops : String	public	Sets the list of characters that will automatically cancel the autocompletion list. This list is intially empty.
AutocTypeSeparator : Char	public	Gets/sets the character used to separate text and images in autocompletion word lists. This defaults to '?'.
BackspaceUnindents : Boolean	public	Gets/sets whether the backspace key deletes a character, or just unindents.
BufferedDraw : Boolean	public	Gets/sets buffered drawing and reports the buffered drawing state. Buffered drawing draws each line into a bitmap rather than directly to the screen and then copies the bitmap to the screen. This avoids flickering although it does take longer. The default is for drawing to be buffered.
CallTipActive : Boolean	public	Gets whether there is an active autocompletion list.
CallTipBack : Color	public	Gets/sets the background colour of call tips.
CallTipFore : Color	public	Gets/sets the foreground colour of call tips.
CallTipForeHighlight : Color	public	Gets/sets the foreground colour of the highlighted area in a call tip.
CallTipPosStart : Int32	public	Gets the value of the last position when started to display the tip (initially 0).
CanPaste : Boolean	public	Used to determine whether a paste action can be performed.
CanRedo : Boolean	public	Used to determine whether there is something to revert that has been undone.
CanUndo : Boolean	public	Whether there is something to undo in the undo buffer.
CaretFore : Color	public	Gets/sets the foreground colour of the caret.
CaretLineBack : Color	public	Gets/sets the background colour to paint the caret line if it is set to be painted a different colour (by setting CaretLineVisible to true).
CaretLineVisible : Boolean	public	Gets/sets whether to paint the caret line a different colour. The colour used is specified using the CaretLineBack property.
CaretPeriod : Int32	public	Gets/sets the caret blink rate in milliseconds (default value is 500).
CaretSticky : Boolean	public	Gets/sets a flag which controls when the last position of the caret on the line is saved. When set to true, the position is not saved when you type a character, a tab, paste the clipboard content or press backspace.
CaretWidth : Int32	public	Gets/sets the width of the caret - possible values are 0, 1, 2 or 3 pixels. The default width is 1 pixel.
CodePage : Int32	public	Scintilla has some support for Japanese, Chinese and Korean DBCS. This property tells Scintilla to use code page information to ensure double byte characters are treated as one character rather than two. This also stops the caret from moving between the two bytes in a double byte character. Set to zero (the default) to disable DBCS support.
ControlCharSymbol : Int32	public	By default, Scintilla displays control characters (characters with codes less than 32) in a rounded rectangle as ASCII mnemonics: "NUL", "SOH", "STX", "ETX", "EOT", "ENQ", "ACK", "BEL", "BS", "HT", "LF", "VT", "FF", "CR", "SO", "SI", "DLE", "DC1", "DC2", "DC3", "DC4", "NAK", "SYN", "ETB", "CAN", "EM", "SUB", "ESC", "FS", "GS", "RS", "US". These mnemonics come from the early days of signaling, though some are still used (LF = Line Feed, BS = Back Space, CR = Carriage Return, for example). You can choose to replace these mnemonics by a nominated symbol with an ASCII code in the range 32 to 255. If you set a symbol value less than 32, all control characters are displayed as mnemonics. The symbol you set is rendered in the font of the style set for the character. The default symbol value is 0.
CurrentPos : Int32	public	Gets/sets the current position. When setting, this sets the current position and creates a selection between the anchor and the current position. The caret is not scrolled into view.
Cursor : Int32	public	Gets/sets the cursor displayed over the Scintilla control. See the Scintilla.Cursor* constants for information on what cursors can be displayed.
DirectFunction : IntPtr	public	Gets the address of the function to call to handle Scintilla messages without the overhead of passing through the Windows messaging system. The value of this function will be the same for all Scintilla windows.
DirectPointer : IntPtr	public	Gets a pointer to data that identifies which Scintilla window is in use. This can be used for faster access.
DocPointer : IntPtr	public	Gets/sets the document pointer for an editor window. This can be used for multiple views on the same document. Note that the views do NOT share styles, only the text displayed. Getting the pointer returns a pointer to the document currently in use by the window. It has no other effect. Setting the pointer does the following: It removes the current window from the list held by the current document.It reduces the reference count of the current document by 1.If the reference count reaches 0, the document is deleted.The pointer is set as the new document for the window.If set to 0, a new, empty document is created and attached to the window.If not set to 0, its reference count is increased by 1.
EdgeColour : Color	public	Gets/sets set the colour of the marker used to show that a line has exceeded the length set by . The default colour is silver.
EdgeColumn : Int32	public	Gets/sets the column number at which to display the long line marker. When drawing lines, the column sets a position in units of the width of a space character in . When setting the background colour, the column is a character count (allowing for tabs) into the line.
EdgeMode : Int32	public	Gets/sets the mode used to display long lines. Possible values are contained in the enumeration.
EndAtLastLine : Boolean	public	Gets/sets the scroll range. Setting this to true (the default) means the maximum scroll position has the last line at the bottom of the view. Setting this to false allows scrolling one page below the last line.
EndStyled : Int32	public	Scintilla keeps a record of the last character that is likely to be styled correctly. This is moved forwards when characters after it are styled and moved backwards if changes are made to the text of the document before it. Before drawing text, this position is checked to see if any styling is needed and, if so, a SCN_STYLENEEDED notification message is sent to the container. The container can send SCI_GETENDSTYLED to work out where it needs to start styling. Scintilla will always ask to style whole lines.
EolMode : Int32	public	Gets/sets the characters that are added into the document when the user presses the Enter key. You can set this to one of Scintilla.Eol*.
FirstVisibleLine : Int32	public	Gets the first visible line of the current document. This is a 0-based index.
FoldMarginColour : Color	public	Changes the colour of the fold margin. This defaults to .
FoldMarginHighlightColour : Color	public	Changes the highlight colour of the fold margin. This defaults to .
HideSelection : Boolean	public	Sets whether selected text is shown as selected or not i.e. drawn in a different style. The normal state is to make the selection visible by drawing it as set by SetSelFore and SetSelBack. However, if you hide the selection, it is drawn as normal text.
HighlightGuide : Int32	public	Gets/sets the highlight guide column for indent markers. When brace highlighting occurs, the indentation guide corresponding to the braces may be highlighted with the brace highlighting style, . Set 0 to cancel this highlight.
HotSpotActiveBack : Color	public	Gets/sets the background colour of hotspots when the mouse over them. The default is Color.Empty, as hotspots inherit the styles of the parent item. Setting this to Color.Empty removes any applied hotspot color.
HotSpotActiveFore : Color	public	Gets/sets the foreground colour of hotspots when the mouse over them. The default is Color.Empty, as hotspots inherit the styles of the parent item. Setting this to Color.Empty removes any applied hotspot color.
HotSpotActiveUnderline : Boolean	public	Gets/sets whether hotspots are underlined when the mouse hovers over them. The default is true.
HotSpotSingleLine : Boolean	public	Gets/sets whether hotspots wrap onto next the line. The default is true i.e. hotspots are restricted to a single line.
HScrollBar : Boolean	public	Gets/sets whether the horizontal scrollbar is displayed. The horizontal scroll bar is only displayed if it is needed for the assumed width. If you never wish to see it, set this property to false. Set to true to enable it again. The default state is to display it when needed.
Indent : Int32	public	Gets/sets the size of indentation in terms of the width of a space in STYLE_DEFAULT. If you set a width of 0, the indent size is the same as the tab size. There are no limits on indent sizes, but values less than 0 or large values may have undesirable effects.
IndentationGuides : Boolean	public	Gets/sets whether indentation guides are displayed. Indentation guides are dotted vertical lines that appear within indentation white space every indent size columns. They make it easy to see which constructs line up especially when they extend over multiple pages. is used to specify the foreground and background colour of the indentation guides.
LayoutCache : Int32	public	Sets the layout caching policy with regards to line wrapping. This can be set to any of the Scintilla.Cache* constants. The default value is .
Length : Int32	public	Gets the length of the text (i.e. number of characters) in the control (0 if there is no text). This is the same as the TextLength property.
Lexer : Int32	public	Gets/sets the lexer to use. This can be any int accepted by the Scintilla control, but if possible user the constants. It is a good idea to call when changing lexers on an existing document, although this does not need to be done on documents that have never had any styles set on them. The method can be called after this to restyle a document.
LexerLanguage : String	public	Sets the lexer used according to the language string passed in. The language strings can can be found in the the relevant Scintilla lexer source files. The Restyle() method can be called after this to restyle a document.
LineCount : Int32	public	Gets the number of lines in the document. An empty document contains 1 line. A document holding only an end of line sequence has 2 lines.
LinesOnScreen : Int32	public	Gets the number of complete lines visible on the screen. With a constant line height, this is the vertical space available divided by the line separation. Unless you arrange to size your window to an integral number of lines, there may be a partial line visible at the bottom of the view.
MarginLeft : Int32	public	Gets/sets the width of the left blank margin - the default is one pixel.
MarginRight : Int32	public	Gets/sets the width of the right blank margin - the default is one pixel.
MaxLineState : Int32	public	Gets the last line that has line state set.
ModEventMask : Int32	public	Gets/sets an event mask that determines which document change events are notified to the container with the and events. The valid modification constants are contained in the enumeration.
Modify : Boolean	public	This returns true if the document is modified and false if it is unmodified.
MouseDownCaptures : Boolean	public	Gets/sets whether when the mouse is pressed inside Scintilla, it is captured so future mouse movement events are sent to Scintilla. This is on by default.
MouseDwellTime : Int32	public	Gets/sets the time the mouse must sit still, in milliseconds, to generate a event. If set to (the default), no dwell events are generated.
Overtype : Boolean	public	Gets/sets whether the ediotr is in overtype mode.
PasteConvertEndings : Boolean	public	Gets/sets whether line endings in pasted text are converted to match the document's end of line mode as set with . Currently only changeable on Windows. On GTK+ pasted text is always converted.
PrintColourMode : Int32	public	Gets/sets the method used to render coloured text on a printer that is probably using white paper. It is especially important to consider the treatment of colour if you use a dark or black screen background. Printing white on black uses up toner and ink very many times faster than the other way around. See enumeration for possible modes - is the default.
PrintMagnification : Int32	public	Gets/sets print magnification. This property lets you to print at a different size than the screen font. Magnification is the number of points to add to the size of each screen font. A value of -3 or -4 gives reasonably small print.
PrintWrapMode : Int32	public	Gets/sets the printer wrap mode. This can be set to (0), (1), or (2). The default is , which wraps printed output so that all characters fit into the print rectangle. If you set , each line of text generates one line of output and the line is truncated if it is too long to fit into the print area. tries to wrap only between words as indicated by white space or style changes although if a word is longer than a line, it will be wrapped before the line end. is preferred to for Asian languages where there is no white space between words.
ReadOnly : Boolean	public	Gets/sets whether the document is read-only.
ScintillaHandle : IntPtr	public	Gets the handle used for the embedded Scintilla control. If the control was not loaded, this will contain IntPtr.Zero. This can be used to send messages to the control from user applications if a method or property has not been implemented yet.
ScrollWidth : Int32	public	Gets/sets the scrolling width of the editor. For performance, Scintilla does not measure the display width of the document to determine the properties of the horizontal scroll bar. Instead, an assumed width is used. These messages set and get the document width in pixels assumed by Scintilla. The default value is 2000.
SearchFlags : Int32	public	Gets/sets the flags used when performing searchs on the editor. Use bitwise operations to use multiple flags.
SelectionBack : Color	public	Gets/sets the selection background colour.
SelectionEnd : Int32	public	Gets/sets the ending point of the currently selected text.
SelectionFore : Color	public	Gets/sets the selection foreground colour.
SelectionIsRectangle : Boolean	public	Gets whether the current selection is in rectangular mode.
SelectionMode : Int32	public	Gets/sets the current selection mode. Use the enumeration for valid selection modes. When set in these modes, regular caret moves will extend or reduce the selection, until the mode is cancelled by a call with the same value, with , or using the Escape key. The get function returns the current mode even if the selection was made by mouse or with regular extended moves. NOTE: This will only set the selection mode to anything other than stream temporarily so actions can be done in code - it will revert as soon as the user does any action. Holding down "Alt" while making a selection automatically selects text in rectangular mode.
SelectionStart : Int32	public	Gets/sets the starting point of the currently selected text.
SelText : String	public	Gets the currently selected text. If no text is selected, a zero-length string is returned.
Status : Int32	public	Gets/sets an internal error number. This is not currently used but will be in the future. This can be set to 0 to clear the error.
StyleBits : Int32	public	Gets/sets the number of style bits used by the control. This is usually set to 5, but some languages (e.g. HTML, PHP, etc) require this to be set to 7. Refer to Scinitilla documentation. The number of style bits needed for a lexer can be determined by checking the property.
StyleBitsNeeded : Int32	public	Gets the number of style bits needed for the current lexer.
TabIndents : Boolean	public	Gets/sets whether the tab key inserts a tab character, or just indents (no character inserted).
TabWidth : Int32	public	Gets/sets the size of a tab as a multiple of the size of a space character in STYLE_DEFAULT. The default tab width is 8 characters. There are no limits on tab sizes, but values less than 1 or large values may have undesirable effects.
TargetEnd : Int32	public	Gets/sets the end of a search target.
TargetStart : Int32	public	Gets/sets the start of a search target.
Text : String	public	Gets/sets the text in the Scintilla control.
TextLength : Int32	public	Gets the length of the text (i.e. number of characters) in the control (0 if there is no text). This is the same as the Length property.
TwoPhaseDraw : Boolean	public	Gets/sets whether style rendering is done in one or two phases. Two phase drawing is a better but slower way of drawing text. In single phase drawing each run of characters in one style is drawn along with its background. If a character overhangs the end of a run, such as in "V_" where the "V" is in a different style from the "_", then this can cause the right hand side of the "V" to be overdrawn by the background of the "_" which cuts it off. Two phase drawing fixes this by drawing all the backgrounds first and then drawing the text in transparent mode. Two phase drawing may flicker more than single phase unless buffered drawing is on. The default is for drawing to be two phase.
UndoCollection : Boolean	public	Gets/sets whether Scintilla collects undo information. Pass in true to collect information and false to stop collecting. If you stop collection, you should also use SCI_EMPTYUNDOBUFFER to avoid the undo buffer being unsynchronized with the data in the buffer.
UsePalette : Boolean	public	On 8 bit displays, which can only display a maximum of 256 colours, the graphics environment mediates between the colour needs of applications through the use of palettes. On GTK+, Scintilla always uses a palette. On Windows, there are some problems with visual flashing when switching between applications with palettes and it is also necessary for the application containing the Scintilla control to forward some messages to Scintilla for its palette code to work. Because of this, by default, the palette is not used and the application must tell Scintilla to use one. If Scintilla is not using a palette, it will only display in those colours already available, which are often the 20 Windows system colours.
UsePopUp : Boolean	public	Right-clicking the mouse pops up a short default editing menu. This may be turned off by setting this to false. If you turn it off, context menu commands will not be handled by Scintilla, so you can set the ContextMenu property of the control to display your own ContextMenu.
UseTabs : Boolean	public	Gets/sets whether spaces are used instead of tabs.
ViewEol : Boolean	public	Gets/sets whether end of line markers are visible or not.
ViewWhitespace : Int32	public	Gets/sets the white space display mode. Possible values are contained in the enumeration.
VScrollBar : Boolean	public	Gets/sets whether the vertical scrollbar is displayed. By default, the vertical scroll bar is always displayed when required.
WhitespaceBack : Color	public	Gets/sets the background colour of whitespace markers.
WhitespaceChars : String	public	Gets/sets which chars Scintilla considers as whitespace. Setting the whitespace chars allows the user to fine-tune Scintilla's behaviour doing such things as moving the cursor to the start or end of a word; for example, by defining punctuation chars as whitespace, they will be skipped over when the user presses ctrl+left or ctrl+right. This function should be called after as it will reset the whitespace characters to the default set. Note: This does NOT affect the visible whitespace - only the whitespace considered during navigation keystrokes.
WhitespaceFore : Color	public	Sets the foreground colour of whitespace markers.
WordChars : String	public	Scintilla has several functions that operate on words, which are defined to be contiguous sequences of characters from a particular set of characters. This message defines which characters are members of that set.
WrapMode : Int32	public	Gets/sets the wrapping mode of the control. See the enumeration for the possible options.
WrapStartIndent : Int32	public	Gets/sets the size of indentation of sublines for wrapped lines in terms of the width of a space in . There are no limits on indent sizes, but values less than 0 or large values may have undesirable effects. The indention of sublines is independent of visual flags, but if is set to , an indent of at least 1 is used.
WrapVisualFlags : Int32	public	Gets/sets what is shown at line wrapping (see Scintilla.WrapVisualFlag*).
WrapVisualFlagsLocation : Int32	public	Gets/sets where visual flags are shown at line wrapping (see Scintilla.WrapVisualFlagLoc*).
XOffset : Int32	public	Gets/sets the horizontal scroll position in pixels of the start of the text view. A value of 0 is the normal position with the first text column visible at the left of the view.
Zoom : Int32	public	Gets/sets the zoom display level of the document. This defaults to 0, and can be set to a positive or negative number.

Method Members

Name	Access	Summary
AddRefDocument() : Void	public	Increases the reference count of a document by 1.
AddText() : Void	public	This inserts the first length characters from the string at the current position. The current position is set at the end of the inserted text, but it is not scrolled into view.
AddText() : Void	public	Adds the supplied to the document at the current position. The current position is set at the end of the inserted text, but it is not scrolled into view.
Allocate() : Void	public	Allocate a document buffer large enough to store a given number of bytes. The document will not be made smaller than its current contents.
AppendText() : Void	public	This adds the first characters from the string to the end of the document. The current position is set at the end of the inserted text, but it is not scrolled into view.
AppendText() : Void	public	Adds the supplied to end of the document. The current position is set at the end of the inserted text, but it is not scrolled into view.
AssignCommandKey() : Void	public	Assign a keyboard definition to a Scintilla command - this is basically the message number of any method that does not accept any arguments.
AutocCancel() : Void	public	Cancels any displayed autocompletion list. When in autocompletion mode, the list should disappear when the user types a character that can not be part of the autocompletion, such as '.', '(' or '[' when typing an identifier. A set of characters that will cancel autocompletion can be specified with the property.
AutocComplete() : Void	public	Triggers autocompletion. This has the same effect as the tab key.
AutocSelect() : Void	public	This message selects an item in the autocompletion list. It searches the list of words for the first that matches select. By default, comparisons are case sensitive, but you can change this with . The match is character by character for the length of the select string. That is, if select is "Fred" it will match "Frederick" if this is the first item in the list that begins with "Fred". If an item is found, it is selected. If the item is not found, the autocompletion list closes if auto-hide is true (see ). The current selection can be retrieved with .
AutocShow() : Void	public	Causes an autocomplete list to be displayed.
BeginUndoAction() : Void	public	Marks the beginning of a set of operations that you want to undo all as one operation but that you have to generate as several operations. Alternatively, you can use this to mark a set of operations that you do not want to have combined with the preceding or following operations if they are undone.
BraceBadlight() : Void	public	If there is no matching brace then the brace badlighting style, style (35), can be used to show the brace that is unmatched. Using a position of (-1) removes the highlight.
BraceHighlight() : Void	public	Up to two characters can be highlighted in a 'brace highlighting style', which is defined as style number (34). If you have enabled indent guides, you may also wish to highlight the indent that corresponds with the brace. You can locate the column with SCI_GETCOLUMN and highlight the indent with .
BraceMatch() : Int32	public	Finds a corresponding matching brace given the position of one brace. The brace characters handled are '(', ')', '[', ']', '{', '}', '<', and '>'. The search is forwards from an opening brace and backwards from a closing brace. A match only occurs if the style of the matching brace is the same as the starting brace or the matching brace is beyond the end of styling. Nested braces are handled correctly.
CallTipCancel() : Void	public	Cancels any displayed call tip. Scintilla will also cancel call tips for you if you use any keyboard commands that are not compatible with editing the argument list of a function.
CallTipSetHighlight() : Void	public	Sets the region of the call tip text to display in a highlighted style. end minus start is the number of characters to highlight. Highlights can extend over line ends if this is required.
CallTipShow() : Void	public	Shows a call tip - small windows displaying the arguments to a function that are displayed after the user has typed the name of the function. Alternatively, call tips can be displayed when you leave the mouse pointer for a while over a word in response event and cancelled in response to . This method could be used in a debugger to give the value of a variable, or during editing to give information about the word under the pointer. Note that call tips do not work like autocompletion lists. They only display one string at a time - it is up to your application to toggle between call tips. The constants and can be used to display arrows for toggling between call tips.
ChooseCaretX() : Void	public	Scintilla remembers the x value of the last position horizontally moved to explicitly by the user and this value is then used when moving vertically such as by using the up and down keys. This message sets the current x position of the caret as the remembered value.
ClearAll() : Void	public	Clears all text in the control.
ClearAllCommandKeys() : Void	public	Clear all command keys associated with the control.
ClearCommandKey() : Void	public	Clears a command key set for the Scintilla control.
ClearDocumentStyle() : Void	public	Tells the control to clear all styles.
ClearRegisteredImages() : Void	public	Clears any registered autocompletion registered.
ClearSelection() : Void	public	Removes the currently selected text from the document (but does not paste it on the clipboard).
Colourise() : Void	public	This requests the current lexer or the container (if the lexer is set to SCLEX_CONTAINER) to style the document between startPos and endPos. If the "fold" property is set to "1" and your lexer or container supports folding, fold levels are also set. This message causes a redraw.
ConvertEols() : Void	public	Changes all the end of line characters in the document to match eolMode.
Copy() : Void	public	Copies selected text to the clipboard.
CopyRange() : Void	public	Copies a range of text from the document to the system clipboard.
CopyText() : Void	public	Copies a supplied piece of text to the system clipboard.
CreateDocument() : IntPtr	public	Creates a new, empty document and returns a pointer to it. This document is not selected into the editor and starts with a reference count of 1. This means that you have ownership of it and must either reduce its reference count by 1 after using so that the Scintilla window owns it or you must make sure that you reduce the reference count by 1 with before you close the application to avoid memory leaks.
Cut() : Void	public	Cuts selected text from the editor and places it on the system clipboard.
Dispose() : Void	protected	Clean up any resources being used.
DocLineFromVisible() : Int32	public	When some lines are hidden, then a particular line in the document may be displayed at a different position to its document position.
EmptyUndoBuffer() : Void	public	Tells Scintilla to forget any saved undo or redo history. It also sets the save point to the start of the undo buffer, so the document will appear to be unmodified. This does not cause the SavePointReached event to be raised.
EndUndoAction() : Void	public	Marks the end of a set of operations that you want to undo all as one operation but that you have to generate as several operations.
EnsureVisible() : Void	public	A line may be hidden because more than one of its parent lines is contracted. This travels up the fold hierarchy, expanding any contracted folds until they reach the top level. The line will then be visible. This only works for lines hidden using fold toggles, not for lines hidden using .
EnsureVisibleEnforcePolicy() : Void	public	Travels up the fold hierarchy, expanding any contracted folds until they reach the top level. The line will then be visible. The vertical caret policy set by is then applied. This only works for lines hidden using fold toggles, not for lines hidden using .
FindColumn() : Int32	public	Gets the position of a column on a line taking the width of tabs into account. It treats a multi-byte character as a single column. Column numbers, like lines start at 0.
FindText() : Int32	public	Finds text in the document.
GetCharAt() : Int32	public	This returns the character as an int at pos in the document or 0 if pos is negative or past the end of the document.
GetColumn() : Int32	public	Gets the column number of position pos within the document taking the width of tabs into account. This returns the column number of the last tab on the line before pos, plus the number of characters between the last tab and pos. If there are no tab characters on the line, the return value is the number of characters up to the position on the line. In both cases, double byte characters count as a single character. This is probably only useful with monospaced fonts.
GetCurLine() : Int32	public	Gets the text of the line containing the caret and returns the position within the line of the caret.
GetFocus() : Void	public	Tells the Scintilla control to get focus when doesn't suffice.
GetFoldExpanded() : Boolean	public	Gets the expanded state of a single line.
GetFoldLevel() : Int32	public	Gets a 32-bit value that contains the fold level of a line and some flags associated with folding.
GetFoldParent() : Int32	public	Gets the line number the folding parent of the specified line.
GetLastChild() : Int32	public	Searches for the next line after line, that has a folding level that is less than or equal to level and then returns the previous line number.
GetLine() : String	public	Gets the text on the specified line.
GetLineEndPosition() : Int32	public	Gets the position at the end of the line, before any line end characters. If line is the last line in the document (which does not have any end of line characters), the result is the size of the document. If line is negative or line >= LineCount, the result is undefined.
GetLineIndentation() : Int32	public	Gets the indentation of a particular line. The indentation is measured in character columns, which correspond to the width of space characters.
GetLineIndentPosition() : Int32	public	Gets the position at the end of indentation of a line.
GetLineSelEndPosition() : Int32	public	Get the position of the end of the selection at the given line with INVALID_POSITION returned if no selection exists on this line.
GetLineSelStartPosition() : Int32	public	Get the position of the start of the selection at the given line with INVALID_POSITION returned if no selection exists on this line.
GetLineState() : Int32	public	Gets the line state integer for the specified line.
GetLineVisible() : Boolean	public	Reports on the visible state of a line.
GetMarginMaskN() : Int32	public	Gets the margin mask for a particular margin. The mask is a 32-bit value, where each bit corresponds to one of 32 logical symbols that can be displayed in a margin that is enabled for symbols.
GetMarginSensitiveN() : Boolean	public	Determines whether a margin is sensitive to mouse clicks.
GetMarginTypeN() : Int32	public	Gets the type of a margin.
GetMarginWidthN() : Int32	public	Gets the width of the specified margin.
GetProperty() : String	public	Lookup a keyword:value pair using the specified key. Note that "keyword replacement" as described in will not be performed.
GetPropertyExpanded() : String	public	Lookup a keyword:value pair using the specified key. Note that "keyword replacement" as described in will be performed.
GetPropertyInt() : Int32	public	Lookup a keyword:value pair using the specified key.; Note that "keyword replacement" as described in will be performed before any numeric interpretation.
GetStyleAt() : Int32	public	Gets the style at pos in the document, or 0 if pos is negative or past the end of the document.
GoToLine() : Void	public	Removes any selection and sets the caret at the start of line number line and scrolls the view (if needed) to make it visible. The anchor position is set the same as the current position. If line is outside the lines in the document (first line is 0), the line set is the first or last.
GoToPos() : Void	public	This removes any selection, sets the caret at pos and scrolls the view to make the caret visible, if necessary. It is equivalent to SetSel(pos, pos). The anchor position is set the same as the current position.
GrabFocus() : Void	public	Tells the control to grab focus.
HideLines() : Void	public	Marks a range of lines as invisible and redraws the display.
IndicGetFore() : Color	public	Gets the colour used to draw an indicator.
IndicGetStyle() : Int32	public	Gets the style for a particular indicator. See Scintilla.Indicator* for possible return values.
IndicSetFore() : Void	public	Sets the colour used to draw an indicator.
IndicSetStyle() : Void	public	Sets the style for a particular indicator.
InsertText() : Void	public	Inserts the at position or at the current position if pos is -1. If the current position is after the insertion point then it is moved along with its surrounding text but no scrolling is performed.
LineDuplicate() : Void	public	Duplicate the current line.
LineFromPosition() : Int32	public	Gets the line that contains the position pos in the document.
LineLength() : Int32	public	Gets the length of a line, including any line end characters. If you want the length of the line not including any end of line characters, use - .
LineScroll() : Void	public	This will attempt to scroll the display by the number of columns and lines that you specify.
LinesJoin() : Void	public	Join a range of lines indicated by the current target into one line by removing line end characters. Where this would lead to no space between words, an extra space is inserted.
LinesSplit() : Void	public	Splits a range of lines indicated by the current target into lines that are at most pixelWidth wide. Splitting occurs on word boundaries wherever possible in a similar manner to line wrapping.
LoadLexerLibrary() : Void	public	Load a lexer implemented in a shared library. This is a .so file on GTK+/Linux or a .DLL file on Windows.
LoadLibrary() : Void	public	Loads the scintilla DLL into memory and draws it onto the control
LowerCase() : Void	public	Converts the currently selected text to lower case.
MarkerAdd() : Int32	public	Adds a marker number to a line. Markers must be defined using first.
MarkerDefine() : Void	public	This message associates a marker number in the range 0 to 31 with one of the marker symbols or an ASCII character.
MarkerDefinePixmap() : Void	public	Markers can be set to pixmaps with this message. The XPM format is used for the pixmap and it is limited to pixmaps that use one character per pixel.
MarkerDelete() : Void	public	Searches the given line number for the given marker number and deletes it if it is present. If you added the same marker more than once to the line, this will delete one copy each time it is used.
MarkerDeleteAll() : Void	public	Deletes all markers with the supplied marker number.
MarkerDeleteHandle() : Int32	public	Deletes a marker that has been assigned a handle using .
MarkerExists() : Boolean	public	Can be used to determine if the specified marker has been added to the specified line. This is a convenience function that is not implemented by the actual Scintilla control.
MarkerGet() : Int32	public	Gets a 32-bit integer that indicates which markers were present on a line.
MarkerLineFromHandle() : Int32	public	Searches for the line containing a marker with a handle returned by .
MarkerNext() : Int32	public	Searches for next line that contains the given marker.
MarkerNext() : Int32	public	Searches for the next line that includes one of the given markers.
MarkerPrevious() : Int32	public	Searches for the previous line containing the given marker.
MarkerPrevious() : Int32	public	Searches for the previous line that includes one of the given markers.
MarkerSetBack() : Void	public	Sets the background colour of a marker.
MarkerSetBack() : Void	public	Sets the background colour of a marker.
MarkerSetFore() : Void	public	Sets the foreground colour of a marker.
MarkerSetFore() : Void	public	Sets the foreground colour of a marker.
MoveCaretInsideView() : Void	public	If the caret is off the top or bottom of the view, this method moves it to the nearest line that is visible to its current position. Any selection is lost.
OnAutocSelection() : Void	protected	Called when an item in an autocompletion list is selected.
OnCallTipClick() : Void	protected	Called when a calltip is clicked.
OnChange() : Void	protected	Called when text in the document is changed.
OnCharAdded() : Void	protected	Called when a character is added to the control.
OnDoubleClick() : Void	protected	Called when the editor is double-clicked.
OnDwellEnd() : Void	protected	Called when a dwell period ends.
OnDwellStart() : Void	protected	Called when user keeps the mouse in one position for the dwell period.
OnGainFocus() : Void	protected	Called when the editor gains focus.
OnHotSpotClick() : Void	protected	Called when a hot spot in the document is clicked.
OnHotSpotDoubleClick() : Void	protected	Called when a hot spot in the document is double-clicked.
OnKillFocus() : Void	protected	Called when the editor loses focus.
OnMacroRecord() : Void	protected	Called when a recordable macro event occurs.
OnMarginClick() : Void	protected	Called when a sensitive margin is clicked.
OnModified() : Void	protected	Called when the text in the control is modified.
OnModifyAttemptRO() : Void	protected	Called when an attempt is made to modify a document with the ReadOnly property set to true.
OnNeedShown() : Void	protected	Called when Scintilla has determined that a range of lines that is currently invisible should be made visible.
OnPainted() : Void	protected	Called when painting is done on the control.
OnSavePointLeft() : Void	protected	Called when changes occur after the last save point.
OnSavePointReached() : Void	protected	Called when the last save point is reached during undo/redo operations.
OnStyleNeeded() : Void	protected	Called when the lexer has been set to .
OnUpdateUI() : Void	protected	Called whenever styling, text or the selection index changes.
OnUserListSelection() : Void	protected	Called when an item in a user list is selected,
OnZoomChanged() : Void	protected	Called when the zoom level of the control changes. The EventArgs with this event is empty as no additional information is supplied by scintilla.
Paste() : Void	public	Pastes text on the clipboard into the editor over the current selection.
PointXFromPosition() : Int32	public	Gets the x display pixel location of text at position pos in the document.
PointYFromPosition() : Int32	public	Gets the y display pixel location of text at position pos in the document.
PositionAfter() : Int32	public	Gets the position after another position in the document taking into account the current code page. The maximum is the last position in the document. If called with a position within a multi byte character, this will return the position of the end of that character.
PositionBefore() : Int32	public	Gets the position before another position in the document taking into account the current code page. The minimum position returned is 0. If called with a position within a multi byte character will return the position of the start of that character.
PositionFromLine() : Int32	public	Gets the caret position from the start of the supplied line.
PositionFromPoint() : Int32	public	Gets the closest character position to a point.
PositionFromPointClose() : Int32	public	Gets the closest character position to a point but returns -1 if the point is outside the window or not close to any characters.
ProcessDialogKey() : Boolean	protected	Overridden to ensure that all key strokes are forwarded on to the embedded Scintilla control. This must always return false, otherwise arrow keys and other command key strokes are lost.
Redo() : Void	public	Undoes the affect of the last undo operation.
RegisterImage() : Void	public	Autocompletion list items may display an image as well as text. Each image is first registered with an integer type, then this integer is included in the text of the list separated by a '?' from the text.
ReleaseDocument() : Void	public	Reduces the reference count of the document identified by ptr. ptr must be the result of or and must point at a document that still exists. If you call this on a document with a reference count of 1 that is still attached to a Scintilla window, bad things will happen. To keep the world spinning in its orbit you must balance each call to or with a call to ReleaseDocument.
ReplaceSel() : Void	public	Replaces the currently selected text between the anchor and the current position. If the anchor and current position are the same, the text is inserted at the caret position. The caret is positioned after the inserted text and the caret is scrolled into view.
ReplaceTarget() : Int32	public	Replaces the target with text. After replacement, the target range refers to the replacement text. Note that the recommanded way to delete text in the document is to set the target to the text to be removed, and to perform a replace target with an empty string.
ReplaceTargetRe() : Int32	public	Replaces the current target using regular expressions. The replacement string is formed from the text string with any sequences of \1 through \9 replaced by tagged matches from the most recent regular expression search. After replacement, the target range refers to the replacement text.
Restyle() : Void	public	This is a convenience method to force scintilla to update it's style patterns. This does the following: Sets StyleBits to that required by the Lexer (using StyleBitsNeeded)Calls ClearDocumentStyle() to reset all style definitions.Colourises the entire document by calling Colourise(0, -1)
ScrollCaret() : Void	public	If the current position (this is the caret if there is no selection) is not visible, the view is scrolled to make it visible according to the current caret policy.
SearchAnchor() : Void	public	Sets the search start point used by and to the start of the current selection, that is, the end of the selection that is nearer to the start of the document. You should always call this before calling either of or .
SearchInTarget() : Int32	public	Searches in the current target (Specified by TargetStart and TargetEnd) for the specified text. The search is modified by the search flags set by SearchFlags.
SearchNext() : Int32	public	Searches for the next occurrence of text. The search is modified by the searchFlags.
SearchPrevious() : Int32	public	Searches for the previous occurrence of text. The search is modified by the searchFlags. If you request a regular expression, this will find the first occurrence of the search string in the document, not the previous one before the anchor point.
SelectAll() : Void	public	Select all text in the control.
SendCommand() : Void	public	Convenience function to send simple commands to Scintilla.
SendMessage() : Int32	public	This is a convenience function for sending simple messages to Scintilla. For more complex message requirements, use the methods and the property.
SetCharsDefault() : Void	public	Use the default sets of word and whitespace characters. This sets whitespace to space, tab and other characters with codes less than 0x20, with word characters set to alphanumeric and '_'.
SetFocus() : Void	public	Sets the internal focus flag. This is used by clients that have complex focus requirements such as having their own window that gets the real focus but with the need to indicate that Scintilla has the logical focus.
SetFoldExpanded() : Void	public	Sets the expanded state of a single line. This has no effect on the visible state of the line or any lines that depend on it. It does change the markers in the folding margin. This should be used to do multiple expand updates without redrawing the display - usually it is easier to use the method.
SetFoldFlags() : Void	public	Sets folding flags so folding can be shown to the user by drawing lines in the text area. The lines are drawn in the foreground colour set for Styles.Default. Bits set in flags determine where folding lines are drawn.
SetFoldLevel() : Void	public	Sets a 32-bit value that contains the fold level of a line and some flags associated with folding. If you use a lexer, If you use a lexer, you should not need to use this method as this is far better handled by the lexer.
SetKeywords() : Void	public	Set the keywords for a particular keyword set. These are defined in the lexers themselves, for example the keyWordSet number for PHP keywords is defined in the HTML lexer as 4. Some keyword set constants have been defined for convenience in the class.
SetLineIndentation() : Void	public	Sets the indentation of a particular line. The indentation is measured in character columns, which correspond to the width of space characters.
SetLineState() : Void	public	Sets the line state integer for the specified line.
SetMarginMaskN() : Void	public	Sets the mask on a specified margin.
SetMarginSensitiveN() : Void	public	Toggles a margin's sensitivity to mouse clicks.
SetMarginTypeN() : Void	public	Sets the type of the margin.
SetMarginWidthN() : Void	public	Sets the width in pixels of the specified margin.
SetProperty() : Void	public	You can communicate settings to lexers with keyword:value string pairs. There is no limit to the number of keyword pairs you can set, other than available memory. key is a case sensitive keyword, value is a string that is associated with the keyword. If there is already a value string associated with the keyword, it is replaced. If you pass a zero length string, the message does nothing. Both key and value are used without modification; extra spaces at the beginning or end of key are significant. The value string can refer to other keywords. For example, SetProperty("foldTimes10", "$(fold)0") stores the string "$(fold)0", but when this is accessed, the $(fold) is replaced by the value of the "fold" keyword (or by nothing if this keyword does not exist). Currently the "fold" property is defined for most of the lexers to set the fold structure if set to "1". understands "tab.timmy.whinge.level" as a setting that determines how to indicate bad indentation. Most keywords have values that are interpreted as integers. Search the lexer sources for to see how properties are used.
SetSavePoint() : Void	public	This message tells Scintilla that the current state of the document is unmodified.
SetSelection() : Void	public	Sets both the anchor and the current position. The caret is scrolled into view after this operation.
SetStyling() : Void	public	Sets the style of length characters starting at the styling position and then increases the styling position by length, ready for the next call.
SetStylingEx() : Void	public	As an alternative to which applies the same style to each byte, you can use this method which specifies the styles for each of length bytes from the styling position and then increases the styling position by length, ready for the next call. The length styling bytes pointed at by styles should not contain any bits not set in mask.
SetVisiblePolicy() : Void	public	Determines how the vertical positioning is determined when is called. It takes and flags for the visiblePolicy parameter. It is similar in operation to .
SetXCaretPolicy() : Void	public	Sets the caret policy on the X-axis.
SetYCaretPolicy() : Void	public	Sets the caret policy on the Y-axis.
ShowLines() : Void	public	Marks a range of lines as visible and redraws the display.
StartRecord() : Void	public	Turns macro record on.
StartStyling() : Void	public	Prepares for styling by setting the styling position pos to start at and a mask indicating which bits of the style bytes can be set.
StopRecord() : Void	public	Turns macro record off.
StyleClearAll() : Void	public	Resets all styles to the default style (Styles.Default).
StyleResetDefault() : Void	public	Resets to its state when Scintilla was initialised.
StyleSetBack() : Void	public	Tells the control to draw behind the text in the background colour.
StyleSetBack() : Void	public	Tells the control to draw behind the text in the background colour.
StyleSetBold() : Void	public	Tells the control to draw the text in bold.
StyleSetCase() : Void	public	Sets how text is displayed. This does not change the stored text, only how it is displayed.
StyleSetChangeable() : Void	public	Gets/sets whether text in the specified style can be edited. NOTE: This is not completely implemented in version 1.67 of Scintilla, but has been added to the wrapper as it will be completed at some stage.
StyleSetCharacterSet() : Void	public	You can set a style to use a different character set than the default. The places where such characters sets are likely to be useful are comments and literal strings.
StyleSetEolFilled() : Void	public	Tells the control to colour the background of the entire line for the specified style. Note that this will override the background style set using SetStyleBackground.
StyleSetEolFilled() : Void	public	Tells the control to colour the background of the entire line for the specified style. Note that this will override the background style set using SetStyleBackground.
StyleSetFont() : Void	public	Tells the control to draw text in the specified font.
StyleSetFore() : Void	public	Tells the control to draw text in the foreground colour.
StyleSetFore() : Void	public	Tells the control to draw text in the foreground colour.
StyleSetHotSpot() : Void	public	This style is used to mark ranges of text that can detect mouse clicks. The cursor changes to a hand over hotspots, and the foreground, and background colours may change and an underline appear to indicate that these areas are sensitive to clicking. This may be used to allow hyperlinks to other documents.
StyleSetItalic() : Void	public	Tells the control to draw the text in italics.
StyleSetSize() : Void	public	Tells the control to draw text in the specified font size.
StyleSetUnderline() : Void	public	Tells the control to draw the text underlined.
StyleSetVisible() : Void	public	Text is normally visible. However, you can completely hide it by giving it a style with the visible set to false. This could be used to hide embedded formatting instructions or hypertext keywords in HTML or XML.
TargetFromSelection() : Void	public	Set the target start and end to the start and end positions of the current selection.
TextHeight() : Int32	public	This returns the height in pixels of a particular line. Currently all lines are the same height.
TextWidth() : Int32	public	This returns the pixel width of a string drawn in the given styleNumber which can be used, for example, to decide how wide to make the line number margin in order to display a given number of numerals.
ToggleCaretSticky() : Void	public	Toggles the current mode.
ToggleFold() : Void	public	Fold points may be either expanded, displaying all its child lines, or contracted, hiding all the child lines. This method toggles the folding state of the given line as long as it has the FoldLevelHeaderFlag set. This message takes care of folding or expanding all the lines that depend on the line. The display updates after this message.
ToggleOverType() : Void	public	Toggles overwrite/insert typing mode.
Undo() : Void	public	Undoes the last text change in the control.
UpperCase() : Void	public	Converts the currently selected text to upper case.
UserListShow() : Void	public	Displays a user list - see the Scintilla documentation as to how this differs from autocompletion lists. .
VisibleFromDocLine() : Int32	public	When some lines are folded, then a particular line in the document may be displayed at a different position to its document position. The display line of an invisible line is the same as the previous visible line. The display line number of the first line in the document is 0. Lines can occupy more than one display line if they wrap.
WndProc() : Void	protected	Overrides the WndProc method so we can receive notifications from the Scintilla control.
WordEndPosition() : Int32	public	Gets the end position of words using the same definition of words as used internally within Scintilla. You can set your own list of characters that count as words with .
WordStartPosition() : Int32	public	Gets the start position of words using the same definition of words as used internally within Scintilla. You can set your own list of characters that count as words with .
WrapCount() : Int32	public	Document lines can occupy more than one display line if they wrap and this returns the number of display lines needed to wrap a document line.
ZoomIn() : Void	public	Increases the zoom level of the text.
ZoomOut() : Void	public	Decreases the zoom level of the text.

UserListSelectionEventArgs Class

Summary

public class UserListSelectionEventArgs

This class is used to store data when an item is selected in a user list.

Constructor Members

Name	Access	Summary
UserListSelectionEventArgs()	public	Constructor.

Property Members

Name	Access	Summary
ListType : Int32	public	The type of list (defined by the user when the list was created).
Text : String	public	Gets the text of the selection.

Method Members

Name	Access	Summary

AutocSelectionEventArgs Class

Summary

public class AutocSelectionEventArgs

This class is used to store data when an item is selected in an autocompletion list.

Constructor Members

Name	Access	Summary
AutocSelectionEventArgs()	public	Constructor.

Property Members

Name	Access	Summary
Position : Int32	public	Gets the start position of the word being completed.
Text : String	public	Gets the text of the selection.

Method Members

Name	Access	Summary

CallTipClickEventArgs Class

Summary

public class CallTipClickEventArgs

Stores data when call tips are clicked.

Constructor Members

Name	Access	Summary
CallTipClickEventArgs()	public	Constructor.

Property Members

Name	Access	Summary
Position : Int32	public	Gets the position in the document that corresponds to the click. This is set to 1 if the click is in an up arrow, 2 if in a down arrow, and 0 if elsewhere.

Method Members

Name	Access	Summary

CharAddedEventArgs Class

Summary

public class CharAddedEventArgs

This class is used to store data when a character is added to a scintilla control.

Constructor Members

Name	Access	Summary
CharAddedEventArgs()	public	Constructor for CharAddedEventArgs.

Property Members

Name	Access	Summary
CharAdded : Char	public	Gets the character added to the control.

Method Members

Name	Access	Summary

DwellEventArgs Class

Summary

public class DwellEventArgs

Stores data when the user keeps the mouse in one position for the dwell period, which is set using .

Constructor Members

Name	Access	Summary
DwellEventArgs()	public	Constructor.

Property Members

Name	Access	Summary
Position : Int32	public	Gets the nearest position in the document to the position where the mouse pointer was lingering. If the pointer is nowhere near any text, this value is -1.
X : Int32	public	X-position of where the pointer lingered.
Y : Int32	public	Y-position of where the pointer lingered.

Method Members

Name	Access	Summary

HotSpotClickEventArgs Class

Summary

public class HotSpotClickEventArgs

Stores data when hot spots are clicked or double-clicked.

Constructor Members

Name	Access	Summary
HotSpotClickEventArgs()	public	Constructor.

Property Members

Name	Access	Summary
Modifiers : Int32	public	Gets the appropriate combination of Shift, Control and Alt to indicate the keys that were held down at the time of the click.
Position : Int32	public	Gets the position in the document that corresponds to the click.

Method Members

Name	Access	Summary

Keywords Class

Summary

public class Keywords

When setting keywords in Scintilla, you need to provide a number that tells Scintilla which keyword group you are setting. These are determined by looking in the individual lexers at what index in the arrays the keyword groups belong. This class provides convenience constants for setting keyword groups for individual lexers.

Remarks

Note that due to the ongoing development of Scintilla and the addition of lexers, this class is unlikely to ever cater for all keyword groups for all languages - you will need to look in the lexer files for the value you want if it is not provided here.

Field Members

Name	Access	Summary
Max : Int32	public	Maximum number used for keyword sets (8).

Method Members

Name	Access	Summary

MacroRecordEventArgs Class

Summary

public class MacroRecordEventArgs

Stores data required for MacroRecord events.

Constructor Members

Name	Access	Summary
MacroRecordEventArgs()	public	Constructor.

Property Members

Name	Access	Summary
LParam : Int32	public	Gets the value of the lParam in the SCI_* message.
Message : Int32	public	Gets the SCI_* message that caused the notification.
WParam : Int32	public	Gets the value of the wParam in the SCI_* message.

Method Members

Name	Access	Summary

MarginClickEventArgs Class

Summary

public class MarginClickEventArgs

Stores data when sensitive margins are clicked.

Constructor Members

Name	Access	Summary
MarginClickEventArgs()	public	Constructor.

Property Members

Name	Access	Summary
Margin : Int32	public	Gets the margin number that was clicked.
Modifiers : Int32	public	Gets the appropriate combination of SCI_SHIFT, SCI_CTRL and SCI_ALT to indicate the keys that were held down at the time of the margin click.
Position : Int32	public	Gets the position of the start of the line in the document that corresponds to the margin click.

Method Members

Name	Access	Summary

ModifiedEventArgs Class

Summary

public class ModifiedEventArgs : EventArgs

ModifiedEventArgs class - this is used to store data when the contents of the Scintilla control are modified.

Constructor Members

Name	Access	Summary
ModifiedEventArgs()	public	Constructor.

Property Members

Name	Access	Summary
FoldLevelNow : Int32	public	The new fold level applied to the line or 0 if this field is unused.
FoldLevelPrev : Int32	public	The previous folding level of the line or 0 if this field is unused.
Length : Int32	public	Gets the length of the change in cells or characters when the text or styling changes. This is set to 0 if not used.
Line : Int32	public	The line number at which a fold level or marker change occurred. This is 0 if unused and may be -1 if more than one line changed.
LinesAdded : Int32	public	Number of added lines. If negative, the number of deleted lines, 0 if not used or no lines added or deleted.
ModificationType : Int32	public	Gets the modification type that occurred. View the Scintilla documentation to see the Scintilla.Mod* and Scintilla.Performed* constants that can be checked to see what type of modification occurred.
Position : Int32	public	Gets the position that the modification occurred.
Text : String	public	Valid for text changes, not for style changes. If we are collecting undo information this holds a pointer to the text that is handed to the Undo system, otherwise it is zero. For user performed the text field is 0 and for user performed the text field points to an array of cells, not bytes and the length is the number of cells.

Method Members

Name	Access	Summary

NeedShownEventArgs Class

Summary

public class NeedShownEventArgs

Stores data when Scintilla has determined that a range of lines that is currently invisible should be made visible.

Constructor Members

Name	Access	Summary
NeedShownEventArgs()	public	Constructor.

Property Members

Name	Access	Summary
Length : Int32	public	Gets the length of the area that should be made visible.
Position : Int32	public	Gets the start position of the area that should be made visible.

Method Members

Name	Access	Summary

OS Class

Summary

public class OS

This class handles calls to the underlying operating system. It was called "OS" rather than "Win32" as GTK support will hopefully be added at a later stage.

Field Members

Name	Access	Summary
WM_COMMAND : Int32	public
WM_KEYDOWN : Int32	public
WM_NOTIFY : Int32	public
WM_SETFOCUS : Int32	public
WS_CHILD : Int32	public
WS_CLIPCHILDREN : Int32	public
WS_CLIPSIBLINGS : Int32	public
WS_DLGFRAME : Int32	public
WS_GROUP : Int32	public
WS_HSCROLL : Int32	public
WS_TABSTOP : Int32	public
WS_VISIBLE : Int32	public
WS_VSCROLL : Int32	public

Method Members

Name	Access	Summary
CreateWindowEx() : IntPtr	public
FreeLibrary() : Boolean	public
HiWord() : Int32	public	Gets the the High Order Word / HI Word / HIWORD (The group of the left 16 bits, or the left word) from a double word.
LoadLibrary() : IntPtr	public
LoWord() : Int32	public	Gets the the Low Order Word / LO Word / LOWORD (The group of the right 16 bits, or the right word) from a double word.
MoveWindow() : Boolean	public
SendMessage() : Int32	public
SendMessage() : Int32	public
SendMessage() : Int32	public
SendMessage() : Int32	public
SendMessage() : Int32	public
SendMessage() : Int32	public
SendMessage() : Int32	public
SendMessage() : Int32	public
SendMessage() : Int32	public
SendMessage() : Int32	public
SendMessage() : Int32	public
SendMessage() : Int32	public
SendMessage() : Int32	public

StyleNeededEventArgs Class

Summary

public class StyleNeededEventArgs

This class encapsulates the arguments required for the StyleNeeded event.

Constructor Members

Name	Access	Summary
StyleNeededEventArgs()	public	Constructor.

Property Members

Name	Access	Summary
EndPos : Int32	public	Gets the position where styling is required to.
StartPos : Int32	public	Gets the start position where styling is required from.

Method Members

Name	Access	Summary