ScintillaNET Wiki & Documentation Rss Feed

New Comment on "Installation"

KarlLam — Tue, 05 Feb 2013 09:47:47 GMT

I am using Visual Studio 2012. In setting Target Framework is .NET Framework 4.5 OK with ScintillaNet?

New Comment on "Installation"

kanaida — Sat, 02 Feb 2013 00:13:49 GMT

I can't drag and drop it onto the form from the toolbox. Cannot load the 'SciLexer.dll' module into memory ---> The specified file cannot be found at SchintillaNET.Scintilla.LoadModule() in 'C:\users\jslusser\Projects\ScintillaNET\Releases\2.5\Scintilla.cs:line 669 (and 2508, 3688)

New Comment on "HowToSyntax"

telmessosc — Sat, 29 Sep 2012 12:52:50 GMT

I read everything in here. But I still don't know how I can simply make PHP scripts colored. I have no idea about the usage of Lexer thing. Anyone can give me ideas?

Updated Wiki: ScintillaNET Types

jacobslusser — Tue, 28 Aug 2012 03:46:55 GMT

ScintillaNET Types

The following information is an abbreviated summary of the ScintillaNET types. It has been auto-generated from the project documentation comments.

ScintillaNET.Annotation

Represents a customizable read-only block of text which can be displayed below each line in a ScintillaNET.Scintilla control.

Properties
- LineCount Gets the total number of text lines in the annotation.
- LineIndex Gets the index of the document line containing the annotation.
- Style Gets or sets the index of the style used to style the annotation text.
- Text Gets or sets the text of the annotation.
Methods
- #ctor(ScintillaNET.Scintilla,System.Int32) Initializes a new instance of the ScintillaNET.Annotation class.
- Clear Removes all text and styles associated with the annotation.
- Equals(ScintillaNET.Annotation) Determines whether the specified ScintillaNET.Annotation is equal to the current ScintillaNET.Annotation .
- Equals(System.Object) Overridden. Determines whether the specified System.Object is equal to the current System.Object .
- GetHashCode Overridden. Serves as a hash function for a particular type.
- GetStyles Returns a ScintillaNET.StyleRun enumerable representing the individual character styling of the annotation text.
- op_Equality(ScintillaNET.Annotation,ScintillaNET.Annotation) Tests whether two ScintillaNET.Annotation objects have equal location and content.
- op_Inequality(ScintillaNET.Annotation,ScintillaNET.Annotation) Tests whether two ScintillaNET.Annotation object differ in location or content.
- SetStyles(System.Collections.Generic.IEnumerable{ScintillaNET.StyleRun}) Uses the enumerable ScintillaNET.StyleRun specified to individually style characters in the annotation text.

ScintillaNET.AnnotationChangedEventArgs

Provides data for the ScintillaNET.Scintilla.AnnotationChanged event.

Properties
- LineCountDelta Gets the number of lines added to or removed from the changed annotation.
- LineIndex Gets the index of the document line containing the changed annotation.
Methods
- #ctor(System.Int32,System.Int32) Initializes a new instance of the ScintillaNET.AnnotationChangedEventArgs class.

ScintillaNET.AnnotationCollection

Represents a collection of ScintillaNET.Annotation objects and options in a ScintillaNET.Scintilla control.

Properties
- Count Gets the number of annotations in the ScintillaNET.AnnotationCollection .
- Item(System.Int32) Gets the annotation at the specified line index.
- StyleOffset Gets or sets the offset applied to style indexes used in annotations.
- Visibility Gets or sets the visibility style for all annotations.
Methods
- #ctor(ScintillaNET.Scintilla) Initializes a new instance of the ScintillaNET.AnnotationCollection class.
- ClearAll Removes all annotations from the document.
- CreateAnnotationInstance(System.Int32) Creates and returns a new ScintillaNET.Annotation object.
- GetEnumerator Returns an enumerator for the ScintillaNET.AnnotationCollection .

ScintillaNET.AnnotationsVisibility

Specifies the visibility and appearance of annotations in a ScintillaNET.Scintilla control.

ScintillaNET.AutoComplete

Used to invoke AutoComplete and UserList windows. Also manages AutoComplete settings.

Properties
- AutoHide 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 AutoHide to false.
- AutomaticLengthEntered Gets or Sets the last automatically calculated LengthEntered used whith ScintillaNET.AutoComplete.Show .
- CancelAtStart The default behavior is for the list to be cancelled if the caret moves before the location it was at when the list was displayed. By setting this property to false, the list is not cancelled until the caret moves before the first character of the word being completed.
- DropRestOfWord When an item is selected, any word characters following the caret are first erased if dropRestOfWord is set to true.
- FillUpCharacters List of characters (no separated) that causes the AutoComplete window to accept the current selection.
- ImageSeparator 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. For example, "fclose?2 fopen" displays image 2 before the string "fclose" and no image before "fopen".
- IsActive Returns wether or not the AutoComplete window is currently displayed
- IsCaseSensitive Gets or Sets if the comparison of words to the AutoComplete ScintillaNET.AutoComplete.List are case sensitive.
- LastStartPosition Gets the document posision when the AutoComplete window was last invoked
- List List if words to display in the AutoComplete window when invoked.
- ListSeparator Character used to split ScintillaNET.AutoComplete.ListString to convert to a List.
- ListString List of words to display in the AutoComplete window.
- MaxHeight 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
- MaxWidth Get or set the maximum width of an autocompletion list expressed as the number of characters in the longest item that will be totally visible.
- SelectedIndex Gets or Sets the index of the currently selected item in the AutoComplete ScintillaNET.AutoComplete.List
- SelectedText Gets or Sets the Text of the currently selected AutoComplete item.
- SingleLineAccept If you set this value to true and a list has only one item, it is automatically added and no list is displayed. The default is to display the list even if there is only a single item.
- StopCharacters List of characters (no separator) that causes the AutoComplete window to cancel.
Methods
- Accept Accepts the current AutoComplete window entry
- Cancel Cancels the autocomplete window
- ClearRegisteredImages Deletes all registered images.
- RegisterImage(System.Int32,System.Drawing.Bitmap) Registers an image with index to be displayed in the AutoComplete window.
- RegisterImage(System.Int32,System.Drawing.Bitmap,System.Drawing.Color) Registers an image with index to be displayed in the AutoComplete window.
- RegisterImage(System.Int32,System.String) Registers an image with index to be displayed in the AutoComplete window.
- RegisterImages(System.Collections.Generic.IList{System.Drawing.Bitmap}) Registers a list of images to be displayed in the AutoComplete window.
- RegisterImages(System.Collections.Generic.IList{System.Drawing.Bitmap},System.Drawing.Color) Registers a list of images to be displayed in the AutoComplete window.
- RegisterImages(System.Collections.Generic.IList{System.String}) Registers a list of images to be displayed in the AutoComplete window.
- RegisterImages(System.Windows.Forms.ImageList) Registers a list of images to be displayed in the AutoComplete window.
- RegisterImages(System.Windows.Forms.ImageList,System.Drawing.Color) Registers a list of images to be displayed in the AutoComplete window.
- Show Shows the autocomplete window.
- Show(System.Collections.Generic.IEnumerable{System.String}) Shows the autocomplete window
- Show(System.Int32) Shows the autocomplete window
- Show(System.Int32,System.Collections.Generic.IEnumerable{System.String}) Shows the autocomplete window
- Show(System.Int32,System.String) Shows the autocomplete window.
- Show(System.String) Shows the autocomplete window.
- ShowUserList(System.Int32,System.Collections.Generic.IEnumerable{System.String}) Shows a UserList window
- ShowUserList(System.Int32,System.String) Shows a UserList window

ScintillaNET.AutoCompleteAcceptedEventArgs

Provides data for the AutoCompleteAccepted event

Properties
- Cancel Gets/Sets if the autocomplete action should be cancelled
- Text Text of the selected autocomplete entry selected
- WordStartPosition Returns the _start position of the current word in the document.
Methods
- #ctor(System.String) Initializes a new instance of the AutoCompleteAcceptedEventArgs class.

ScintillaNET.BindableCommand

List of commands that ScintillaNET can execute. These can be bound to keyboard shortcuts

ScintillaNET.CallTip

Used to display CallTips and Manages CallTip settings.

Properties
- BackColor Gets/Sets the background color of all CallTips
- ForeColor Gets/Sets Text color of all CallTips
- HighlightEnd End position of the text to be highlighted in the CalTip
- HighlightStart Start position of the text to be highlighted in the CalTip
- HighlightTextColor Gets/Sets the Text Color of the portion of the CallTip that is highlighted
- IsActive Returns true if a CallTip is currently displayed
- Message The message displayed in the calltip
- OverloadList List of method overloads to display in the calltip
Methods
- Cancel Hides the calltip
- Hide Hides the calltip
- Show Displays a calltip without overloads
- Show(System.Int32) Displays a calltip without overloads
- Show(System.Int32,System.Int32) Displays a calltip without overloads
- Show(System.Int32,System.Int32,System.Int32) Displays a calltip without overloads
- Show(System.String) Displays a calltip without overloads
- Show(System.String,System.Int32) Displays a calltip without overloads
- Show(System.String,System.Int32,System.Int32) Displays a calltip without overloads
- Show(System.String,System.Int32,System.Int32,System.Int32) Displays a calltip without overloads
- ShowOverload Shows the calltip with overloads
- ShowOverload(ScintillaNET.OverloadList) Shows the calltip with overloads
- ShowOverload(ScintillaNET.OverloadList,System.Int32) Shows the calltip with overloads
- ShowOverload(ScintillaNET.OverloadList,System.Int32,System.Int32) Shows the calltip with overloads
- ShowOverload(ScintillaNET.OverloadList,System.Int32,System.Int32,System.Int32) Shows the calltip with overloads
- ShowOverload(ScintillaNET.OverloadList,System.Int32,System.UInt32,System.Int32,System.Int32) Shows the calltip with overloads
- ShowOverload(ScintillaNET.OverloadList,System.UInt32) Shows the calltip with overloads
- ShowOverload(ScintillaNET.OverloadList,System.UInt32,System.Int32,System.Int32) Shows the calltip with overloads
- ShowOverload(System.Int32) Shows the calltip with overloads
- ShowOverload(System.Int32,System.Int32) Shows the calltip with overloads
- ShowOverload(System.Int32,System.Int32,System.Int32) Shows the calltip with overloads
- ShowOverload(System.Int32,System.UInt32) Shows the calltip with overloads
- ShowOverload(System.Int32,System.UInt32,System.Int32,System.Int32) Shows the calltip with overloads
- ShowOverload(System.UInt32) Shows the calltip with overloads
- ShowOverload(System.UInt32,System.Int32,System.Int32) Shows the calltip with overloads

ScintillaNET.CallTipArrow

Represents an arrow in the CallTip

ScintillaNET.CallTipClickEventArgs

Provides data for the CallTipClick event

Properties
- CallTipArrow Returns the CallTipArrow that was clicked
- Cancel Gets/Sets if the CallTip should be hidden
- CurrentIndex Gets the current index of the CallTip's overload list
- HighlightEnd Gets/Sets the _end position of the CallTip's highlighted portion of text
- HighlightStart Gets/Sets the _start position of the CallTip's highlighted portion of text
- NewIndex Gets/Sets the new index of the CallTip's overload list
- OverloadList Returns the OverLoad list of the CallTip
Methods
- #ctor(ScintillaNET.CallTipArrow,System.Int32,System.Int32,ScintillaNET.OverloadList,System.Int32,System.Int32) Initializes a new instance of the CallTipClickEventArgs class.

ScintillaNET.CaretInfo

Manages Caret Settings

Properties
- Anchor Gets/Sets the current anchor position
- BlinkRate Gets/Sets the time interval in milliseconds that the caret should blink.
- Color Gets/Sets the color of the Caret.
- CurrentLineBackgroundAlpha Gets/Sets the transparency alpha of the CurrentLine Background highlight
- CurrentLineBackgroundColor Gets/Sets the color of the document line where the caret currently resides
- HighlightCurrentLine Gets/Sets if the current document line where the caret resides is highlighted.
- IsSticky 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
- LineNumber Gets/Sets the current Line Number that the caret resides.
- Position Gets/Sets the current document position where the caret resides
- Style Gets/Sets the ScintillaNET.CaretStyle displayed.
- Width Gets/Sets the width in pixels of the Caret
Methods
- BringIntoView Places the caret somewhere within the document that is displayed in the Scintilla Window
- ChooseCaretX 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 method sets the current x position of the caret as the remembered value.
- EnsureVisible Scrolls the Scintilla window so that the Caret is visible.
- Goto(System.Int32) Places the caret at the specified document position

ScintillaNET.CaretStyle

The style of visual indicator that the caret displayes.

ScintillaNET.CharacterSet

The CharacterSet used by the document

ScintillaNET.CharAddedEventArgs

Provides data for the CharAdded event

Properties
- Ch Returns the character that was added
Methods
- #ctor(System.Char) Initializes a new instance of the CharAddedEventArgs class.

ScintillaNET.Clipboard

Provides methods to place data on and retrieve data from the system Clipboard.

Properties
- CanCopy Gets a value indicating whether text (bytes) can be copied given the current selection.
- CanCut Gets a value indicating whether text (bytes) can be cut given the current selection.
- CanPaste Gets a value indicating whether the document can accept text currently stored in the Clipboard.
- ConvertLineBreaksOnPaste Gets or sets whether pasted line break characters are converted to match the document's end-of-line mode.
Methods
- Copy Copies the current selection in the document to the Clipboard.
- Copy(System.Boolean) Copies the current selection, or the current line if there is no selection, to the Clipboard.
- Copy(System.Int32,System.Int32) Copies the specified range of text (bytes) in the document to the Clipboard.
- Cut Moves the current document selection to the Clipboard.
- Paste Replaces the current document selection with the contents of the Clipboard.

ScintillaNET.Commands

Manages commands, which are actions in ScintillaNET that can be bound to key combinations.

Properties
- AllowDuplicateBindings Gets/Sets if a key combination can be bound to more than one command. (default is true)
Methods
- AddBinding(System.Char,ScintillaNET.BindableCommand) Adds a key combination to a Command
- AddBinding(System.Char,System.Windows.Forms.Keys,ScintillaNET.BindableCommand) Adds a key combination to a Command
- AddBinding(System.Windows.Forms.Keys,ScintillaNET.BindableCommand) Adds a key combination to a Command
- AddBinding(System.Windows.Forms.Keys,System.Windows.Forms.Keys,ScintillaNET.BindableCommand) Adds a key combination to a Command
- Execute(ScintillaNET.BindableCommand) Executes a Command
- GetCommands(System.Char) Returns a list of Commands bound to a keyboard shortcut
- GetCommands(System.Char,System.Windows.Forms.Keys) Returns a list of Commands bound to a keyboard shortcut
- GetCommands(System.Windows.Forms.Keys) Returns a list of Commands bound to a keyboard shortcut
- GetCommands(System.Windows.Forms.Keys,System.Windows.Forms.Keys) Returns a list of Commands bound to a keyboard shortcut
- GetKeyBindings(ScintillaNET.BindableCommand) Returns a list of KeyBindings bound to a given command
- RemoveAllBindings Removes all key command bindings
- RemoveBinding(System.Char) Removes all commands bound to a keyboard shortcut
- RemoveBinding(System.Char,ScintillaNET.BindableCommand) Removes a keyboard shortcut / command combination
- RemoveBinding(System.Char,System.Windows.Forms.Keys) Removes all commands bound to a keyboard shortcut
- RemoveBinding(System.Char,System.Windows.Forms.Keys,ScintillaNET.BindableCommand) Removes a keyboard shortcut / command combination
- RemoveBinding(System.Windows.Forms.Keys) Removes all commands bound to a keyboard shortcut
- RemoveBinding(System.Windows.Forms.Keys,ScintillaNET.BindableCommand) Removes a keyboard shortcut / command combination
- RemoveBinding(System.Windows.Forms.Keys,System.Windows.Forms.Keys) Removes all commands bound to a keyboard shortcut
- RemoveBinding(System.Windows.Forms.Keys,System.Windows.Forms.Keys,ScintillaNET.BindableCommand) Removes a keyboard shortcut / command combination

ScintillaNET.Document

Provides an abstraction over Scintilla's Document Pointer

Properties
- Handle Scintilla's internal document pointer.
Methods
- AddRef Increases the document's reference count
- Equals(System.Object) Overridden.
- GetHashCode Overridden
- Release Decreases the document's reference count

ScintillaNET.DocumentHandler

Manages the Native Scintilla's Document features.

Properties
- Current Gets/Sets the currently loaded Document
Methods
- Create Creates a new Document

ScintillaNET.DocumentNavigation

Manages Document Navigation, which is a snapshot history of movements within a document.

Properties
- BackwardStack List of entries that allow you to navigate backwards.
- CanNavigateBackward Returns true if ScintillaNET can perform a successful backward navigation.
- CanNavigateForward Returns true if ScintillaNET can perform a successful forward navigation.
- ForewardStack List of entries that allow you to navigate forwards.
- IsEnabled Gets/Sets whether Document Navigation is tracked. Defaults to true.
- MaxHistorySize Maximum number of places the document navigation remembers. Defaults to 50.
- NavigationPointTimeout Time in milliseconds to wait before a Navigation Point is set. Default is 200
Methods
- NavigateBackward Causes the current position to navigate to the last snapshotted document position.
- NavigateForward After 1 or more backwards navigations this command navigates to the previous backwards navigation point.

ScintillaNET.DropMarker

Represents a DropMarker, currently a single document point.

Properties
- IsPoint Overridden. Drop Markers are points, not a spanned range. Though this could change in the future.
- Key Uniquely identifies the DropMarker
- TopOffset Not currently used, the offset in pixels from the document view's top.
Methods
- Change(System.Int32,System.Int32) Overridden, changes the document position. Start and End should match.
- Collect Collects the DropMarker and causes it to be removed from all lists it belongs ti.
- Dispose Overridden.
- GetClientRectangle Gets the Client Rectangle in pixels of the DropMarker's visual indicator.
- Invalidate Forces a repaint of the DropMarker

ScintillaNET.DropMarkerCollectEventArgs

Provides data for a DropMarkerCollect event

Properties
- DropMarker Returns the DropMarker that was collected
Methods
- #ctor(ScintillaNET.DropMarker) Initializes a new instance of the DropMarkerCollectEventArgs class.

ScintillaNET.DropMarkerList

Data structure used to store DropMarkers in the AllDocumentDropMarkers property.

ScintillaNET.DropMarkers

Manages DropMarkers, a Stack Based document bookmarking system.

Properties
- AllDocumentDropMarkers Gets/Sets a list of All DropMarkers specific to this Scintilla control
- MarkerStack Gets/Sets the Stack of DropMarkers
- SharedStackName Gets/Sets a shared name associated with other Scintilla controls.
Methods
- Collect Collects the last dropped DropMarker
- Drop Drops a DropMarker at the current document position
- Drop(System.Int32) Drops a DropMarker at the specified document position

ScintillaNET.EdgeMode

How long lines are visually indicated

ScintillaNET.EndOfLine

Manages End of line settings for the Scintilla Control

Properties
- EolString Return as a string the characters used to mean _end-of-line. This depends solely on the selected EOL mode.
- IsVisible Gets/Sets if End of line markers are visible in the Scintilla control.
- Mode Gets/Sets the ScintillaNET.EndOfLineMode for the document. Default is CrLf.
Methods
- ConvertAllLines(ScintillaNET.EndOfLineMode) Converts all lines in the document to the given mode.

ScintillaNET.EndOfLineMode

Document's EndOfLine Mode

ScintillaNET.FakeStack

Mostly behaves like a stack but internally maintains a List for more flexability

ScintillaNET.FindOption

Controls find behavior for non-regular expression searches

ScintillaNET.FoldChangedEventArgs

Provides data for the FoldChanged event

Properties
- Line Gets/Sets the Line # that the fold change occured on
- NewFoldLevel Gets the new Fold Level of the line
- PreviousFoldLevel Gets the previous Fold Level of the line
Methods
- #ctor(System.Int32,System.Int32,System.Int32,System.Int32) Initializes a new instance of the FoldChangedEventArgs class.

ScintillaNET.FoldFlag

The flags affecting how the fold is marked in the main text area (as well as in the margin). If the value changes for onscreen text, the display will redraw.

ScintillaNET.FoldLevel

The flags that are stored along with the fold level.

ScintillaNET.HotspotClickEventArgs

Provides data for the ScintillaNET.Scintilla.HotspotClick , ScintillaNET.Scintilla.HotspotDoubleClick , and ScintillaNET.Scintilla.HotspotReleaseClick events.

Properties
- Position Gets the byte offset in the document of the character that was clicked.
Methods
- #ctor(System.Int32) Initializes a new instance of the ScintillaNET.HotspotClickEventArgs class.

ScintillaNET.INativeScintilla

Interface representing the native Scintilla Message Based API. In addition to wrappers around each of the messages I have included an additional Method named SendMessageDirect with 9 overloads. This allows you to send messages to the Scintilla DefWndProc bypassing Windows' SendMessage. Each of the other methods wrap calls to SendMessageDirect. Scintilla explicetly implements this interface. To use these methods on a Scintilla control Cast it as INativeScintilla or use NativeScintilla property. The reason for this interface is to keep the "regular" interface surface area of the Scintilla control as clean and .NETish as possible. Also this means when you want a direct native interface there's no other absracted members (Aside from SendMessageDirect ;) cluttering the native interface.

ScintillaNET.IndicatorStyle

Style of Indicator to be displayed

ScintillaNET.InformationType

Type of data to display at one of the positions in a Page Information section

ScintillaNET.KeyBinding

Represents the Binding Combination of a Keyboard Key + Modifiers

Properties
- KeyCode Gets/Sets Key to trigger command
- Modifiers Gets sets key modifiers to the Keyboard shortcut
Methods
- #ctor(System.Windows.Forms.Keys,System.Windows.Forms.Keys) Initializes a new instance of the KeyBinding structure.
- Equals(System.Object) Overridden.
- GetHashCode Overridden
- ToString Overridden. Returns string representation of the Keyboard shortcut

ScintillaNET.LayoutCacheMode

Specifies the line layout caching strategy used by a ScintillaNET.Scintilla control.

ScintillaNET.Lexer

Built in lexers supported by Scintilla

ScintillaNET.LinesNeedShownEventArgs

Provides data for the LinesNeedShown event

Properties
- FirstLine Returns the first (top) line that needs to be shown
- LastLine Returns the last (bottom) line that needs to be shown
Methods
- #ctor(System.Int32,System.Int32) Initializes a new instance of the LinesNeedShownEventArgs class.

ScintillaNET.LineWrapping

Controls line wrapping options in a ScintillaNET.Scintilla control.

Properties
- IndentMode Gets or sets how wrapped lines are indented.
- IndentSize Gets or sets the size that wrapped lines are indented when ScintillaNET.LineWrapping.IndentMode is ScintillaNET.LineWrappingIndentMode.Fixed .
- Mode Gets or sets how and whether line wrapping is performed.
- VisualFlags Gets or sets the visual glyphs displayed on wrapped lines.
- VisualFlagsLocations Gets or sets the location of visual glyphs displayed on wrapped lines.
Methods
- #ctor(ScintillaNET.Scintilla) Initializes a new instance of the ScintillaNET.LineWrapping class.
- GetWrapCount(System.Int32) The number of lines displayed when a line of text is wrapped.
- WrapLines(System.Int32,System.Int32,System.Int32) Forces the line range specified to wrap at the given pixel width. This operates independently of the current ScintillaNET.Scintilla line wrapping ScintillaNET.LineWrapping.Mode property.

ScintillaNET.LineWrappingIndentMode

Specifies how wrapped lines are indented when line wrapping is enabled in a ScintillaNET.Scintilla control.

ScintillaNET.LineWrappingMode

Specifies the line wrapping modes that can be applied to a ScintillaNET.Scintilla control.

ScintillaNET.LineWrappingVisualFlags

Specifies how line wrapping visual glyphs are displayed in a ScintillaNET.Scintilla control.

ScintillaNET.LineWrappingVisualFlagsLocations

Specifies the locations of line wrapping visual glyphs in a ScintillaNET.Scintilla control.

ScintillaNET.MacroRecordEventArgs

Provides data for the MacroRecorded event

Properties
- RecordedMessage Returns the recorded window message that can be sent back to the native Scintilla window
Methods
- #ctor(ScintillaNET.NativeScintillaEventArgs) Initializes a new instance of the MacroRecordEventArgs class.
- #ctor(System.Windows.Forms.Message) Initializes a new instance of the MacroRecordEventArgs class.

ScintillaNET.MarginClickEventArgs

Provides data for the MarginClick event

Properties
- Line Returns the Document line # where the click occured
- Margin Returns the Margin where the click occured
- Modifiers Returns any Modifier keys (shift, alt, ctrl) that were in use at the time the click event occured
- Position Returns the Document position of the line where the click occured
- ToggleFold Gets/Sets whether the fold at the current line should be toggled
- ToggleMarkerNumber Gets/Sets the marker number that should be toggled in result of the click
Methods
- #ctor(System.Windows.Forms.Keys,System.Int32,ScintillaNET.Line,ScintillaNET.Margin,System.Int32,System.Boolean) Initializes a new instance of the MarginClickEventArgs class.

ScintillaNET.Marker

Defines a marker's appearance in a ScintillaNET.Scintilla control.

Properties
- Symbol Gets or sets the marker symbol.

ScintillaNET.MarkerChangedEventArgs

Provides data for the MarkerChanged event

Properties
- Line Returns the line number where the marker change occured
Methods
- #ctor(System.Int32,System.Int32) Initializes a new instance of the LinesNeedShownEventArgs class.

ScintillaNET.MarkerCollection

Represents a collection of ScintillaNET.Marker objects and options in a ScintillaNET.Scintilla control.

ScintillaNET.MarkerSymbol

Specifies the symbol displayed by a ScintillaNET.Marker .

ScintillaNET.ModifiedEventArgs

Base class for modified events

ScintillaNET.NativeScintillaEventArgs

Provides data for native Scintilla Events

Properties
- Msg Notification Message sent from the native Scintilla
- SCNotification SCNotification structure sent from Scintilla that contains the event data
Methods
- #ctor(System.Windows.Forms.Message,ScintillaNET.SCNotification) Initializes a new instance of the NativeScintillaEventArgs class.

ScintillaNET.NavigationPont

Represents a point in the document used for navigation.

Methods
- #ctor(System.Int32,ScintillaNET.Scintilla) Initializes a new instance of the NavigationPont class.
- Dispose Overridden.

ScintillaNET.NotifyHeader

This matches the Win32 NMHDR structure

ScintillaNET.OverloadList

List of strings to be used with ScintillaNET.CallTip .

Properties
- Current Text of the overload to be displayed in the CallTip
- CurrentIndex Index of the overload to be displayed in the CallTip
Methods
- #ctor Creates a new instance of an OverLoadList
- #ctor(System.Collections.Generic.IEnumerable{System.String}) Creates a new instance of an OverLoadList. The list of overloads is supplied by collection
- #ctor(System.Int32) Creates a new instance of an OverLoadList. The

ScintillaNET.PageInformation

Class for determining how and what to print for a header or footer.

Properties
- Border Border style used for the Page Information section
- Center Information printed in the center of the Page Information section
- Display Whether there is a need to display this item, true if left, center, or right are not nothing.
- Font Font used in printing the Page Information section
- Height Height required to draw the Page Information section based on the options selected.
- Left Information printed on the left side of the Page Information section
- Margin Space between the Page Information section and the rest of the page
- Right Information printed on the right side of the Page Information section
Methods
- #ctor Default Constructor
- #ctor(ScintillaNET.PageInformationBorder,ScintillaNET.InformationType,ScintillaNET.InformationType,ScintillaNET.InformationType) Normal Use Constructor
- #ctor(System.Int32,System.Drawing.Font,ScintillaNET.PageInformationBorder,ScintillaNET.InformationType,ScintillaNET.InformationType,ScintillaNET.InformationType) Full Constructor
- Draw(System.Drawing.Graphics,System.Drawing.Rectangle,System.String,System.Int32) Draws the page information section in the specified rectangle

ScintillaNET.PageInformationBorder

Type of border to print for a Page Information section

ScintillaNET.PageSettings

ScintillaNET derived class for handling printed page settings. It holds information on how and what to print in the header and footer of pages.

Properties
- ColorMode Method used to render colored text on a printer
- FontMagnification Number of points to add or subtract to the size of each screen font during printing
- Footer Page Information printed in the footer of the page
- Header Page Information printed in header of the page
Methods
- #ctor Default constructor

ScintillaNET.PrintColorMode

Controls color mode fore printing

ScintillaNET.PrintDocument

ScintillaNET derived class for handling printing of source code from a Scintilla control.

Methods
- #ctor(ScintillaNET.Scintilla) Default Constructor
- OnBeginPrint(System.Drawing.Printing.PrintEventArgs) Method called after the Print method is called and before the first page of the document prints
- OnEndPrint(System.Drawing.Printing.PrintEventArgs) Method called when the last page of the document has printed
- OnPrintPage(System.Drawing.Printing.PrintPageEventArgs) Method called when printing a page

ScintillaNET.PrintRectangle

Struct used for specifying the printing bounds

ScintillaNET.Properties.Resources

A strongly-typed resource class, for looking up localized strings, etc.

Properties
- Culture Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class.
- Exception_CannotCreateDirectFunction Looks up a localized string similar to Cannot create the Scintilla direct message function..
- Exception_CannotLoadModule Looks up a localized string similar to Cannot load the '{0}' module into memory..
- Exception_EmptyStringArgument Looks up a localized string similar to The '{0}' argument cannot be an empty string..
- Exception_EnumeratorEnded Looks up a localized string similar to Enumeration already finished..
- Exception_EnumeratorNotStarted Looks up a localized string similar to Enumeration has not started. Call MoveNext..
- Exception_IllegalCrossThreadCall Looks up a localized string similar to Cross-thread operation not valid: Control '{0}' accessed from a thread other than the thread it was created on..
- Exception_IndexOutOfRange Looks up a localized string similar to Index was out of range. Must be non-negative and less than the size of the collection..
- Exception_InsufficientSpace Looks up a localized string similar to Insufficient space in the target location to copy the information..
- Exception_InvalidAnnotation Looks up a localized string similar to A change in the control who created this annotation has rendered the object invalid..
- Exception_InvalidLine Looks up a localized string similar to The {0} line must specify a valid line within the document..
- Exception_InvalidLineRange Looks up a localized string similar to The start line and end line must specify a valid range..
- Exception_InvalidModule Looks up a localized string similar to '{0}' is not a valid Scintilla module..
- Exception_InvalidStartLine Looks up a localized string similar to The start line must be greater than or equal to zero..
- Exception_ModuleAlreadyLoaded Looks up a localized string similar to The module name must be set before any Scintilla object are created..
- Exception_MustBeNonNegativeAndLessThan Looks up a localized string similar to '{0}' was out of range. Must be non-negative and less than {1}..
- ModuleName Looks up a localized string similar to SciLexer.dll.
- ModuleName64 Looks up a localized string similar to SciLexer64.dll.
- ResourceManager Returns the cached ResourceManager instance used by this class.

ScintillaNET.Range

A range within the editor. Start and End are both Positions.

Methods
- CollapseAllFolds Collapses all folds
- ExpandAllFolds Expands all folds
- StripTrailingSpaces Removes trailing spaces from each line

ScintillaNET.RangeToFormat

Struct used for passing parameters to FormatRange()

ScintillaNET.Scintilla

Represents a Scintilla text editor control.

Properties
- AcceptsReturn Gets or sets a value indicating whether pressing ENTER creates a new line of text in the control or activates the default button for the form.
- AcceptsTab Gets or sets a value indicating whether pressing the TAB key types a TAB character in the control instead of moving the focus to the next control in the tab order.
- Annotations Gets a collection containing all annotations in the control.
- AutoComplete Controls autocompletion behavior.
- BackColor Gets or sets the background color for the control.
- BackgroundImage This property is not relevant for this class.
- BackgroundImageLayout This property is not relevant for this class.
- BorderStyle Gets or sets the border style of the control.
- CallTip Manages CallTip (Visual Studio-like code Tooltip) behaviors
- Caption Gets/Sets the Win32 Window Caption. Defaults to Type's FullName
- Caret Controls Caret Behavior
- Clipboard Gets Clipboard access for the control.
- Commands Controls behavior of keyboard bound commands.
- ConfigurationManager Controls behavior of loading/managing ScintillaNET configurations.
- CreateParams Overridden. See System.Windows.Forms.Control.CreateParams .
- CurrentPos Gets or sets the character index of the current caret position.
- DefaultCursor Gets or sets the default cursor for the control.
- DefaultSize Overridden. See System.Windows.Forms.Control.DefaultSize .
- DocumentHandler Controls behavior of Documents
- DocumentNavigation Controls behavior of automatic document navigation
- DropMarkers Controls behavior of Drop Markers
- Encoding Controls Encoding behavior
- EndOfLine Controls End Of Line Behavior
- Font Gets or sets the font of the text displayed by the control.
- ForeColor Gets or sets the foreground color of the control.
- LayoutCacheMode Gets or sets the line layout caching strategy in a ScintillaNET.Scintilla control.
- LineWrapping Gets an object that controls line wrapping options in the ScintillaNET.Scintilla control.
- Markers Gets a collection representing the marker objects and options within the control.
- Modified Gets or sets a value that indicates that the control has been modified by the user since the control was created or its contents were last set.
- PositionCacheSize Gets or sets the position cache size used to layout short runs of text in a ScintillaNET.Scintilla control.
- SupressControlCharacters Gets or sets a value indicating whether characters not considered alphanumeric (ASCII values 0 through 31) are prevented as text input.
- Text Gets or sets the current text in the ScintillaNET.Scintilla control.
- TextLength Gets the _length of text in the control.
- Whitespace Gets the ScintillaNET.Scintilla.Whitespace display mode and style behavior associated with the ScintillaNET.Scintilla control.
- Zoom Gets or sets the current zoom level of the ScintillaNET.Scintilla control.
Methods
- AddLastLineEnd Adds a line end marker to the end of the document
- AppendText(System.String) Appends a copy of the specified string to the _end of this instance.
- CreateAnnotationsInstance Creates and returns a new ScintillaNET.AnnotationCollection object.
- CreateLineWrappingInstance Creates and returns a new ScintillaNET.Scintilla.LineWrapping object.
- DirectMessage(System.Int32,System.IntPtr,System.IntPtr) Sends the specified message directly to the native Scintilla window, bypassing any managed APIs.
- Dispose(System.Boolean) Overridden. Releases the unmanaged resources used by the System.Windows.Forms.Control and its child controls and optionally releases the managed resources.
- ExportHtml Exports a HTML representation of the current document.
- ExportHtml(System.IO.TextWriter,System.String,System.Boolean) Exports a HTML representation of the current document.
- GetCurrentLine Gets the text of the line containing the caret.
- GetCurrentLine(System.Int32@) Gets the text of the line containing the caret and the current caret position within that line.
- GetWordFromPosition(System.Int32) Gets a word from the specified position
- InsertText(System.Int32,System.String) Inserts text at the given position
- InsertText(System.String) Inserts text at the current cursor position
- IsInputKey(System.Windows.Forms.Keys) Overridden. See System.Windows.Forms.Control.IsInputKey(System.Windows.Forms.Keys) .
- OnAnnotationChanged(ScintillaNET.AnnotationChangedEventArgs) Raises the ScintillaNET.Scintilla.AnnotationChanged event.
- OnAutoCompleteAccepted(ScintillaNET.AutoCompleteAcceptedEventArgs) Raises the ScintillaNET.Scintilla.AutoCompleteAccepted event.
- OnBackColorChanged(System.EventArgs) Raises the BackColorChanged event.
- OnBeforeTextDelete(ScintillaNET.TextModifiedEventArgs) Raises the ScintillaNET.Scintilla.BeforeTextDelete event.
- OnBeforeTextInsert(ScintillaNET.TextModifiedEventArgs) Raises the ScintillaNET.Scintilla.BeforeTextInsert event.
- OnBorderStyleChanged(System.EventArgs) Raises the ScintillaNET.Scintilla.BorderStyleChanged event.
- OnCallTipClick(ScintillaNET.CallTipClickEventArgs) Raises the ScintillaNET.Scintilla.CallTipClick event.
- OnCharAdded(ScintillaNET.CharAddedEventArgs) Raises the ScintillaNET.Scintilla.CharAdded event.
- OnCreateControl Overridden. See System.Windows.Forms.Control.OnCreateControl .
- OnDocumentChange(ScintillaNET.NativeScintillaEventArgs) Raises the ScintillaNET.Scintilla.DocumentChange event.
- OnDoubleClick(System.EventArgs) Provides the support for code block selection
- OnDropMarkerCollect(ScintillaNET.DropMarkerCollectEventArgs) Raises the ScintillaNET.Scintilla.DropMarkerCollect event.
- OnDwellEnd(ScintillaNET.ScintillaMouseEventArgs) Raises the ScintillaNET.Scintilla.DwellEnd event.
- OnDwellStart(ScintillaNET.ScintillaMouseEventArgs) Raises the ScintillaNET.Scintilla.DwellStart event.
- OnFoldChanged(ScintillaNET.FoldChangedEventArgs) Raises the ScintillaNET.Scintilla.FoldChanged event.
- OnFontChanged(System.EventArgs) Raises the FontChanged event.
- OnForeColorChanged(System.EventArgs) Raises the ForeColorChanged event.
- OnGotFocus(System.EventArgs) Overridden. See System.Windows.Forms.Control.OnGotFocus(System.EventArgs) .
- OnHandleCreated(System.EventArgs) Overridden. Raises the System.Windows.Forms.Control.HandleCreated event.
- OnHotspotClick(ScintillaNET.HotspotClickEventArgs) Raises the ScintillaNET.Scintilla.HotspotClick event.
- OnHotspotDoubleClick(ScintillaNET.HotspotClickEventArgs) Raises the ScintillaNET.Scintilla.HotspotDoubleClick event.
- OnHotspotReleaseClick(ScintillaNET.HotspotClickEventArgs) Raises the ScintillaNET.Scintilla.HotspotReleaseClick event.
- OnIndicatorClick(ScintillaNET.ScintillaMouseEventArgs) Raises the ScintillaNET.Scintilla.IndicatorClick event.
- OnKeyDown(System.Windows.Forms.KeyEventArgs) Overridden. See System.Windows.Forms.Control.OnKeyDown(System.Windows.Forms.KeyEventArgs) .
- OnKeyPress(System.Windows.Forms.KeyPressEventArgs) Overridden. See System.Windows.Forms.Control.OnKeyPress(System.Windows.Forms.KeyPressEventArgs) .
- OnLinesNeedShown(ScintillaNET.LinesNeedShownEventArgs) Raises the ScintillaNET.Scintilla.LinesNeedShown event.
- OnLoad(System.EventArgs) Raises the ScintillaNET.Scintilla.Load event.
- OnLostFocus(System.EventArgs) Overridden. See System.Windows.Forms.Control.OnLostFocus(System.EventArgs) .
- OnMacroRecord(ScintillaNET.MacroRecordEventArgs) Raises the ScintillaNET.Scintilla.MacroRecord event.
- OnMarginClick(ScintillaNET.MarginClickEventArgs) Raises the ScintillaNET.Scintilla.MarginClick event.
- OnMarkerChanged(ScintillaNET.MarkerChangedEventArgs) Raises the ScintillaNET.Scintilla.MarkerChanged event.
- OnModifiedChanged(System.EventArgs) Raises the ScintillaNET.Scintilla.ModifiedChanged event.
- OnPaint(System.Windows.Forms.PaintEventArgs) Overridden. See System.Windows.Forms.Control.OnPaint(System.Windows.Forms.PaintEventArgs) .
- OnReadOnlyModifyAttempt(System.EventArgs) Raises the ScintillaNET.Scintilla.ReadOnlyModifyAttempt event.
- OnScroll(System.Windows.Forms.ScrollEventArgs) Raises the ScintillaNET.Scintilla.Scroll event.
- OnSelectionChanged(System.EventArgs) Raises the ScintillaNET.Scintilla.SelectionChanged event.
- OnStyleNeeded(ScintillaNET.StyleNeededEventArgs) Raises the ScintillaNET.Scintilla.StyleNeeded event.
- OnTextDeleted(ScintillaNET.TextModifiedEventArgs) Raises the ScintillaNET.Scintilla.TextDeleted event.
- OnTextInserted(ScintillaNET.TextModifiedEventArgs) Raises the ScintillaNET.Scintilla.TextInserted event.
- OnZoomChanged(System.EventArgs) Raises the ScintillaNET.Scintilla.ZoomChanged event.
- PositionIsOnComment(System.Int32) Checks that if the specified position is on comment.
- PositionIsOnComment(System.Int32,ScintillaNET.Lexer) Checks that if the specified position is on comment.
- ProcessKeyMessage(System.Windows.Forms.Message@) Overridden. See System.Windows.Forms.Control.ProcessKeyMessage(System.Windows.Forms.Message@) .
- SafeBraceMatch(System.Int32) Custom way to find the matching brace when BraceMatch() does not work
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32) Handles Scintilla Call Style: (,)
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,ScintillaNET.VOID,System.Int32) Handles Scintilla Call Style: (,int)
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,ScintillaNET.VOID,System.String) Handles Scintilla Call Style: (,string) Notes: This helper method handles all messages that take const char* as an input string in the lParam. In some messages Scintilla expects a NULL terminated string and in others it depends on the string _length passed in as wParam. This method handles both situations and will NULL terminate the string either way.
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.Boolean) Handles Scintilla Call Style: (bool,)
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.Boolean,System.Int32) Handles Scintilla Call Style: (bool,int)
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.Int32) Handles Scintilla Call Style: (int,)
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.Int32,System.Boolean) Handles Scintilla Call Style: (int,bool)
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.Int32,System.Int32) Handles Scintilla Call Style: (int,int)
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.Int32,System.String) Handles Scintilla Call Style: (int,string) Notes: This helper method handles all messages that take const char* as an input string in the lParam. In some messages Scintilla expects a NULL terminated string and in others it depends on the string _length passed in as wParam. This method handles both situations and will NULL terminate the string either way.
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.Int32,System.String@) Handles Scintilla Call Style: (int,stringresult) Notes: Helper method to wrap all calls to messages that take a char* in the lParam and returns a regular .NET String. This overload assumes there will be no wParam and obtains the string _length by calling the message with a 0 lParam.
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.Int32,System.UInt32) Handles Scintilla Call Style: (int,uint)
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.IntPtr,System.IntPtr) This is the primary Native communication method with Scintilla used by this control. All the other overloads call into this one.
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.IntPtr,System.String@,System.Int32) Handles Scintilla Call Style: (?) Notes: Helper method to wrap all calls to messages that take a char* in the wParam and set a regular .NET String in the lParam. Both the _length of the string and an additional wParam are used so that various string Message styles can be acommodated.
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.String) Handles Scintilla Call Style: (string,)
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.String,System.Int32) Handles Scintilla Call Style: (string,int)
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.String,System.String) Handles Scintilla Call Style: (string,string) Notes: Used by SCI_SETPROPERTY
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.String,System.String@) Handles Scintilla Call Style: (string,stringresult) Notes: This one is used specifically by SCIGETPROPERTY and SCIGETPROPERTYEXPANDED so it assumes it's usage
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.String@) Handles Scintilla Call Style: (,stringresult) Notes: Helper method to wrap all calls to messages that take a char* in the lParam and returns a regular .NET String. This overload assumes there will be no wParam and obtains the string _length by calling the message with a 0 lParam.
- SetModuleName(System.String) Sets the application-wide default module name of the native Scintilla library.
- WndProc(System.Windows.Forms.Message@) Overridden. Processes Windows messages.
Events
- AnnotationChanged Occurs when an annotation has changed.
- AutoCompleteAccepted Occurs when the user makes a selection from the auto-complete list.
- BeforeTextDelete Occurs when text is about to be removed from the document.
- BeforeTextInsert Occurs when text is about to be inserted into the document.
- BorderStyleChanged Occurs when the value of the ScintillaNET.Scintilla.BorderStyle property has changed.
- CallTipClick Occurs when a user clicks on a call tip.
- CharAdded Occurs when the user types an ordinary text character (as opposed to a command character) into the text.
- DocumentChange Occurs when the text or styling of the document changes or is about to change.
- DropMarkerCollect Occurs when a ScintillaNET.DropMarker is about to be collected.
- DwellEnd Occurs when a user actions such as a mouse move or key press ends a dwell (hover) activity.
- DwellStart Occurs when the user hovers the mouse (dwells) in one position for the dwell period.
- FoldChanged Occurs when a folding change has occurred.
- HotspotClick Occurs when a user clicks on text that is in a style with the hotspot attribute set.
- HotspotDoubleClick Occurs when a user double-clicks on text that is in a style with the hotspot attribute set.
- HotspotReleaseClick Occurs when a user releases a click on text that is in a style with the hotspot attribute set.
- IndicatorClick Occurs when the a clicks or releases the mouse on text that has an indicator.
- LinesNeedShown Occurs when a range of lines that is currently invisible should be made visible.
- Load Occurs when the control is first loaded.
- MacroRecord Occurs each time a recordable change occurs.
- MarginClick Occurs when the mouse was clicked inside a margin that was marked as sensitive.
- MarkerChanged Occurs when one or more markers has changed in a line of text.
- ReadOnlyModifyAttempt Occurs when a user tries to modify text when in read-only mode.
- Scroll Occurs when the control is scrolled.
- SelectionChanged Occurs when the selection has changed.
- StyleNeeded Occurs when the control is about to display or print text that requires styling.
- TextDeleted Occurs when text has been removed from the document.
- TextInserted Occurs when text has been inserted into the document.
- ZoomChanged Occurs when the user zooms the display using the keyboard or the ScintillaNET.Scintilla.Zoom property is set.

ScintillaNET.Scintilla.LastSelection

Holds the last previous selection's properties, to let us know when we should fire SelectionChanged

ScintillaNET.ScintillaMouseEventArgs

Provides data for Scintilla mouse events

Properties
- Position Returns the Document position
- X Returns the X (left) position of mouse in pixels
- Y Returns the Y (top) position of mouse in pixels
Methods
- #ctor(System.Int32,System.Int32,System.Int32) Initializes a new instance of the ScintillaMouseEventArgs class.

ScintillaNET.SmartIndent

Style of smart indent

ScintillaNET.StyleCase

Represents casing styles

ScintillaNET.StyleChangedEventArgs

Provides data for the StyleChanged event

Properties
- Length Returns how many characters have changed
- Position Returns the starting document position where the style has been changed

ScintillaNET.StyleNeededEventArgs

Provides data for the StyleNeeded event

Properties
- Range Returns the document range that needs styling
Methods
- #ctor(ScintillaNET.Range) Initializes a new instance of the StyleNeededEventArgs class.

ScintillaNET.StyleRun

Defines a run of styled text in a ScintillaNET.Scintilla control

Properties
- Length Gets or sets length of this ScintillaNET.StyleRun .
- Style Gets or sets the style index of this ScintillaNET.StyleRun .
Methods
- #ctor(System.Int32,System.Int32) Initializes a new instance of the ScintillaNET.StyleRun struct.

ScintillaNET.StyleRunWriter

Provides a writer paradigm for building a ScintillaNET.StyleRun list and optionally the text that is being styled.

Methods
- #ctor(System.Text.StringBuilder) Initializes a new instance of the ScintillaNET.StyleRunWriter class.
- GetStringBuilder Returns the underlying System.Text.StringBuilder .
- GetStyles Returns a ScintillaNET.StyleRun enumerable built by the ScintillaNET.StyleRunWriter thus far.
- Write(System.String,System.Int32) Writes a run of the specified string length in the specified style.

ScintillaNET.StylesCommon

Common predefined styles that are always valid with any lexer.

ScintillaNET.TextModifiedEventArgs

Provices data for the TextModified event

Properties
- IsUserChange Returns true if the change was a direct result of user interaction
- Length Returns the length of the change occured.
- LinesAddedCount Returns the # of lines added or removed as a result of the change
- MarkerChangedLine Returns the line # of where the marker change occured (if applicable)
- Position Returns the document position where the change occured
- Text The affected text of the change
Methods
- #ctor(System.Int32,System.Boolean,System.Int32,System.Int32,System.Int32,System.Int32,System.String) Initializes a new instance of the TextModifiedEventArgs class.
- ToString Overridden.

ScintillaNET.TopLevelHelper

Top level ScintillaHelpers Like Style and Folding inherit from this class so they don't have to reimplement the same Equals method

ScintillaNET.UndoRedoFlags

Contains Undo/Redo information, used by many of the events

Methods
- #ctor(System.Int32) Initializes a new instance of the UndoRedoFlags structure.
- ToString Overridden

ScintillaNET.UriDroppedEventArgs

Provides data for the UriDropped event

Properties
- UriText Text of the dropped file or uri
Methods
- #ctor(System.String) Initializes a new instance of the UriDroppedEventArgs class.

ScintillaNET.VOID

Used internally to signify an ignored parameter by overloads of SendMessageDirect that match the native Scintilla's Message signatures.

ScintillaNET.Whitespace

Determines how whitespace should be displayed in a ScintillaNET.Scintilla control.

Properties
- BackColor Gets or sets the whitespace background color.
- ForeColor Gets or sets the whitespace foreground color.
- Mode Gets or sets the whitespace display mode.

ScintillaNET.WhitespaceMode

Specifies the display mode of whitespace characters.

ScintillaNET.XpmConverter

Converts Bitmap images to XPM data for use with ScintillaNET. Warning: images with more than (around) 50 colors will generate incorrect XPM The XpmConverter class was based on code from flashdevelop.

Methods
- ConvertToXPM(System.Drawing.Bitmap) Converts Bitmap images to XPM data for use with ScintillaNET. Warning: images with more than (around) 50 colors will generate incorrect XPM. Uses the DefaultTransparentColor.
- ConvertToXPM(System.Drawing.Bitmap,System.String) Converts Bitmap images to XPM data for use with ScintillaNET. Warning: images with more than (around) 50 colors will generate incorrect XPM tColor: specified transparent color in format: "#00FF00".
- ConvertToXPM(System.Windows.Forms.ImageList) Cicles an image list object to convert contained images into xpm at the same time we add converted images into an arraylist that lets us to retrieve images later. Uses the DefaultTransparentColor.
- ConvertToXPM(System.Windows.Forms.ImageList,System.String) Cicles an image list object to convert contained images into xpm at the same time we add converted images into an arraylist that lets us to retrieve images later

Updated Wiki: ScintillaNET Types

jacobslusser — Tue, 28 Aug 2012 02:31:06 GMT

ScintillaNET Types

The following information is an abbreviated summary of the ScintillaNET types. It has been auto-generated from the project documentation comments.

ScintillaNET.Annotation

Represents a customizable read-only block of text which can be displayed below each line in a ScintillaNET.Scintilla control.

Properties
- LineCount Gets the total number of text lines in the annotation.
- LineIndex Gets the index of the document line containing the annotation.
- Style Gets or sets the index of the style used to style the annotation text.
- Text Gets or sets the text of the annotation.
Methods
- #ctor(ScintillaNET.Scintilla,System.Int32) Initializes a new instance of the class.
- Clear Removes all text and styles associated with the annotation.
- Equals(ScintillaNET.Annotation) Determines whether the specified is equal to the current .
- Equals(System.Object) Overridden. Determines whether the specified is equal to the current .
- GetHashCode Overridden. Serves as a hash function for a particular type.
- GetStyles Returns a enumerable representing the individual character styling of the annotation text.
- op_Equality(ScintillaNET.Annotation,ScintillaNET.Annotation) Tests whether two objects have equal location and content.
- op_Inequality(ScintillaNET.Annotation,ScintillaNET.Annotation) Tests whether two object differ in location or content.
- SetStyles(System.Collections.Generic.IEnumerable{ScintillaNET.StyleRun}) Uses the enumerable specified to individually style characters in the annotation text.

ScintillaNET.AnnotationChangedEventArgs

Provides data for the event.

Properties
- LineCountDelta Gets the number of lines added to or removed from the changed annotation.
- LineIndex Gets the index of the document line containing the changed annotation.
Methods
- #ctor(System.Int32,System.Int32) Initializes a new instance of the class.

ScintillaNET.AnnotationCollection

Represents a collection of ScintillaNET.Annotation objects and options in a ScintillaNET.Scintilla control.

Properties
- Count Gets the number of annotations in the .
- Item(System.Int32) Gets the annotation at the specified line index.
- StyleOffset Gets or sets the offset applied to style indexes used in annotations.
- Visibility Gets or sets the visibility style for all annotations.
Methods
- #ctor(ScintillaNET.Scintilla) Initializes a new instance of the class.
- ClearAll Removes all annotations from the document.
- CreateAnnotationInstance(System.Int32) Creates and returns a new object.
- GetEnumerator Returns an enumerator for the .

ScintillaNET.AnnotationsVisibility

Specifies the visibility and appearance of annotations in a ScintillaNET.Scintilla control.

ScintillaNET.AutoComplete

Used to invoke AutoComplete and UserList windows. Also manages AutoComplete settings.

Properties
- AutoHide 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 AutoHide to false.
- AutomaticLengthEntered Gets or Sets the last automatically calculated LengthEntered used whith .
- CancelAtStart The default behavior is for the list to be cancelled if the caret moves before the location it was at when the list was displayed. By setting this property to false, the list is not cancelled until the caret moves before the first character of the word being completed.
- DropRestOfWord When an item is selected, any word characters following the caret are first erased if dropRestOfWord is set to true.
- FillUpCharacters List of characters (no separated) that causes the AutoComplete window to accept the current selection.
- ImageSeparator 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. For example, "fclose?2 fopen" displays image 2 before the string "fclose" and no image before "fopen".
- IsActive Returns wether or not the AutoComplete window is currently displayed
- IsCaseSensitive Gets or Sets if the comparison of words to the AutoComplete are case sensitive.
- LastStartPosition Gets the document posision when the AutoComplete window was last invoked
- List List if words to display in the AutoComplete window when invoked.
- ListSeparator Character used to split to convert to a List.
- ListString List of words to display in the AutoComplete window.
- MaxHeight 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
- MaxWidth Get or set the maximum width of an autocompletion list expressed as the number of characters in the longest item that will be totally visible.
- SelectedIndex Gets or Sets the index of the currently selected item in the AutoComplete
- SelectedText Gets or Sets the Text of the currently selected AutoComplete item.
- SingleLineAccept If you set this value to true and a list has only one item, it is automatically added and no list is displayed. The default is to display the list even if there is only a single item.
- StopCharacters List of characters (no separator) that causes the AutoComplete window to cancel.
Methods
- Accept Accepts the current AutoComplete window entry
- Cancel Cancels the autocomplete window
- ClearRegisteredImages Deletes all registered images.
- RegisterImage(System.Int32,System.Drawing.Bitmap) Registers an image with index to be displayed in the AutoComplete window.
- RegisterImage(System.Int32,System.Drawing.Bitmap,System.Drawing.Color) Registers an image with index to be displayed in the AutoComplete window.
- RegisterImage(System.Int32,System.String) Registers an image with index to be displayed in the AutoComplete window.
- RegisterImages(System.Collections.Generic.IList{System.Drawing.Bitmap}) Registers a list of images to be displayed in the AutoComplete window.
- RegisterImages(System.Collections.Generic.IList{System.Drawing.Bitmap},System.Drawing.Color) Registers a list of images to be displayed in the AutoComplete window.
- RegisterImages(System.Collections.Generic.IList{System.String}) Registers a list of images to be displayed in the AutoComplete window.
- RegisterImages(System.Windows.Forms.ImageList) Registers a list of images to be displayed in the AutoComplete window.
- RegisterImages(System.Windows.Forms.ImageList,System.Drawing.Color) Registers a list of images to be displayed in the AutoComplete window.
- Show Shows the autocomplete window.
- Show(System.Collections.Generic.IEnumerable{System.String}) Shows the autocomplete window
- Show(System.Int32) Shows the autocomplete window
- Show(System.Int32,System.Collections.Generic.IEnumerable{System.String}) Shows the autocomplete window
- Show(System.Int32,System.String) Shows the autocomplete window.
- Show(System.String) Shows the autocomplete window.
- ShowUserList(System.Int32,System.Collections.Generic.IEnumerable{System.String}) Shows a UserList window
- ShowUserList(System.Int32,System.String) Shows a UserList window

ScintillaNET.AutoCompleteAcceptedEventArgs

Provides data for the AutoCompleteAccepted event

Properties
- Cancel Gets/Sets if the autocomplete action should be cancelled
- Text Text of the selected autocomplete entry selected
- WordStartPosition Returns the _start position of the current word in the document.
Methods
- #ctor(System.String) Initializes a new instance of the AutoCompleteAcceptedEventArgs class.

ScintillaNET.BindableCommand

List of commands that ScintillaNET can execute. These can be bound to keyboard shortcuts

ScintillaNET.CallTip

Used to display CallTips and Manages CallTip settings.

Properties
- BackColor Gets/Sets the background color of all CallTips
- ForeColor Gets/Sets Text color of all CallTips
- HighlightEnd End position of the text to be highlighted in the CalTip
- HighlightStart Start position of the text to be highlighted in the CalTip
- HighlightTextColor Gets/Sets the Text Color of the portion of the CallTip that is highlighted
- IsActive Returns true if a CallTip is currently displayed
- Message The message displayed in the calltip
- OverloadList List of method overloads to display in the calltip
Methods
- Cancel Hides the calltip
- Hide Hides the calltip
- Show Displays a calltip without overloads
- Show(System.Int32) Displays a calltip without overloads
- Show(System.Int32,System.Int32) Displays a calltip without overloads
- Show(System.Int32,System.Int32,System.Int32) Displays a calltip without overloads
- Show(System.String) Displays a calltip without overloads
- Show(System.String,System.Int32) Displays a calltip without overloads
- Show(System.String,System.Int32,System.Int32) Displays a calltip without overloads
- Show(System.String,System.Int32,System.Int32,System.Int32) Displays a calltip without overloads
- ShowOverload Shows the calltip with overloads
- ShowOverload(ScintillaNET.OverloadList) Shows the calltip with overloads
- ShowOverload(ScintillaNET.OverloadList,System.Int32) Shows the calltip with overloads
- ShowOverload(ScintillaNET.OverloadList,System.Int32,System.Int32) Shows the calltip with overloads
- ShowOverload(ScintillaNET.OverloadList,System.Int32,System.Int32,System.Int32) Shows the calltip with overloads
- ShowOverload(ScintillaNET.OverloadList,System.Int32,System.UInt32,System.Int32,System.Int32) Shows the calltip with overloads
- ShowOverload(ScintillaNET.OverloadList,System.UInt32) Shows the calltip with overloads
- ShowOverload(ScintillaNET.OverloadList,System.UInt32,System.Int32,System.Int32) Shows the calltip with overloads
- ShowOverload(System.Int32) Shows the calltip with overloads
- ShowOverload(System.Int32,System.Int32) Shows the calltip with overloads
- ShowOverload(System.Int32,System.Int32,System.Int32) Shows the calltip with overloads
- ShowOverload(System.Int32,System.UInt32) Shows the calltip with overloads
- ShowOverload(System.Int32,System.UInt32,System.Int32,System.Int32) Shows the calltip with overloads
- ShowOverload(System.UInt32) Shows the calltip with overloads
- ShowOverload(System.UInt32,System.Int32,System.Int32) Shows the calltip with overloads

ScintillaNET.CallTipArrow

Represents an arrow in the CallTip

ScintillaNET.CallTipClickEventArgs

Provides data for the CallTipClick event

Properties
- CallTipArrow Returns the CallTipArrow that was clicked
- Cancel Gets/Sets if the CallTip should be hidden
- CurrentIndex Gets the current index of the CallTip's overload list
- HighlightEnd Gets/Sets the _end position of the CallTip's highlighted portion of text
- HighlightStart Gets/Sets the _start position of the CallTip's highlighted portion of text
- NewIndex Gets/Sets the new index of the CallTip's overload list
- OverloadList Returns the OverLoad list of the CallTip
Methods
- #ctor(ScintillaNET.CallTipArrow,System.Int32,System.Int32,ScintillaNET.OverloadList,System.Int32,System.Int32) Initializes a new instance of the CallTipClickEventArgs class.

ScintillaNET.CaretInfo

Manages Caret Settings

Properties
- Anchor Gets/Sets the current anchor position
- BlinkRate Gets/Sets the time interval in milliseconds that the caret should blink.
- Color Gets/Sets the color of the Caret.
- CurrentLineBackgroundAlpha Gets/Sets the transparency alpha of the CurrentLine Background highlight
- CurrentLineBackgroundColor Gets/Sets the color of the document line where the caret currently resides
- HighlightCurrentLine Gets/Sets if the current document line where the caret resides is highlighted.
- IsSticky 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
- LineNumber Gets/Sets the current Line Number that the caret resides.
- Position Gets/Sets the current document position where the caret resides
- Style Gets/Sets the displayed.
- Width Gets/Sets the width in pixels of the Caret
Methods
- BringIntoView Places the caret somewhere within the document that is displayed in the Scintilla Window
- ChooseCaretX 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 method sets the current x position of the caret as the remembered value.
- EnsureVisible Scrolls the Scintilla window so that the Caret is visible.
- Goto(System.Int32) Places the caret at the specified document position

ScintillaNET.CaretStyle

The style of visual indicator that the caret displayes.

ScintillaNET.CharacterSet

The CharacterSet used by the document

ScintillaNET.CharAddedEventArgs

Provides data for the CharAdded event

Properties
- Ch Returns the character that was added
Methods
- #ctor(System.Char) Initializes a new instance of the CharAddedEventArgs class.

ScintillaNET.Clipboard

Provides methods to place data on and retrieve data from the system Clipboard.

Properties
- CanCopy Gets a value indicating whether text (bytes) can be copied given the current selection.
- CanCut Gets a value indicating whether text (bytes) can be cut given the current selection.
- CanPaste Gets a value indicating whether the document can accept text currently stored in the Clipboard.
- ConvertLineBreaksOnPaste Gets or sets whether pasted line break characters are converted to match the document's end-of-line mode.
Methods
- Copy Copies the current selection in the document to the Clipboard.
- Copy(System.Boolean) Copies the current selection, or the current line if there is no selection, to the Clipboard.
- Copy(System.Int32,System.Int32) Copies the specified range of text (bytes) in the document to the Clipboard.
- Cut Moves the current document selection to the Clipboard.
- Paste Replaces the current document selection with the contents of the Clipboard.

ScintillaNET.Commands

Manages commands, which are actions in ScintillaNET that can be bound to key combinations.

Properties
- AllowDuplicateBindings Gets/Sets if a key combination can be bound to more than one command. (default is true)
Methods
- AddBinding(System.Char,ScintillaNET.BindableCommand) Adds a key combination to a Command
- AddBinding(System.Char,System.Windows.Forms.Keys,ScintillaNET.BindableCommand) Adds a key combination to a Command
- AddBinding(System.Windows.Forms.Keys,ScintillaNET.BindableCommand) Adds a key combination to a Command
- AddBinding(System.Windows.Forms.Keys,System.Windows.Forms.Keys,ScintillaNET.BindableCommand) Adds a key combination to a Command
- Execute(ScintillaNET.BindableCommand) Executes a Command
- GetCommands(System.Char) Returns a list of Commands bound to a keyboard shortcut
- GetCommands(System.Char,System.Windows.Forms.Keys) Returns a list of Commands bound to a keyboard shortcut
- GetCommands(System.Windows.Forms.Keys) Returns a list of Commands bound to a keyboard shortcut
- GetCommands(System.Windows.Forms.Keys,System.Windows.Forms.Keys) Returns a list of Commands bound to a keyboard shortcut
- GetKeyBindings(ScintillaNET.BindableCommand) Returns a list of KeyBindings bound to a given command
- RemoveAllBindings Removes all key command bindings
- RemoveBinding(System.Char) Removes all commands bound to a keyboard shortcut
- RemoveBinding(System.Char,ScintillaNET.BindableCommand) Removes a keyboard shortcut / command combination
- RemoveBinding(System.Char,System.Windows.Forms.Keys) Removes all commands bound to a keyboard shortcut
- RemoveBinding(System.Char,System.Windows.Forms.Keys,ScintillaNET.BindableCommand) Removes a keyboard shortcut / command combination
- RemoveBinding(System.Windows.Forms.Keys) Removes all commands bound to a keyboard shortcut
- RemoveBinding(System.Windows.Forms.Keys,ScintillaNET.BindableCommand) Removes a keyboard shortcut / command combination
- RemoveBinding(System.Windows.Forms.Keys,System.Windows.Forms.Keys) Removes all commands bound to a keyboard shortcut
- RemoveBinding(System.Windows.Forms.Keys,System.Windows.Forms.Keys,ScintillaNET.BindableCommand) Removes a keyboard shortcut / command combination

ScintillaNET.Document

Provides an abstraction over Scintilla's Document Pointer

Properties
- Handle Scintilla's internal document pointer.
Methods
- AddRef Increases the document's reference count
- Equals(System.Object) Overridden.
- GetHashCode Overridden
- Release Decreases the document's reference count

ScintillaNET.DocumentHandler

Manages the Native Scintilla's Document features.

Properties
- Current Gets/Sets the currently loaded Document
Methods
- Create Creates a new Document

ScintillaNET.DocumentNavigation

Manages Document Navigation, which is a snapshot history of movements within a document.

Properties
- BackwardStack List of entries that allow you to navigate backwards.
- CanNavigateBackward Returns true if ScintillaNET can perform a successful backward navigation.
- CanNavigateForward Returns true if ScintillaNET can perform a successful forward navigation.
- ForewardStack List of entries that allow you to navigate forwards.
- IsEnabled Gets/Sets whether Document Navigation is tracked. Defaults to true.
- MaxHistorySize Maximum number of places the document navigation remembers. Defaults to 50.
- NavigationPointTimeout Time in milliseconds to wait before a Navigation Point is set. Default is 200
Methods
- NavigateBackward Causes the current position to navigate to the last snapshotted document position.
- NavigateForward After 1 or more backwards navigations this command navigates to the previous backwards navigation point.

ScintillaNET.DropMarker

Represents a DropMarker, currently a single document point.

Properties
- IsPoint Overridden. Drop Markers are points, not a spanned range. Though this could change in the future.
- Key Uniquely identifies the DropMarker
- TopOffset Not currently used, the offset in pixels from the document view's top.
Methods
- Change(System.Int32,System.Int32) Overridden, changes the document position. Start and End should match.
- Collect Collects the DropMarker and causes it to be removed from all lists it belongs ti.
- Dispose Overridden.
- GetClientRectangle Gets the Client Rectangle in pixels of the DropMarker's visual indicator.
- Invalidate Forces a repaint of the DropMarker

ScintillaNET.DropMarkerCollectEventArgs

Provides data for a DropMarkerCollect event

Properties
- DropMarker Returns the DropMarker that was collected
Methods
- #ctor(ScintillaNET.DropMarker) Initializes a new instance of the DropMarkerCollectEventArgs class.

ScintillaNET.DropMarkerList

Data structure used to store DropMarkers in the AllDocumentDropMarkers property.

ScintillaNET.DropMarkers

Manages DropMarkers, a Stack Based document bookmarking system.

Properties
- AllDocumentDropMarkers Gets/Sets a list of All DropMarkers specific to this Scintilla control
- MarkerStack Gets/Sets the Stack of DropMarkers
- SharedStackName Gets/Sets a shared name associated with other Scintilla controls.
Methods
- Collect Collects the last dropped DropMarker
- Drop Drops a DropMarker at the current document position
- Drop(System.Int32) Drops a DropMarker at the specified document position

ScintillaNET.EdgeMode

How long lines are visually indicated

ScintillaNET.EndOfLine

Manages End of line settings for the Scintilla Control

Properties
- EolString Return as a string the characters used to mean _end-of-line. This depends solely on the selected EOL mode.
- IsVisible Gets/Sets if End of line markers are visible in the Scintilla control.
- Mode Gets/Sets the for the document. Default is CrLf.
Methods
- ConvertAllLines(ScintillaNET.EndOfLineMode) Converts all lines in the document to the given mode.

ScintillaNET.EndOfLineMode

Document's EndOfLine Mode

ScintillaNET.FakeStack

Mostly behaves like a stack but internally maintains a List for more flexability

ScintillaNET.FindOption

Controls find behavior for non-regular expression searches

ScintillaNET.FoldChangedEventArgs

Provides data for the FoldChanged event

Properties
- Line Gets/Sets the Line # that the fold change occured on
- NewFoldLevel Gets the new Fold Level of the line
- PreviousFoldLevel Gets the previous Fold Level of the line
Methods
- #ctor(System.Int32,System.Int32,System.Int32,System.Int32) Initializes a new instance of the FoldChangedEventArgs class.

ScintillaNET.FoldFlag

The flags affecting how the fold is marked in the main text area (as well as in the margin). If the value changes for onscreen text, the display will redraw.

ScintillaNET.FoldLevel

The flags that are stored along with the fold level.

ScintillaNET.HotspotClickEventArgs

Provides data for the , , and events.

Properties
- Position Gets the byte offset in the document of the character that was clicked.
Methods
- #ctor(System.Int32) Initializes a new instance of the class.

ScintillaNET.INativeScintilla

ScintillaNET.IndicatorStyle

Style of Indicator to be displayed

ScintillaNET.InformationType

Type of data to display at one of the positions in a Page Information section

ScintillaNET.KeyBinding

Represents the Binding Combination of a Keyboard Key + Modifiers

Properties
- KeyCode Gets/Sets Key to trigger command
- Modifiers Gets sets key modifiers to the Keyboard shortcut
Methods
- #ctor(System.Windows.Forms.Keys,System.Windows.Forms.Keys) Initializes a new instance of the KeyBinding structure.
- Equals(System.Object) Overridden.
- GetHashCode Overridden
- ToString Overridden. Returns string representation of the Keyboard shortcut

ScintillaNET.LayoutCacheMode

Specifies the line layout caching strategy used by a ScintillaNET.Scintilla control.

ScintillaNET.Lexer

Built in lexers supported by Scintilla

ScintillaNET.LinesNeedShownEventArgs

Provides data for the LinesNeedShown event

Properties
- FirstLine Returns the first (top) line that needs to be shown
- LastLine Returns the last (bottom) line that needs to be shown
Methods
- #ctor(System.Int32,System.Int32) Initializes a new instance of the LinesNeedShownEventArgs class.

ScintillaNET.LineWrapping

Controls line wrapping options in a ScintillaNET.Scintilla control.

Properties
- IndentMode Gets or sets how wrapped lines are indented.
- IndentSize Gets or sets the size that wrapped lines are indented when is .
- Mode Gets or sets how and whether line wrapping is performed.
- VisualFlags Gets or sets the visual glyphs displayed on wrapped lines.
- VisualFlagsLocations Gets or sets the location of visual glyphs displayed on wrapped lines.
Methods
- #ctor(ScintillaNET.Scintilla) Initializes a new instance of the class.
- GetWrapCount(System.Int32) The number of lines displayed when a line of text is wrapped.
- WrapLines(System.Int32,System.Int32,System.Int32) Forces the line range specified to wrap at the given pixel width. This operates independently of the current line wrapping property.

ScintillaNET.LineWrappingIndentMode

Specifies how wrapped lines are indented when line wrapping is enabled in a ScintillaNET.Scintilla control.

ScintillaNET.LineWrappingMode

Specifies the line wrapping modes that can be applied to a ScintillaNET.Scintilla control.

ScintillaNET.LineWrappingVisualFlags

Specifies how line wrapping visual glyphs are displayed in a ScintillaNET.Scintilla control.

ScintillaNET.LineWrappingVisualFlagsLocations

Specifies the locations of line wrapping visual glyphs in a ScintillaNET.Scintilla control.

ScintillaNET.MacroRecordEventArgs

Provides data for the MacroRecorded event

Properties
- RecordedMessage Returns the recorded window message that can be sent back to the native Scintilla window
Methods
- #ctor(ScintillaNET.NativeScintillaEventArgs) Initializes a new instance of the MacroRecordEventArgs class.
- #ctor(System.Windows.Forms.Message) Initializes a new instance of the MacroRecordEventArgs class.

ScintillaNET.MarginClickEventArgs

Provides data for the MarginClick event

Properties
- Line Returns the Document line # where the click occured
- Margin Returns the Margin where the click occured
- Modifiers Returns any Modifier keys (shift, alt, ctrl) that were in use at the time the click event occured
- Position Returns the Document position of the line where the click occured
- ToggleFold Gets/Sets whether the fold at the current line should be toggled
- ToggleMarkerNumber Gets/Sets the marker number that should be toggled in result of the click
Methods
- #ctor(System.Windows.Forms.Keys,System.Int32,ScintillaNET.Line,ScintillaNET.Margin,System.Int32,System.Boolean) Initializes a new instance of the MarginClickEventArgs class.

ScintillaNET.Marker

Defines a marker's appearance in a ScintillaNET.Scintilla control.

Properties
- Symbol Gets or sets the marker symbol.

ScintillaNET.MarkerChangedEventArgs

Provides data for the MarkerChanged event

Properties
- Line Returns the line number where the marker change occured
Methods
- #ctor(System.Int32,System.Int32) Initializes a new instance of the LinesNeedShownEventArgs class.

ScintillaNET.MarkerCollection

Represents a collection of ScintillaNET.Marker objects and options in a ScintillaNET.Scintilla control.

ScintillaNET.MarkerSymbol

Specifies the symbol displayed by a ScintillaNET.Marker .

ScintillaNET.ModifiedEventArgs

Base class for modified events

ScintillaNET.NativeScintillaEventArgs

Provides data for native Scintilla Events

Properties
- Msg Notification Message sent from the native Scintilla
- SCNotification SCNotification structure sent from Scintilla that contains the event data
Methods
- #ctor(System.Windows.Forms.Message,ScintillaNET.SCNotification) Initializes a new instance of the NativeScintillaEventArgs class.

ScintillaNET.NavigationPont

Represents a point in the document used for navigation.

Methods
- #ctor(System.Int32,ScintillaNET.Scintilla) Initializes a new instance of the NavigationPont class.
- Dispose Overridden.

ScintillaNET.NotifyHeader

This matches the Win32 NMHDR structure

ScintillaNET.OverloadList

List of strings to be used with ScintillaNET.CallTip .

Properties
- Current Text of the overload to be displayed in the CallTip
- CurrentIndex Index of the overload to be displayed in the CallTip
Methods
- #ctor Creates a new instance of an OverLoadList
- #ctor(System.Collections.Generic.IEnumerable{System.String}) Creates a new instance of an OverLoadList. The list of overloads is supplied by collection
- #ctor(System.Int32) Creates a new instance of an OverLoadList. The

ScintillaNET.PageInformation

Class for determining how and what to print for a header or footer.

Properties
- Border Border style used for the Page Information section
- Center Information printed in the center of the Page Information section
- Display Whether there is a need to display this item, true if left, center, or right are not nothing.
- Font Font used in printing the Page Information section
- Height Height required to draw the Page Information section based on the options selected.
- Left Information printed on the left side of the Page Information section
- Margin Space between the Page Information section and the rest of the page
- Right Information printed on the right side of the Page Information section
Methods
- #ctor Default Constructor
- #ctor(ScintillaNET.PageInformationBorder,ScintillaNET.InformationType,ScintillaNET.InformationType,ScintillaNET.InformationType) Normal Use Constructor
- #ctor(System.Int32,System.Drawing.Font,ScintillaNET.PageInformationBorder,ScintillaNET.InformationType,ScintillaNET.InformationType,ScintillaNET.InformationType) Full Constructor
- Draw(System.Drawing.Graphics,System.Drawing.Rectangle,System.String,System.Int32) Draws the page information section in the specified rectangle

ScintillaNET.PageInformationBorder

Type of border to print for a Page Information section

ScintillaNET.PageSettings

ScintillaNET derived class for handling printed page settings. It holds information on how and what to print in the header and footer of pages.

Properties
- ColorMode Method used to render colored text on a printer
- FontMagnification Number of points to add or subtract to the size of each screen font during printing
- Footer Page Information printed in the footer of the page
- Header Page Information printed in header of the page
Methods
- #ctor Default constructor

ScintillaNET.PrintColorMode

Controls color mode fore printing

ScintillaNET.PrintDocument

ScintillaNET derived class for handling printing of source code from a Scintilla control.

Methods
- #ctor(ScintillaNET.Scintilla) Default Constructor
- OnBeginPrint(System.Drawing.Printing.PrintEventArgs) Method called after the Print method is called and before the first page of the document prints
- OnEndPrint(System.Drawing.Printing.PrintEventArgs) Method called when the last page of the document has printed
- OnPrintPage(System.Drawing.Printing.PrintPageEventArgs) Method called when printing a page

ScintillaNET.PrintRectangle

Struct used for specifying the printing bounds

ScintillaNET.Properties.Resources

A strongly-typed resource class, for looking up localized strings, etc.

Properties
- Culture Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class.
- Exception_CannotCreateDirectFunction Looks up a localized string similar to Cannot create the Scintilla direct message function..
- Exception_CannotLoadModule Looks up a localized string similar to Cannot load the '{0}' module into memory..
- Exception_EmptyStringArgument Looks up a localized string similar to The '{0}' argument cannot be an empty string..
- Exception_EnumeratorEnded Looks up a localized string similar to Enumeration already finished..
- Exception_EnumeratorNotStarted Looks up a localized string similar to Enumeration has not started. Call MoveNext..
- Exception_IllegalCrossThreadCall Looks up a localized string similar to Cross-thread operation not valid: Control '{0}' accessed from a thread other than the thread it was created on..
- Exception_IndexOutOfRange Looks up a localized string similar to Index was out of range. Must be non-negative and less than the size of the collection..
- Exception_InsufficientSpace Looks up a localized string similar to Insufficient space in the target location to copy the information..
- Exception_InvalidAnnotation Looks up a localized string similar to A change in the control who created this annotation has rendered the object invalid..
- Exception_InvalidLine Looks up a localized string similar to The {0} line must specify a valid line within the document..
- Exception_InvalidLineRange Looks up a localized string similar to The start line and end line must specify a valid range..
- Exception_InvalidModule Looks up a localized string similar to '{0}' is not a valid Scintilla module..
- Exception_InvalidStartLine Looks up a localized string similar to The start line must be greater than or equal to zero..
- Exception_ModuleAlreadyLoaded Looks up a localized string similar to The module name must be set before any Scintilla object are created..
- Exception_MustBeNonNegativeAndLessThan Looks up a localized string similar to '{0}' was out of range. Must be non-negative and less than {1}..
- ModuleName Looks up a localized string similar to SciLexer.dll.
- ModuleName64 Looks up a localized string similar to SciLexer64.dll.
- ResourceManager Returns the cached ResourceManager instance used by this class.

ScintillaNET.Range

A range within the editor. Start and End are both Positions.

Methods
- CollapseAllFolds Collapses all folds
- ExpandAllFolds Expands all folds
- StripTrailingSpaces Removes trailing spaces from each line

ScintillaNET.RangeToFormat

Struct used for passing parameters to FormatRange()

ScintillaNET.Scintilla

Represents a Scintilla text editor control.

Properties
- AcceptsReturn Gets or sets a value indicating whether pressing ENTER creates a new line of text in the control or activates the default button for the form.
- AcceptsTab Gets or sets a value indicating whether pressing the TAB key types a TAB character in the control instead of moving the focus to the next control in the tab order.
- Annotations Gets a collection containing all annotations in the control.
- AutoComplete Controls autocompletion behavior.
- BackColor Gets or sets the background color for the control.
- BackgroundImage This property is not relevant for this class.
- BackgroundImageLayout This property is not relevant for this class.
- BorderStyle Gets or sets the border style of the control.
- CallTip Manages CallTip (Visual Studio-like code Tooltip) behaviors
- Caption Gets/Sets the Win32 Window Caption. Defaults to Type's FullName
- Caret Controls Caret Behavior
- Clipboard Gets Clipboard access for the control.
- Commands Controls behavior of keyboard bound commands.
- ConfigurationManager Controls behavior of loading/managing ScintillaNET configurations.
- CreateParams Overridden. See .
- CurrentPos Gets or sets the character index of the current caret position.
- DefaultCursor Gets or sets the default cursor for the control.
- DefaultSize Overridden. See .
- DocumentHandler Controls behavior of Documents
- DocumentNavigation Controls behavior of automatic document navigation
- DropMarkers Controls behavior of Drop Markers
- Encoding Controls Encoding behavior
- EndOfLine Controls End Of Line Behavior
- Font Gets or sets the font of the text displayed by the control.
- ForeColor Gets or sets the foreground color of the control.
- LayoutCacheMode Gets or sets the line layout caching strategy in a control.
- LineWrapping Gets an object that controls line wrapping options in the control.
- Markers Gets a collection representing the marker objects and options within the control.
- Modified Gets or sets a value that indicates that the control has been modified by the user since the control was created or its contents were last set.
- PositionCacheSize Gets or sets the position cache size used to layout short runs of text in a control.
- SupressControlCharacters Gets or sets a value indicating whether characters not considered alphanumeric (ASCII values 0 through 31) are prevented as text input.
- Text Gets or sets the current text in the control.
- TextLength Gets the _length of text in the control.
- Whitespace Gets the display mode and style behavior associated with the control.
- Zoom Gets or sets the current zoom level of the control.
Methods
- AddLastLineEnd Adds a line end marker to the end of the document
- AppendText(System.String) Appends a copy of the specified string to the _end of this instance.
- CreateAnnotationsInstance Creates and returns a new object.
- CreateLineWrappingInstance Creates and returns a new object.
- DirectMessage(System.Int32,System.IntPtr,System.IntPtr) Sends the specified message directly to the native Scintilla window, bypassing any managed APIs.
- Dispose(System.Boolean) Overridden. Releases the unmanaged resources used by the and its child controls and optionally releases the managed resources.
- ExportHtml Exports a HTML representation of the current document.
- ExportHtml(System.IO.TextWriter,System.String,System.Boolean) Exports a HTML representation of the current document.
- GetCurrentLine Gets the text of the line containing the caret.
- GetCurrentLine(System.Int32@) Gets the text of the line containing the caret and the current caret position within that line.
- GetWordFromPosition(System.Int32) Gets a word from the specified position
- InsertText(System.Int32,System.String) Inserts text at the given position
- InsertText(System.String) Inserts text at the current cursor position
- IsInputKey(System.Windows.Forms.Keys) Overridden. See .
- OnAnnotationChanged(ScintillaNET.AnnotationChangedEventArgs) Raises the event.
- OnAutoCompleteAccepted(ScintillaNET.AutoCompleteAcceptedEventArgs) Raises the event.
- OnBackColorChanged(System.EventArgs) Raises the event.
- OnBeforeTextDelete(ScintillaNET.TextModifiedEventArgs) Raises the event.
- OnBeforeTextInsert(ScintillaNET.TextModifiedEventArgs) Raises the event.
- OnBorderStyleChanged(System.EventArgs) Raises the event.
- OnCallTipClick(ScintillaNET.CallTipClickEventArgs) Raises the event.
- OnCharAdded(ScintillaNET.CharAddedEventArgs) Raises the event.
- OnCreateControl Overridden. See .
- OnDocumentChange(ScintillaNET.NativeScintillaEventArgs) Raises the event.
- OnDoubleClick(System.EventArgs) Provides the support for code block selection
- OnDropMarkerCollect(ScintillaNET.DropMarkerCollectEventArgs) Raises the event.
- OnDwellEnd(ScintillaNET.ScintillaMouseEventArgs) Raises the event.
- OnDwellStart(ScintillaNET.ScintillaMouseEventArgs) Raises the event.
- OnFoldChanged(ScintillaNET.FoldChangedEventArgs) Raises the event.
- OnFontChanged(System.EventArgs) Raises the event.
- OnForeColorChanged(System.EventArgs) Raises the event.
- OnGotFocus(System.EventArgs) Overridden. See .
- OnHandleCreated(System.EventArgs) Overridden. Raises the event.
- OnHotspotClick(ScintillaNET.HotspotClickEventArgs) Raises the event.
- OnHotspotDoubleClick(ScintillaNET.HotspotClickEventArgs) Raises the event.
- OnHotspotReleaseClick(ScintillaNET.HotspotClickEventArgs) Raises the event.
- OnIndicatorClick(ScintillaNET.ScintillaMouseEventArgs) Raises the event.
- OnKeyDown(System.Windows.Forms.KeyEventArgs) Overridden. See .
- OnKeyPress(System.Windows.Forms.KeyPressEventArgs) Overridden. See .
- OnLinesNeedShown(ScintillaNET.LinesNeedShownEventArgs) Raises the event.
- OnLoad(System.EventArgs) Raises the event.
- OnLostFocus(System.EventArgs) Overridden. See .
- OnMacroRecord(ScintillaNET.MacroRecordEventArgs) Raises the event.
- OnMarginClick(ScintillaNET.MarginClickEventArgs) Raises the event.
- OnMarkerChanged(ScintillaNET.MarkerChangedEventArgs) Raises the event.
- OnModifiedChanged(System.EventArgs) Raises the event.
- OnPaint(System.Windows.Forms.PaintEventArgs) Overridden. See .
- OnReadOnlyModifyAttempt(System.EventArgs) Raises the event.
- OnScroll(System.Windows.Forms.ScrollEventArgs) Raises the event.
- OnSelectionChanged(System.EventArgs) Raises the event.
- OnStyleNeeded(ScintillaNET.StyleNeededEventArgs) Raises the event.
- OnTextDeleted(ScintillaNET.TextModifiedEventArgs) Raises the event.
- OnTextInserted(ScintillaNET.TextModifiedEventArgs) Raises the event.
- OnZoomChanged(System.EventArgs) Raises the event.
- PositionIsOnComment(System.Int32) Checks that if the specified position is on comment.
- PositionIsOnComment(System.Int32,ScintillaNET.Lexer) Checks that if the specified position is on comment.
- ProcessKeyMessage(System.Windows.Forms.Message@) Overridden. See .
- SafeBraceMatch(System.Int32) Custom way to find the matching brace when BraceMatch() does not work
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32) Handles Scintilla Call Style: (,)
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,ScintillaNET.VOID,System.Int32) Handles Scintilla Call Style: (,int)
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,ScintillaNET.VOID,System.String) Handles Scintilla Call Style: (,string) Notes: This helper method handles all messages that take const char* as an input string in the lParam. In some messages Scintilla expects a NULL terminated string and in others it depends on the string _length passed in as wParam. This method handles both situations and will NULL terminate the string either way.
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.Boolean) Handles Scintilla Call Style: (bool,)
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.Boolean,System.Int32) Handles Scintilla Call Style: (bool,int)
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.Int32) Handles Scintilla Call Style: (int,)
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.Int32,System.Boolean) Handles Scintilla Call Style: (int,bool)
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.Int32,System.Int32) Handles Scintilla Call Style: (int,int)
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.Int32,System.String) Handles Scintilla Call Style: (int,string) Notes: This helper method handles all messages that take const char* as an input string in the lParam. In some messages Scintilla expects a NULL terminated string and in others it depends on the string _length passed in as wParam. This method handles both situations and will NULL terminate the string either way.
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.Int32,System.String@) Handles Scintilla Call Style: (int,stringresult) Notes: Helper method to wrap all calls to messages that take a char* in the lParam and returns a regular .NET String. This overload assumes there will be no wParam and obtains the string _length by calling the message with a 0 lParam.
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.Int32,System.UInt32) Handles Scintilla Call Style: (int,uint)
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.IntPtr,System.IntPtr) This is the primary Native communication method with Scintilla used by this control. All the other overloads call into this one.
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.IntPtr,System.String@,System.Int32) Handles Scintilla Call Style: (?) Notes: Helper method to wrap all calls to messages that take a char* in the wParam and set a regular .NET String in the lParam. Both the _length of the string and an additional wParam are used so that various string Message styles can be acommodated.
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.String) Handles Scintilla Call Style: (string,)
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.String,System.Int32) Handles Scintilla Call Style: (string,int)
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.String,System.String) Handles Scintilla Call Style: (string,string) Notes: Used by SCI_SETPROPERTY
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.String,System.String@) Handles Scintilla Call Style: (string,stringresult) Notes: This one is used specifically by SCIGETPROPERTY and SCIGETPROPERTYEXPANDED so it assumes it's usage
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.String@) Handles Scintilla Call Style: (,stringresult) Notes: Helper method to wrap all calls to messages that take a char* in the lParam and returns a regular .NET String. This overload assumes there will be no wParam and obtains the string _length by calling the message with a 0 lParam.
- SetModuleName(System.String) Sets the application-wide default module name of the native Scintilla library.
- WndProc(System.Windows.Forms.Message@) Overridden. Processes Windows messages.
Events
- AnnotationChanged Occurs when an annotation has changed.
- AutoCompleteAccepted Occurs when the user makes a selection from the auto-complete list.
- BeforeTextDelete Occurs when text is about to be removed from the document.
- BeforeTextInsert Occurs when text is about to be inserted into the document.
- BorderStyleChanged Occurs when the value of the property has changed.
- CallTipClick Occurs when a user clicks on a call tip.
- CharAdded Occurs when the user types an ordinary text character (as opposed to a command character) into the text.
- DocumentChange Occurs when the text or styling of the document changes or is about to change.
- DropMarkerCollect Occurs when a is about to be collected.
- DwellEnd Occurs when a user actions such as a mouse move or key press ends a dwell (hover) activity.
- DwellStart Occurs when the user hovers the mouse (dwells) in one position for the dwell period.
- FoldChanged Occurs when a folding change has occurred.
- HotspotClick Occurs when a user clicks on text that is in a style with the hotspot attribute set.
- HotspotDoubleClick Occurs when a user double-clicks on text that is in a style with the hotspot attribute set.
- HotspotReleaseClick Occurs when a user releases a click on text that is in a style with the hotspot attribute set.
- IndicatorClick Occurs when the a clicks or releases the mouse on text that has an indicator.
- LinesNeedShown Occurs when a range of lines that is currently invisible should be made visible.
- Load Occurs when the control is first loaded.
- MacroRecord Occurs each time a recordable change occurs.
- MarginClick Occurs when the mouse was clicked inside a margin that was marked as sensitive.
- MarkerChanged Occurs when one or more markers has changed in a line of text.
- ReadOnlyModifyAttempt Occurs when a user tries to modify text when in read-only mode.
- Scroll Occurs when the control is scrolled.
- SelectionChanged Occurs when the selection has changed.
- StyleNeeded Occurs when the control is about to display or print text that requires styling.
- TextDeleted Occurs when text has been removed from the document.
- TextInserted Occurs when text has been inserted into the document.
- ZoomChanged Occurs when the user zooms the display using the keyboard or the property is set.

ScintillaNET.Scintilla.LastSelection

Holds the last previous selection's properties, to let us know when we should fire SelectionChanged

ScintillaNET.ScintillaMouseEventArgs

Provides data for Scintilla mouse events

Properties
- Position Returns the Document position
- X Returns the X (left) position of mouse in pixels
- Y Returns the Y (top) position of mouse in pixels
Methods
- #ctor(System.Int32,System.Int32,System.Int32) Initializes a new instance of the ScintillaMouseEventArgs class.

ScintillaNET.SmartIndent

Style of smart indent

ScintillaNET.StyleCase

Represents casing styles

ScintillaNET.StyleChangedEventArgs

Provides data for the StyleChanged event

Properties
- Length Returns how many characters have changed
- Position Returns the starting document position where the style has been changed

ScintillaNET.StyleNeededEventArgs

Provides data for the StyleNeeded event

Properties
- Range Returns the document range that needs styling
Methods
- #ctor(ScintillaNET.Range) Initializes a new instance of the StyleNeededEventArgs class.

ScintillaNET.StyleRun

Defines a run of styled text in a ScintillaNET.Scintilla control

Properties
- Length Gets or sets length of this .
- Style Gets or sets the style index of this .
Methods
- #ctor(System.Int32,System.Int32) Initializes a new instance of the struct.

ScintillaNET.StyleRunWriter

Provides a writer paradigm for building a ScintillaNET.StyleRun list and optionally the text that is being styled.

Methods
- #ctor(System.Text.StringBuilder) Initializes a new instance of the class.
- GetStringBuilder Returns the underlying .
- GetStyles Returns a enumerable built by the thus far.
- Write(System.String,System.Int32) Writes a run of the specified string length in the specified style.

ScintillaNET.StylesCommon

Common predefined styles that are always valid with any lexer.

ScintillaNET.TextModifiedEventArgs

Provices data for the TextModified event

Properties
- IsUserChange Returns true if the change was a direct result of user interaction
- Length Returns the length of the change occured.
- LinesAddedCount Returns the # of lines added or removed as a result of the change
- MarkerChangedLine Returns the line # of where the marker change occured (if applicable)
- Position Returns the document position where the change occured
- Text The affected text of the change
Methods
- #ctor(System.Int32,System.Boolean,System.Int32,System.Int32,System.Int32,System.Int32,System.String) Initializes a new instance of the TextModifiedEventArgs class.
- ToString Overridden.

ScintillaNET.TopLevelHelper

Top level ScintillaHelpers Like Style and Folding inherit from this class so they don't have to reimplement the same Equals method

ScintillaNET.UndoRedoFlags

Contains Undo/Redo information, used by many of the events

Methods
- #ctor(System.Int32) Initializes a new instance of the UndoRedoFlags structure.
- ToString Overridden

ScintillaNET.UriDroppedEventArgs

Provides data for the UriDropped event

Properties
- UriText Text of the dropped file or uri
Methods
- #ctor(System.String) Initializes a new instance of the UriDroppedEventArgs class.

ScintillaNET.VOID

Used internally to signify an ignored parameter by overloads of SendMessageDirect that match the native Scintilla's Message signatures.

ScintillaNET.Whitespace

Determines how whitespace should be displayed in a ScintillaNET.Scintilla control.

Properties
- BackColor Gets or sets the whitespace background color.
- ForeColor Gets or sets the whitespace foreground color.
- Mode Gets or sets the whitespace display mode.

ScintillaNET.WhitespaceMode

Specifies the display mode of whitespace characters.

ScintillaNET.XpmConverter

Converts Bitmap images to XPM data for use with ScintillaNET. Warning: images with more than (around) 50 colors will generate incorrect XPM The XpmConverter class was based on code from flashdevelop.

Methods
- ConvertToXPM(System.Drawing.Bitmap) Converts Bitmap images to XPM data for use with ScintillaNET. Warning: images with more than (around) 50 colors will generate incorrect XPM. Uses the DefaultTransparentColor.
- ConvertToXPM(System.Drawing.Bitmap,System.String) Converts Bitmap images to XPM data for use with ScintillaNET. Warning: images with more than (around) 50 colors will generate incorrect XPM tColor: specified transparent color in format: "#00FF00".
- ConvertToXPM(System.Windows.Forms.ImageList) Cicles an image list object to convert contained images into xpm at the same time we add converted images into an arraylist that lets us to retrieve images later. Uses the DefaultTransparentColor.
- ConvertToXPM(System.Windows.Forms.ImageList,System.String) Cicles an image list object to convert contained images into xpm at the same time we add converted images into an arraylist that lets us to retrieve images later

Updated Wiki: Documentation

jacobslusser — Tue, 28 Aug 2012 01:08:52 GMT

ScintillaNET Documentation

Welcome to the ScintillaNET Documentation Wiki. Here you will find information about using ScintillaNET in your project. If you don't see the information you're looking for, please review the Frequently Asked Questions before posting a topic in the Discussions Forum.

Getting Started
Examples
Advanced Features
Documentation
Developers Guide
Help

Getting Started

Everything you need to know to download ScintillaNET, configure it in your development environment, and begin using it in your project.

Examples

The following examples are just the tip of the iceburg. More examples will be coming soon.

Advanced Features

Coming Soon

Documentation

ScintillaNET Types

Scintilla is really the heart of ScintillaNET. 99% of all the text editing functionality is baked into the Scintilla editing component. ScintillaNET provides a friendly interface, which is exactly how the Windows Forms library works. If you truly want to learn how to use ScintillaNET you have to learn Scintilla.

Developers Guide

Getting the Source Code
Creating a Patch

Help

Updated Wiki: ScintillaNET Types

jacobslusser — Tue, 28 Aug 2012 01:05:36 GMT

ScintillaNET Types

The following information is an abbreviated summary of the ScintillaNET types. It has been auto-generated from the project documentation comments.

ScintillaNET.Annotation

Represents a customizable read-only block of text which can be displayed below each line in a control.

Properties
- LineCount Gets the total number of text lines in the annotation.
- LineIndex Gets the index of the document line containing the annotation.
- Style Gets or sets the index of the style used to style the annotation text.
- Text Gets or sets the text of the annotation.
Methods
- #ctor(ScintillaNET.Scintilla,System.Int32) Initializes a new instance of the class.
- Clear Removes all text and styles associated with the annotation.
- Equals(ScintillaNET.Annotation) Determines whether the specified is equal to the current .
- Equals(System.Object) Overridden. Determines whether the specified is equal to the current .
- GetHashCode Overridden. Serves as a hash function for a particular type.
- GetStyles Returns a enumerable representing the individual character styling of the annotation text.
- op_Equality(ScintillaNET.Annotation,ScintillaNET.Annotation) Tests whether two objects have equal location and content.
- op_Inequality(ScintillaNET.Annotation,ScintillaNET.Annotation) Tests whether two object differ in location or content.
- SetStyles(System.Collections.Generic.IEnumerable{ScintillaNET.StyleRun}) Uses the enumerable specified to individually style characters in the annotation text.

ScintillaNET.AnnotationChangedEventArgs

Provides data for the event.

Properties
- LineCountDelta Gets the number of lines added to or removed from the changed annotation.
- LineIndex Gets the index of the document line containing the changed annotation.
Methods
- #ctor(System.Int32,System.Int32) Initializes a new instance of the class.

ScintillaNET.AnnotationCollection

Represents a collection of objects and options in a control.

Properties
- Count Gets the number of annotations in the .
- Item(System.Int32) Gets the annotation at the specified line index.
- StyleOffset Gets or sets the offset applied to style indexes used in annotations.
- Visibility Gets or sets the visibility style for all annotations.
Methods
- #ctor(ScintillaNET.Scintilla) Initializes a new instance of the class.
- ClearAll Removes all annotations from the document.
- CreateAnnotationInstance(System.Int32) Creates and returns a new object.
- GetEnumerator Returns an enumerator for the .

ScintillaNET.AnnotationsVisibility

Specifies the visibility and appearance of annotations in a control.

ScintillaNET.AutoComplete

Used to invoke AutoComplete and UserList windows. Also manages AutoComplete settings.

Properties
- AutoHide 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 AutoHide to false.
- AutomaticLengthEntered Gets or Sets the last automatically calculated LengthEntered used whith .
- CancelAtStart The default behavior is for the list to be cancelled if the caret moves before the location it was at when the list was displayed. By setting this property to false, the list is not cancelled until the caret moves before the first character of the word being completed.
- DropRestOfWord When an item is selected, any word characters following the caret are first erased if dropRestOfWord is set to true.
- FillUpCharacters List of characters (no separated) that causes the AutoComplete window to accept the current selection.
- ImageSeparator 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. For example, "fclose?2 fopen" displays image 2 before the string "fclose" and no image before "fopen".
- IsActive Returns wether or not the AutoComplete window is currently displayed
- IsCaseSensitive Gets or Sets if the comparison of words to the AutoComplete are case sensitive.
- LastStartPosition Gets the document posision when the AutoComplete window was last invoked
- List List if words to display in the AutoComplete window when invoked.
- ListSeparator Character used to split to convert to a List.
- ListString List of words to display in the AutoComplete window.
- MaxHeight 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
- MaxWidth Get or set the maximum width of an autocompletion list expressed as the number of characters in the longest item that will be totally visible.
- SelectedIndex Gets or Sets the index of the currently selected item in the AutoComplete
- SelectedText Gets or Sets the Text of the currently selected AutoComplete item.
- SingleLineAccept If you set this value to true and a list has only one item, it is automatically added and no list is displayed. The default is to display the list even if there is only a single item.
- StopCharacters List of characters (no separator) that causes the AutoComplete window to cancel.
Methods
- Accept Accepts the current AutoComplete window entry
- Cancel Cancels the autocomplete window
- ClearRegisteredImages Deletes all registered images.
- RegisterImage(System.Int32,System.Drawing.Bitmap) Registers an image with index to be displayed in the AutoComplete window.
- RegisterImage(System.Int32,System.Drawing.Bitmap,System.Drawing.Color) Registers an image with index to be displayed in the AutoComplete window.
- RegisterImage(System.Int32,System.String) Registers an image with index to be displayed in the AutoComplete window.
- RegisterImages(System.Collections.Generic.IList{System.Drawing.Bitmap}) Registers a list of images to be displayed in the AutoComplete window.
- RegisterImages(System.Collections.Generic.IList{System.Drawing.Bitmap},System.Drawing.Color) Registers a list of images to be displayed in the AutoComplete window.
- RegisterImages(System.Collections.Generic.IList{System.String}) Registers a list of images to be displayed in the AutoComplete window.
- RegisterImages(System.Windows.Forms.ImageList) Registers a list of images to be displayed in the AutoComplete window.
- RegisterImages(System.Windows.Forms.ImageList,System.Drawing.Color) Registers a list of images to be displayed in the AutoComplete window.
- Show Shows the autocomplete window.
- Show(System.Collections.Generic.IEnumerable{System.String}) Shows the autocomplete window
- Show(System.Int32) Shows the autocomplete window
- Show(System.Int32,System.Collections.Generic.IEnumerable{System.String}) Shows the autocomplete window
- Show(System.Int32,System.String) Shows the autocomplete window.
- Show(System.String) Shows the autocomplete window.
- ShowUserList(System.Int32,System.Collections.Generic.IEnumerable{System.String}) Shows a UserList window
- ShowUserList(System.Int32,System.String) Shows a UserList window

ScintillaNET.AutoCompleteAcceptedEventArgs

Provides data for the AutoCompleteAccepted event

Properties
- Cancel Gets/Sets if the autocomplete action should be cancelled
- Text Text of the selected autocomplete entry selected
- WordStartPosition Returns the _start position of the current word in the document.
Methods
- #ctor(System.String) Initializes a new instance of the AutoCompleteAcceptedEventArgs class.

ScintillaNET.BindableCommand

List of commands that ScintillaNET can execute. These can be bound to keyboard shortcuts

ScintillaNET.CallTip

Used to display CallTips and Manages CallTip settings.

Properties
- BackColor Gets/Sets the background color of all CallTips
- ForeColor Gets/Sets Text color of all CallTips
- HighlightEnd End position of the text to be highlighted in the CalTip
- HighlightStart Start position of the text to be highlighted in the CalTip
- HighlightTextColor Gets/Sets the Text Color of the portion of the CallTip that is highlighted
- IsActive Returns true if a CallTip is currently displayed
- Message The message displayed in the calltip
- OverloadList List of method overloads to display in the calltip
Methods
- Cancel Hides the calltip
- Hide Hides the calltip
- Show Displays a calltip without overloads
- Show(System.Int32) Displays a calltip without overloads
- Show(System.Int32,System.Int32) Displays a calltip without overloads
- Show(System.Int32,System.Int32,System.Int32) Displays a calltip without overloads
- Show(System.String) Displays a calltip without overloads
- Show(System.String,System.Int32) Displays a calltip without overloads
- Show(System.String,System.Int32,System.Int32) Displays a calltip without overloads
- Show(System.String,System.Int32,System.Int32,System.Int32) Displays a calltip without overloads
- ShowOverload Shows the calltip with overloads
- ShowOverload(ScintillaNET.OverloadList) Shows the calltip with overloads
- ShowOverload(ScintillaNET.OverloadList,System.Int32) Shows the calltip with overloads
- ShowOverload(ScintillaNET.OverloadList,System.Int32,System.Int32) Shows the calltip with overloads
- ShowOverload(ScintillaNET.OverloadList,System.Int32,System.Int32,System.Int32) Shows the calltip with overloads
- ShowOverload(ScintillaNET.OverloadList,System.Int32,System.UInt32,System.Int32,System.Int32) Shows the calltip with overloads
- ShowOverload(ScintillaNET.OverloadList,System.UInt32) Shows the calltip with overloads
- ShowOverload(ScintillaNET.OverloadList,System.UInt32,System.Int32,System.Int32) Shows the calltip with overloads
- ShowOverload(System.Int32) Shows the calltip with overloads
- ShowOverload(System.Int32,System.Int32) Shows the calltip with overloads
- ShowOverload(System.Int32,System.Int32,System.Int32) Shows the calltip with overloads
- ShowOverload(System.Int32,System.UInt32) Shows the calltip with overloads
- ShowOverload(System.Int32,System.UInt32,System.Int32,System.Int32) Shows the calltip with overloads
- ShowOverload(System.UInt32) Shows the calltip with overloads
- ShowOverload(System.UInt32,System.Int32,System.Int32) Shows the calltip with overloads

ScintillaNET.CallTipArrow

Represents an arrow in the CallTip

ScintillaNET.CallTipClickEventArgs

Provides data for the CallTipClick event

Properties
- CallTipArrow Returns the CallTipArrow that was clicked
- Cancel Gets/Sets if the CallTip should be hidden
- CurrentIndex Gets the current index of the CallTip's overload list
- HighlightEnd Gets/Sets the _end position of the CallTip's highlighted portion of text
- HighlightStart Gets/Sets the _start position of the CallTip's highlighted portion of text
- NewIndex Gets/Sets the new index of the CallTip's overload list
- OverloadList Returns the OverLoad list of the CallTip
Methods
- #ctor(ScintillaNET.CallTipArrow,System.Int32,System.Int32,ScintillaNET.OverloadList,System.Int32,System.Int32) Initializes a new instance of the CallTipClickEventArgs class.

ScintillaNET.CaretInfo

Manages Caret Settings

Properties
- Anchor Gets/Sets the current anchor position
- BlinkRate Gets/Sets the time interval in milliseconds that the caret should blink.
- Color Gets/Sets the color of the Caret.
- CurrentLineBackgroundAlpha Gets/Sets the transparency alpha of the CurrentLine Background highlight
- CurrentLineBackgroundColor Gets/Sets the color of the document line where the caret currently resides
- HighlightCurrentLine Gets/Sets if the current document line where the caret resides is highlighted.
- IsSticky 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
- LineNumber Gets/Sets the current Line Number that the caret resides.
- Position Gets/Sets the current document position where the caret resides
- Style Gets/Sets the displayed.
- Width Gets/Sets the width in pixels of the Caret
Methods
- BringIntoView Places the caret somewhere within the document that is displayed in the Scintilla Window
- ChooseCaretX 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 method sets the current x position of the caret as the remembered value.
- EnsureVisible Scrolls the Scintilla window so that the Caret is visible.
- Goto(System.Int32) Places the caret at the specified document position

ScintillaNET.CaretStyle

The style of visual indicator that the caret displayes.

ScintillaNET.CharacterSet

The CharacterSet used by the document

ScintillaNET.CharAddedEventArgs

Provides data for the CharAdded event

Properties
- Ch Returns the character that was added
Methods
- #ctor(System.Char) Initializes a new instance of the CharAddedEventArgs class.

ScintillaNET.Clipboard

Provides methods to place data on and retrieve data from the system Clipboard.

Properties
- CanCopy Gets a value indicating whether text (bytes) can be copied given the current selection.
- CanCut Gets a value indicating whether text (bytes) can be cut given the current selection.
- CanPaste Gets a value indicating whether the document can accept text currently stored in the Clipboard.
- ConvertLineBreaksOnPaste Gets or sets whether pasted line break characters are converted to match the document's end-of-line mode.
Methods
- Copy Copies the current selection in the document to the Clipboard.
- Copy(System.Boolean) Copies the current selection, or the current line if there is no selection, to the Clipboard.
- Copy(System.Int32,System.Int32) Copies the specified range of text (bytes) in the document to the Clipboard.
- Cut Moves the current document selection to the Clipboard.
- Paste Replaces the current document selection with the contents of the Clipboard.

ScintillaNET.Commands

Manages commands, which are actions in ScintillaNET that can be bound to key combinations.

Properties
- AllowDuplicateBindings Gets/Sets if a key combination can be bound to more than one command. (default is true)
Methods
- AddBinding(System.Char,ScintillaNET.BindableCommand) Adds a key combination to a Command
- AddBinding(System.Char,System.Windows.Forms.Keys,ScintillaNET.BindableCommand) Adds a key combination to a Command
- AddBinding(System.Windows.Forms.Keys,ScintillaNET.BindableCommand) Adds a key combination to a Command
- AddBinding(System.Windows.Forms.Keys,System.Windows.Forms.Keys,ScintillaNET.BindableCommand) Adds a key combination to a Command
- Execute(ScintillaNET.BindableCommand) Executes a Command
- GetCommands(System.Char) Returns a list of Commands bound to a keyboard shortcut
- GetCommands(System.Char,System.Windows.Forms.Keys) Returns a list of Commands bound to a keyboard shortcut
- GetCommands(System.Windows.Forms.Keys) Returns a list of Commands bound to a keyboard shortcut
- GetCommands(System.Windows.Forms.Keys,System.Windows.Forms.Keys) Returns a list of Commands bound to a keyboard shortcut
- GetKeyBindings(ScintillaNET.BindableCommand) Returns a list of KeyBindings bound to a given command
- RemoveAllBindings Removes all key command bindings
- RemoveBinding(System.Char) Removes all commands bound to a keyboard shortcut
- RemoveBinding(System.Char,ScintillaNET.BindableCommand) Removes a keyboard shortcut / command combination
- RemoveBinding(System.Char,System.Windows.Forms.Keys) Removes all commands bound to a keyboard shortcut
- RemoveBinding(System.Char,System.Windows.Forms.Keys,ScintillaNET.BindableCommand) Removes a keyboard shortcut / command combination
- RemoveBinding(System.Windows.Forms.Keys) Removes all commands bound to a keyboard shortcut
- RemoveBinding(System.Windows.Forms.Keys,ScintillaNET.BindableCommand) Removes a keyboard shortcut / command combination
- RemoveBinding(System.Windows.Forms.Keys,System.Windows.Forms.Keys) Removes all commands bound to a keyboard shortcut
- RemoveBinding(System.Windows.Forms.Keys,System.Windows.Forms.Keys,ScintillaNET.BindableCommand) Removes a keyboard shortcut / command combination

ScintillaNET.Document

Provides an abstraction over Scintilla's Document Pointer

Properties
- Handle Scintilla's internal document pointer.
Methods
- AddRef Increases the document's reference count
- Equals(System.Object) Overridden.
- GetHashCode Overridden
- Release Decreases the document's reference count

ScintillaNET.DocumentHandler

Manages the Native Scintilla's Document features.

Properties
- Current Gets/Sets the currently loaded Document
Methods
- Create Creates a new Document

ScintillaNET.DocumentNavigation

Manages Document Navigation, which is a snapshot history of movements within a document.

Properties
- BackwardStack List of entries that allow you to navigate backwards.
- CanNavigateBackward Returns true if ScintillaNET can perform a successful backward navigation.
- CanNavigateForward Returns true if ScintillaNET can perform a successful forward navigation.
- ForewardStack List of entries that allow you to navigate forwards.
- IsEnabled Gets/Sets whether Document Navigation is tracked. Defaults to true.
- MaxHistorySize Maximum number of places the document navigation remembers. Defaults to 50.
- NavigationPointTimeout Time in milliseconds to wait before a Navigation Point is set. Default is 200
Methods
- NavigateBackward Causes the current position to navigate to the last snapshotted document position.
- NavigateForward After 1 or more backwards navigations this command navigates to the previous backwards navigation point.

ScintillaNET.DropMarker

Represents a DropMarker, currently a single document point.

Properties
- IsPoint Overridden. Drop Markers are points, not a spanned range. Though this could change in the future.
- Key Uniquely identifies the DropMarker
- TopOffset Not currently used, the offset in pixels from the document view's top.
Methods
- Change(System.Int32,System.Int32) Overridden, changes the document position. Start and End should match.
- Collect Collects the DropMarker and causes it to be removed from all lists it belongs ti.
- Dispose Overridden.
- GetClientRectangle Gets the Client Rectangle in pixels of the DropMarker's visual indicator.
- Invalidate Forces a repaint of the DropMarker

ScintillaNET.DropMarkerCollectEventArgs

Provides data for a DropMarkerCollect event

Properties
- DropMarker Returns the DropMarker that was collected
Methods
- #ctor(ScintillaNET.DropMarker) Initializes a new instance of the DropMarkerCollectEventArgs class.

ScintillaNET.DropMarkerList

Data structure used to store DropMarkers in the AllDocumentDropMarkers property.

ScintillaNET.DropMarkers

Manages DropMarkers, a Stack Based document bookmarking system.

Properties
- AllDocumentDropMarkers Gets/Sets a list of All DropMarkers specific to this Scintilla control
- MarkerStack Gets/Sets the Stack of DropMarkers
- SharedStackName Gets/Sets a shared name associated with other Scintilla controls.
Methods
- Collect Collects the last dropped DropMarker
- Drop Drops a DropMarker at the current document position
- Drop(System.Int32) Drops a DropMarker at the specified document position

ScintillaNET.EdgeMode

How long lines are visually indicated

ScintillaNET.EndOfLine

Manages End of line settings for the Scintilla Control

Properties
- EolString Return as a string the characters used to mean _end-of-line. This depends solely on the selected EOL mode.
- IsVisible Gets/Sets if End of line markers are visible in the Scintilla control.
- Mode Gets/Sets the for the document. Default is CrLf.
Methods
- ConvertAllLines(ScintillaNET.EndOfLineMode) Converts all lines in the document to the given mode.

ScintillaNET.EndOfLineMode

Document's EndOfLine Mode

ScintillaNET.FakeStack

Mostly behaves like a stack but internally maintains a List for more flexability

ScintillaNET.FindOption

Controls find behavior for non-regular expression searches

ScintillaNET.FoldChangedEventArgs

Provides data for the FoldChanged event

Properties
- Line Gets/Sets the Line # that the fold change occured on
- NewFoldLevel Gets the new Fold Level of the line
- PreviousFoldLevel Gets the previous Fold Level of the line
Methods
- #ctor(System.Int32,System.Int32,System.Int32,System.Int32) Initializes a new instance of the FoldChangedEventArgs class.

ScintillaNET.FoldFlag

The flags affecting how the fold is marked in the main text area (as well as in the margin). If the value changes for onscreen text, the display will redraw.

ScintillaNET.FoldLevel

The flags that are stored along with the fold level.

ScintillaNET.HotspotClickEventArgs

Provides data for the , , and events.

Properties
- Position Gets the byte offset in the document of the character that was clicked.
Methods
- #ctor(System.Int32) Initializes a new instance of the class.

ScintillaNET.INativeScintilla

ScintillaNET.IndicatorStyle

Style of Indicator to be displayed

ScintillaNET.InformationType

Type of data to display at one of the positions in a Page Information section

ScintillaNET.KeyBinding

Represents the Binding Combination of a Keyboard Key + Modifiers

Properties
- KeyCode Gets/Sets Key to trigger command
- Modifiers Gets sets key modifiers to the Keyboard shortcut
Methods
- #ctor(System.Windows.Forms.Keys,System.Windows.Forms.Keys) Initializes a new instance of the KeyBinding structure.
- Equals(System.Object) Overridden.
- GetHashCode Overridden
- ToString Overridden. Returns string representation of the Keyboard shortcut

ScintillaNET.LayoutCacheMode

Specifies the line layout caching strategy used by a control.

ScintillaNET.Lexer

Built in lexers supported by Scintilla

ScintillaNET.LinesNeedShownEventArgs

Provides data for the LinesNeedShown event

Properties
- FirstLine Returns the first (top) line that needs to be shown
- LastLine Returns the last (bottom) line that needs to be shown
Methods
- #ctor(System.Int32,System.Int32) Initializes a new instance of the LinesNeedShownEventArgs class.

ScintillaNET.LineWrapping

Controls line wrapping options in a control.

Properties
- IndentMode Gets or sets how wrapped lines are indented.
- IndentSize Gets or sets the size that wrapped lines are indented when is .
- Mode Gets or sets how and whether line wrapping is performed.
- VisualFlags Gets or sets the visual glyphs displayed on wrapped lines.
- VisualFlagsLocations Gets or sets the location of visual glyphs displayed on wrapped lines.
Methods
- #ctor(ScintillaNET.Scintilla) Initializes a new instance of the class.
- GetWrapCount(System.Int32) The number of lines displayed when a line of text is wrapped.
- WrapLines(System.Int32,System.Int32,System.Int32) Forces the line range specified to wrap at the given pixel width. This operates independently of the current line wrapping property.

ScintillaNET.LineWrappingIndentMode

Specifies how wrapped lines are indented when line wrapping is enabled in a control.

ScintillaNET.LineWrappingMode

Specifies the line wrapping modes that can be applied to a control.

ScintillaNET.LineWrappingVisualFlags

Specifies how line wrapping visual glyphs are displayed in a control.

ScintillaNET.LineWrappingVisualFlagsLocations

Specifies the locations of line wrapping visual glyphs in a control.

ScintillaNET.MacroRecordEventArgs

Provides data for the MacroRecorded event

Properties
- RecordedMessage Returns the recorded window message that can be sent back to the native Scintilla window
Methods
- #ctor(ScintillaNET.NativeScintillaEventArgs) Initializes a new instance of the MacroRecordEventArgs class.
- #ctor(System.Windows.Forms.Message) Initializes a new instance of the MacroRecordEventArgs class.

ScintillaNET.MarginClickEventArgs

Provides data for the MarginClick event

Properties
- Line Returns the Document line # where the click occured
- Margin Returns the Margin where the click occured
- Modifiers Returns any Modifier keys (shift, alt, ctrl) that were in use at the time the click event occured
- Position Returns the Document position of the line where the click occured
- ToggleFold Gets/Sets whether the fold at the current line should be toggled
- ToggleMarkerNumber Gets/Sets the marker number that should be toggled in result of the click
Methods
- #ctor(System.Windows.Forms.Keys,System.Int32,ScintillaNET.Line,ScintillaNET.Margin,System.Int32,System.Boolean) Initializes a new instance of the MarginClickEventArgs class.

ScintillaNET.Marker

Defines a marker's appearance in a control.

Properties
- Symbol Gets or sets the marker symbol.

ScintillaNET.MarkerChangedEventArgs

Provides data for the MarkerChanged event

Properties
- Line Returns the line number where the marker change occured
Methods
- #ctor(System.Int32,System.Int32) Initializes a new instance of the LinesNeedShownEventArgs class.

ScintillaNET.MarkerCollection

Represents a collection of objects and options in a control.

ScintillaNET.MarkerSymbol

Specifies the symbol displayed by a .

ScintillaNET.ModifiedEventArgs

Base class for modified events

ScintillaNET.NativeScintillaEventArgs

Provides data for native Scintilla Events

Properties
- Msg Notification Message sent from the native Scintilla
- SCNotification SCNotification structure sent from Scintilla that contains the event data
Methods
- #ctor(System.Windows.Forms.Message,ScintillaNET.SCNotification) Initializes a new instance of the NativeScintillaEventArgs class.

ScintillaNET.NavigationPont

Represents a point in the document used for navigation.

Methods
- #ctor(System.Int32,ScintillaNET.Scintilla) Initializes a new instance of the NavigationPont class.
- Dispose Overridden.

ScintillaNET.NotifyHeader

This matches the Win32 NMHDR structure

ScintillaNET.OverloadList

List of strings to be used with .

Properties
- Current Text of the overload to be displayed in the CallTip
- CurrentIndex Index of the overload to be displayed in the CallTip
Methods
- #ctor Creates a new instance of an OverLoadList
- #ctor(System.Collections.Generic.IEnumerable{System.String}) Creates a new instance of an OverLoadList. The list of overloads is supplied by collection
- #ctor(System.Int32) Creates a new instance of an OverLoadList. The

ScintillaNET.PageInformation

Class for determining how and what to print for a header or footer.

Properties
- Border Border style used for the Page Information section
- Center Information printed in the center of the Page Information section
- Display Whether there is a need to display this item, true if left, center, or right are not nothing.
- Font Font used in printing the Page Information section
- Height Height required to draw the Page Information section based on the options selected.
- Left Information printed on the left side of the Page Information section
- Margin Space between the Page Information section and the rest of the page
- Right Information printed on the right side of the Page Information section
Methods
- #ctor Default Constructor
- #ctor(ScintillaNET.PageInformationBorder,ScintillaNET.InformationType,ScintillaNET.InformationType,ScintillaNET.InformationType) Normal Use Constructor
- #ctor(System.Int32,System.Drawing.Font,ScintillaNET.PageInformationBorder,ScintillaNET.InformationType,ScintillaNET.InformationType,ScintillaNET.InformationType) Full Constructor
- Draw(System.Drawing.Graphics,System.Drawing.Rectangle,System.String,System.Int32) Draws the page information section in the specified rectangle

ScintillaNET.PageInformationBorder

Type of border to print for a Page Information section

ScintillaNET.PageSettings

ScintillaNET derived class for handling printed page settings. It holds information on how and what to print in the header and footer of pages.

Properties
- ColorMode Method used to render colored text on a printer
- FontMagnification Number of points to add or subtract to the size of each screen font during printing
- Footer Page Information printed in the footer of the page
- Header Page Information printed in header of the page
Methods
- #ctor Default constructor

ScintillaNET.PrintColorMode

Controls color mode fore printing

ScintillaNET.PrintDocument

ScintillaNET derived class for handling printing of source code from a Scintilla control.

Methods
- #ctor(ScintillaNET.Scintilla) Default Constructor
- OnBeginPrint(System.Drawing.Printing.PrintEventArgs) Method called after the Print method is called and before the first page of the document prints
- OnEndPrint(System.Drawing.Printing.PrintEventArgs) Method called when the last page of the document has printed
- OnPrintPage(System.Drawing.Printing.PrintPageEventArgs) Method called when printing a page

ScintillaNET.PrintRectangle

Struct used for specifying the printing bounds

ScintillaNET.Properties.Resources

A strongly-typed resource class, for looking up localized strings, etc.

Properties
- Culture Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class.
- Exception_CannotCreateDirectFunction Looks up a localized string similar to Cannot create the Scintilla direct message function..
- Exception_CannotLoadModule Looks up a localized string similar to Cannot load the '{0}' module into memory..
- Exception_EmptyStringArgument Looks up a localized string similar to The '{0}' argument cannot be an empty string..
- Exception_EnumeratorEnded Looks up a localized string similar to Enumeration already finished..
- Exception_EnumeratorNotStarted Looks up a localized string similar to Enumeration has not started. Call MoveNext..
- Exception_IllegalCrossThreadCall Looks up a localized string similar to Cross-thread operation not valid: Control '{0}' accessed from a thread other than the thread it was created on..
- Exception_IndexOutOfRange Looks up a localized string similar to Index was out of range. Must be non-negative and less than the size of the collection..
- Exception_InsufficientSpace Looks up a localized string similar to Insufficient space in the target location to copy the information..
- Exception_InvalidAnnotation Looks up a localized string similar to A change in the control who created this annotation has rendered the object invalid..
- Exception_InvalidLine Looks up a localized string similar to The {0} line must specify a valid line within the document..
- Exception_InvalidLineRange Looks up a localized string similar to The start line and end line must specify a valid range..
- Exception_InvalidModule Looks up a localized string similar to '{0}' is not a valid Scintilla module..
- Exception_InvalidStartLine Looks up a localized string similar to The start line must be greater than or equal to zero..
- Exception_ModuleAlreadyLoaded Looks up a localized string similar to The module name must be set before any Scintilla object are created..
- Exception_MustBeNonNegativeAndLessThan Looks up a localized string similar to '{0}' was out of range. Must be non-negative and less than {1}..
- ModuleName Looks up a localized string similar to SciLexer.dll.
- ModuleName64 Looks up a localized string similar to SciLexer64.dll.
- ResourceManager Returns the cached ResourceManager instance used by this class.

ScintillaNET.Range

A range within the editor. Start and End are both Positions.

Methods
- CollapseAllFolds Collapses all folds
- ExpandAllFolds Expands all folds
- StripTrailingSpaces Removes trailing spaces from each line

ScintillaNET.RangeToFormat

Struct used for passing parameters to FormatRange()

ScintillaNET.Scintilla

Represents a Scintilla text editor control.

Properties
- AcceptsReturn Gets or sets a value indicating whether pressing ENTER creates a new line of text in the control or activates the default button for the form.
- AcceptsTab Gets or sets a value indicating whether pressing the TAB key types a TAB character in the control instead of moving the focus to the next control in the tab order.
- Annotations Gets a collection containing all annotations in the control.
- AutoComplete Controls autocompletion behavior.
- BackColor Gets or sets the background color for the control.
- BackgroundImage This property is not relevant for this class.
- BackgroundImageLayout This property is not relevant for this class.
- BorderStyle Gets or sets the border style of the control.
- CallTip Manages CallTip (Visual Studio-like code Tooltip) behaviors
- Caption Gets/Sets the Win32 Window Caption. Defaults to Type's FullName
- Caret Controls Caret Behavior
- Clipboard Gets Clipboard access for the control.
- Commands Controls behavior of keyboard bound commands.
- ConfigurationManager Controls behavior of loading/managing ScintillaNET configurations.
- CreateParams Overridden. See .
- CurrentPos Gets or sets the character index of the current caret position.
- DefaultCursor Gets or sets the default cursor for the control.
- DefaultSize Overridden. See .
- DocumentHandler Controls behavior of Documents
- DocumentNavigation Controls behavior of automatic document navigation
- DropMarkers Controls behavior of Drop Markers
- Encoding Controls Encoding behavior
- EndOfLine Controls End Of Line Behavior
- Font Gets or sets the font of the text displayed by the control.
- ForeColor Gets or sets the foreground color of the control.
- LayoutCacheMode Gets or sets the line layout caching strategy in a control.
- LineWrapping Gets an object that controls line wrapping options in the control.
- Markers Gets a collection representing the marker objects and options within the control.
- Modified Gets or sets a value that indicates that the control has been modified by the user since the control was created or its contents were last set.
- PositionCacheSize Gets or sets the position cache size used to layout short runs of text in a control.
- SupressControlCharacters Gets or sets a value indicating whether characters not considered alphanumeric (ASCII values 0 through 31) are prevented as text input.
- Text Gets or sets the current text in the control.
- TextLength Gets the _length of text in the control.
- Whitespace Gets the display mode and style behavior associated with the control.
- Zoom Gets or sets the current zoom level of the control.
Methods
- AddLastLineEnd Adds a line end marker to the end of the document
- AppendText(System.String) Appends a copy of the specified string to the _end of this instance.
- CreateAnnotationsInstance Creates and returns a new object.
- CreateLineWrappingInstance Creates and returns a new object.
- DirectMessage(System.Int32,System.IntPtr,System.IntPtr) Sends the specified message directly to the native Scintilla window, bypassing any managed APIs.
- Dispose(System.Boolean) Overridden. Releases the unmanaged resources used by the and its child controls and optionally releases the managed resources.
- ExportHtml Exports a HTML representation of the current document.
- ExportHtml(System.IO.TextWriter,System.String,System.Boolean) Exports a HTML representation of the current document.
- GetCurrentLine Gets the text of the line containing the caret.
- GetCurrentLine(System.Int32@) Gets the text of the line containing the caret and the current caret position within that line.
- GetWordFromPosition(System.Int32) Gets a word from the specified position
- InsertText(System.Int32,System.String) Inserts text at the given position
- InsertText(System.String) Inserts text at the current cursor position
- IsInputKey(System.Windows.Forms.Keys) Overridden. See .
- OnAnnotationChanged(ScintillaNET.AnnotationChangedEventArgs) Raises the event.
- OnAutoCompleteAccepted(ScintillaNET.AutoCompleteAcceptedEventArgs) Raises the event.
- OnBackColorChanged(System.EventArgs) Raises the event.
- OnBeforeTextDelete(ScintillaNET.TextModifiedEventArgs) Raises the event.
- OnBeforeTextInsert(ScintillaNET.TextModifiedEventArgs) Raises the event.
- OnBorderStyleChanged(System.EventArgs) Raises the event.
- OnCallTipClick(ScintillaNET.CallTipClickEventArgs) Raises the event.
- OnCharAdded(ScintillaNET.CharAddedEventArgs) Raises the event.
- OnCreateControl Overridden. See .
- OnDocumentChange(ScintillaNET.NativeScintillaEventArgs) Raises the event.
- OnDoubleClick(System.EventArgs) Provides the support for code block selection
- OnDropMarkerCollect(ScintillaNET.DropMarkerCollectEventArgs) Raises the event.
- OnDwellEnd(ScintillaNET.ScintillaMouseEventArgs) Raises the event.
- OnDwellStart(ScintillaNET.ScintillaMouseEventArgs) Raises the event.
- OnFoldChanged(ScintillaNET.FoldChangedEventArgs) Raises the event.
- OnFontChanged(System.EventArgs) Raises the event.
- OnForeColorChanged(System.EventArgs) Raises the event.
- OnGotFocus(System.EventArgs) Overridden. See .
- OnHandleCreated(System.EventArgs) Overridden. Raises the event.
- OnHotspotClick(ScintillaNET.HotspotClickEventArgs) Raises the event.
- OnHotspotDoubleClick(ScintillaNET.HotspotClickEventArgs) Raises the event.
- OnHotspotReleaseClick(ScintillaNET.HotspotClickEventArgs) Raises the event.
- OnIndicatorClick(ScintillaNET.ScintillaMouseEventArgs) Raises the event.
- OnKeyDown(System.Windows.Forms.KeyEventArgs) Overridden. See .
- OnKeyPress(System.Windows.Forms.KeyPressEventArgs) Overridden. See .
- OnLinesNeedShown(ScintillaNET.LinesNeedShownEventArgs) Raises the event.
- OnLoad(System.EventArgs) Raises the event.
- OnLostFocus(System.EventArgs) Overridden. See .
- OnMacroRecord(ScintillaNET.MacroRecordEventArgs) Raises the event.
- OnMarginClick(ScintillaNET.MarginClickEventArgs) Raises the event.
- OnMarkerChanged(ScintillaNET.MarkerChangedEventArgs) Raises the event.
- OnModifiedChanged(System.EventArgs) Raises the event.
- OnPaint(System.Windows.Forms.PaintEventArgs) Overridden. See .
- OnReadOnlyModifyAttempt(System.EventArgs) Raises the event.
- OnScroll(System.Windows.Forms.ScrollEventArgs) Raises the event.
- OnSelectionChanged(System.EventArgs) Raises the event.
- OnStyleNeeded(ScintillaNET.StyleNeededEventArgs) Raises the event.
- OnTextDeleted(ScintillaNET.TextModifiedEventArgs) Raises the event.
- OnTextInserted(ScintillaNET.TextModifiedEventArgs) Raises the event.
- OnZoomChanged(System.EventArgs) Raises the event.
- PositionIsOnComment(System.Int32) Checks that if the specified position is on comment.
- PositionIsOnComment(System.Int32,ScintillaNET.Lexer) Checks that if the specified position is on comment.
- ProcessKeyMessage(System.Windows.Forms.Message@) Overridden. See .
- SafeBraceMatch(System.Int32) Custom way to find the matching brace when BraceMatch() does not work
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32) Handles Scintilla Call Style: (,)
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,ScintillaNET.VOID,System.Int32) Handles Scintilla Call Style: (,int)
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,ScintillaNET.VOID,System.String) Handles Scintilla Call Style: (,string) Notes: This helper method handles all messages that take const char* as an input string in the lParam. In some messages Scintilla expects a NULL terminated string and in others it depends on the string _length passed in as wParam. This method handles both situations and will NULL terminate the string either way.
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.Boolean) Handles Scintilla Call Style: (bool,)
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.Boolean,System.Int32) Handles Scintilla Call Style: (bool,int)
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.Int32) Handles Scintilla Call Style: (int,)
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.Int32,System.Boolean) Handles Scintilla Call Style: (int,bool)
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.Int32,System.Int32) Handles Scintilla Call Style: (int,int)
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.Int32,System.String) Handles Scintilla Call Style: (int,string) Notes: This helper method handles all messages that take const char* as an input string in the lParam. In some messages Scintilla expects a NULL terminated string and in others it depends on the string _length passed in as wParam. This method handles both situations and will NULL terminate the string either way.
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.Int32,System.String@) Handles Scintilla Call Style: (int,stringresult) Notes: Helper method to wrap all calls to messages that take a char* in the lParam and returns a regular .NET String. This overload assumes there will be no wParam and obtains the string _length by calling the message with a 0 lParam.
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.Int32,System.UInt32) Handles Scintilla Call Style: (int,uint)
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.IntPtr,System.IntPtr) This is the primary Native communication method with Scintilla used by this control. All the other overloads call into this one.
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.IntPtr,System.String@,System.Int32) Handles Scintilla Call Style: (?) Notes: Helper method to wrap all calls to messages that take a char* in the wParam and set a regular .NET String in the lParam. Both the _length of the string and an additional wParam are used so that various string Message styles can be acommodated.
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.String) Handles Scintilla Call Style: (string,)
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.String,System.Int32) Handles Scintilla Call Style: (string,int)
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.String,System.String) Handles Scintilla Call Style: (string,string) Notes: Used by SCI_SETPROPERTY
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.String,System.String@) Handles Scintilla Call Style: (string,stringresult) Notes: This one is used specifically by SCIGETPROPERTY and SCIGETPROPERTYEXPANDED so it assumes it's usage
- ScintillaNET#INativeScintilla#SendMessageDirect(System.UInt32,System.String@) Handles Scintilla Call Style: (,stringresult) Notes: Helper method to wrap all calls to messages that take a char* in the lParam and returns a regular .NET String. This overload assumes there will be no wParam and obtains the string _length by calling the message with a 0 lParam.
- SetModuleName(System.String) Sets the application-wide default module name of the native Scintilla library.
- WndProc(System.Windows.Forms.Message@) Overridden. Processes Windows messages.
Events
- AnnotationChanged Occurs when an annotation has changed.
- AutoCompleteAccepted Occurs when the user makes a selection from the auto-complete list.
- BeforeTextDelete Occurs when text is about to be removed from the document.
- BeforeTextInsert Occurs when text is about to be inserted into the document.
- BorderStyleChanged Occurs when the value of the property has changed.
- CallTipClick Occurs when a user clicks on a call tip.
- CharAdded Occurs when the user types an ordinary text character (as opposed to a command character) into the text.
- DocumentChange Occurs when the text or styling of the document changes or is about to change.
- DropMarkerCollect Occurs when a is about to be collected.
- DwellEnd Occurs when a user actions such as a mouse move or key press ends a dwell (hover) activity.
- DwellStart Occurs when the user hovers the mouse (dwells) in one position for the dwell period.
- FoldChanged Occurs when a folding change has occurred.
- HotspotClick Occurs when a user clicks on text that is in a style with the hotspot attribute set.
- HotspotDoubleClick Occurs when a user double-clicks on text that is in a style with the hotspot attribute set.
- HotspotReleaseClick Occurs when a user releases a click on text that is in a style with the hotspot attribute set.
- IndicatorClick Occurs when the a clicks or releases the mouse on text that has an indicator.
- LinesNeedShown Occurs when a range of lines that is currently invisible should be made visible.
- Load Occurs when the control is first loaded.
- MacroRecord Occurs each time a recordable change occurs.
- MarginClick Occurs when the mouse was clicked inside a margin that was marked as sensitive.
- MarkerChanged Occurs when one or more markers has changed in a line of text.
- ReadOnlyModifyAttempt Occurs when a user tries to modify text when in read-only mode.
- Scroll Occurs when the control is scrolled.
- SelectionChanged Occurs when the selection has changed.
- StyleNeeded Occurs when the control is about to display or print text that requires styling.
- TextDeleted Occurs when text has been removed from the document.
- TextInserted Occurs when text has been inserted into the document.
- ZoomChanged Occurs when the user zooms the display using the keyboard or the property is set.

ScintillaNET.Scintilla.LastSelection

Holds the last previous selection's properties, to let us know when we should fire SelectionChanged

ScintillaNET.ScintillaMouseEventArgs

Provides data for Scintilla mouse events

Properties
- Position Returns the Document position
- X Returns the X (left) position of mouse in pixels
- Y Returns the Y (top) position of mouse in pixels
Methods
- #ctor(System.Int32,System.Int32,System.Int32) Initializes a new instance of the ScintillaMouseEventArgs class.

ScintillaNET.SmartIndent

Style of smart indent

ScintillaNET.StyleCase

Represents casing styles

ScintillaNET.StyleChangedEventArgs

Provides data for the StyleChanged event

Properties
- Length Returns how many characters have changed
- Position Returns the starting document position where the style has been changed

ScintillaNET.StyleNeededEventArgs

Provides data for the StyleNeeded event

Properties
- Range Returns the document range that needs styling
Methods
- #ctor(ScintillaNET.Range) Initializes a new instance of the StyleNeededEventArgs class.

ScintillaNET.StyleRun

Defines a run of styled text in a control

Properties
- Length Gets or sets length of this .
- Style Gets or sets the style index of this .
Methods
- #ctor(System.Int32,System.Int32) Initializes a new instance of the struct.

ScintillaNET.StyleRunWriter

Provides a writer paradigm for building a list and optionally the text that is being styled.

Methods
- #ctor(System.Text.StringBuilder) Initializes a new instance of the class.
- GetStringBuilder Returns the underlying .
- GetStyles Returns a enumerable built by the thus far.
- Write(System.String,System.Int32) Writes a run of the specified string length in the specified style.

ScintillaNET.StylesCommon

Common predefined styles that are always valid with any lexer.

ScintillaNET.TextModifiedEventArgs

Provices data for the TextModified event

Properties
- IsUserChange Returns true if the change was a direct result of user interaction
- Length Returns the length of the change occured.
- LinesAddedCount Returns the # of lines added or removed as a result of the change
- MarkerChangedLine Returns the line # of where the marker change occured (if applicable)
- Position Returns the document position where the change occured
- Text The affected text of the change
Methods
- #ctor(System.Int32,System.Boolean,System.Int32,System.Int32,System.Int32,System.Int32,System.String) Initializes a new instance of the TextModifiedEventArgs class.
- ToString Overridden.

ScintillaNET.TopLevelHelper

Top level ScintillaHelpers Like Style and Folding inherit from this class so they don't have to reimplement the same Equals method

ScintillaNET.UndoRedoFlags

Contains Undo/Redo information, used by many of the events

Methods
- #ctor(System.Int32) Initializes a new instance of the UndoRedoFlags structure.
- ToString Overridden

ScintillaNET.UriDroppedEventArgs

Provides data for the UriDropped event

Properties
- UriText Text of the dropped file or uri
Methods
- #ctor(System.String) Initializes a new instance of the UriDroppedEventArgs class.

ScintillaNET.VOID

Used internally to signify an ignored parameter by overloads of SendMessageDirect that match the native Scintilla's Message signatures.

ScintillaNET.Whitespace

Determines how whitespace should be displayed in a control.

Properties
- BackColor Gets or sets the whitespace background color.
- ForeColor Gets or sets the whitespace foreground color.
- Mode Gets or sets the whitespace display mode.

ScintillaNET.WhitespaceMode

Specifies the display mode of whitespace characters.

ScintillaNET.XpmConverter

Converts Bitmap images to XPM data for use with ScintillaNET. Warning: images with more than (around) 50 colors will generate incorrect XPM The XpmConverter class was based on code from flashdevelop.

Methods
- ConvertToXPM(System.Drawing.Bitmap) Converts Bitmap images to XPM data for use with ScintillaNET. Warning: images with more than (around) 50 colors will generate incorrect XPM. Uses the DefaultTransparentColor.
- ConvertToXPM(System.Drawing.Bitmap,System.String) Converts Bitmap images to XPM data for use with ScintillaNET. Warning: images with more than (around) 50 colors will generate incorrect XPM tColor: specified transparent color in format: "#00FF00".
- ConvertToXPM(System.Windows.Forms.ImageList) Cicles an image list object to convert contained images into xpm at the same time we add converted images into an arraylist that lets us to retrieve images later. Uses the DefaultTransparentColor.
- ConvertToXPM(System.Windows.Forms.ImageList,System.String) Cicles an image list object to convert contained images into xpm at the same time we add converted images into an arraylist that lets us to retrieve images later

New Comment on "HowToSyntax"

kawish — Tue, 24 Jul 2012 08:33:59 GMT

Hi, if I have a custom language syntax, let's say "MyLang" created by ANTLR. What should I do to make the syntax highlighting work? (I modified the SciLexer library to make it work at this moment)

Updated Wiki: FAQ

jacobslusser — Mon, 21 May 2012 03:42:40 GMT

Frequently Asked Questions (FAQ)

These questions are frequently asked in our discussion forum. Common exceptions and other issues are covered in Troubleshooting.

Can ScintillaNET run on 64-bit platforms?
How do I create my own language and/or custom syntax highlighting?
How do I request a feature or report a bug?
Can you show me some sample code to accomplish XYZ?

Can ScintillaNET run on 64-bit platforms?

Yes, as of version 2.3. Make sure you distribute both SciLexer.dll and SciLexer64.dll with your application and ScintillaNET will automatically detect the platform and use the appropriate DLL.

How do I create my own language and/or custom syntax highlighting?

ScintillaNET has numerous built-in lexers (the components responsible for syntax highlighting) and so chances are that any modern language already has syntax highlighting support and you'll just need to configure it to your liking. Doing syntax highlighting for your own custom language, however, requires a very good understanding of compiler theory and parsing. If you're feeling adventurous you can try the following:

Scintilla.Indentation.SmartIndentType = SmartIndent.None;
Scintilla.ConfigurationManager.Language = String.Empty;
Scintilla.Lexing.LexerName = "container";
Scintilla.Lexing.Lexer = Lexer.Container;
Scintilla.StyleNeeded += Scintilla_StyleNeeded;

This will call the Scintilla_StyleNeeded event handler anytime Scintilla needs to style text—allowing you to provide your own custom styling logic. At that point you're on your own. A brief explanation of styling can be found in the Basic Styling Overview page of the Documentation. There is also a rudimentary working example in the IniLexer class of the SCide sample application.

Be mindful of the fact that if you run into a roadblock you're not likely to get people jumping at the chance to help you with "your" custom language in the forums.

How do I request a feature or report a bug?

From the Issue Tracker link at the top of our CodePlex page select Create Issue. Given our small team size requests can sometimes take a while to get to but we do eventually see and attempt to fulfill them all.

Can you show me some sample code to accomplish XYZ?

No. We understand that our Documentation is on the light side, however, asking us to write code for you will go unanswered. We simply don't have the time. On the other hand, you will almost always get a response when you post your troublesome code and ask us to steer you in the right direction.

Updated Wiki: FAQ

jacobslusser — Mon, 21 May 2012 03:26:49 GMT

Frequently Asked Questions (FAQ)

These questions are frequently asked in our discussion forum. Common exceptions and other issues are covered in Troubleshooting.

Can ScintillaNET run on 64-bit platforms?
How do I create my own language and/or custom syntax highlighting?
How do I request a feature or report a bug?

Can ScintillaNET run on 64-bit platforms?

Yes, as of version 2.3. Make sure you distribute both SciLexer.dll and SciLexer64.dll with your application and ScintillaNET will automatically detect the platform and use the appropriate DLL.

How do I create my own language and/or custom syntax highlighting?

Scintilla.Indentation.SmartIndentType = SmartIndent.None;
Scintilla.ConfigurationManager.Language = String.Empty;
Scintilla.Lexing.LexerName = "container";
Scintilla.Lexing.Lexer = Lexer.Container;
Scintilla.StyleNeeded += Scintilla_StyleNeeded;

How do I request a feature or report a bug?

Updated Wiki: Installation

jacobslusser — Mon, 21 May 2012 03:25:11 GMT

Installation

The following guide is provided for users who wish to use the ScintillaNET control in their projects. This guide assumes the development platform is Visual Studio® 2010.

Downloading and Unzipping
Configuring the Search Path
Adding to the Visual Studio Toolbox
Target the full .NET Framework

Downloading and Unzipping

The ScintillaNET team regularly publishes new releases as features are added and bugs are fixed. These releases can easily be obtained from the ScintillaNET Downloads page on CodePlex. Files are distributed in both binary and source versions and then zip compressed.

Download the binaries recommended release package from the ScintillaNET Downloads page by clicking the appropriate link and selecting I Agree from the license terms-of-use popup. (Other releases and versions maybe be available but we encourage you to download the "binaries" version of the recommended release unless you have a specific reason not to).
Unzip the package using a third-party tool or by right-clicking on the file/icon in Windows Explorer and selecting Extract All... from the context menu and following the wizard.
Once unzipped you'll want to place the files in a location where they can easily be referenced by any of the projects you wish to use ScintillaNET with. For the purposes of this guide, we'll assume that the target directory is C:\ScintillaNET.
1. If the previous steps were completed successfully you should have a folder on your computer with at least the files ScintillaNET.dll, SciLexer.dll, and SciLexer64.dll. Other license files and documentation may be included as well.

Configuring the Search Path

Failing to configure the search path or doing it incorrectly trips-up many users. ScintillaNET is a wrapper around an umanaged DLL and uses Platform Invoke (P-Invoke) calls from the managed ScintillaNET.dll to the native SciLexer.dll or SciLexer64.dll to perform its magic. In order for that to work the SciLexer.dll and SciLexer64.dll must be in one of the places Windows uses to locate DLLs. More information about the Search Path Used by Windows to Locate a DLL can be found on the MSDN website. Of the many ways that Windows can use to find the SciLexer.dll and SciLexer64.dll, the instructions below illustrate how to modify your PATH environmental variable.

Right-click on the My Computer icon on the Desktop or in the Start Menu and select Properties from the context menu.
Select the Advanced tab.
Click the Environment Variables button.
Add the "C:\ScintillaNET" folder (assuming that is the location of the downloaded files, or substitute an alternate location) to the Path variable in the User Variables list.
1. If there is no Path variable in the User Variables list, add one by clicking New and inputing the value "Path" in the Variable Name field and "C:\ScintillaNET" in the Variable Value field.
2. If there is already a Path variable in the User Variables list, select the Path variable and then click Edit to modify. Append "C:\ScintillaNET" to the end of the Variable Value field separating it from any previous value(s) with a semicolon.
Close all open Visual Studio or Visual C# applications and restart them for the changes to take effect.

Adding to the Visual Studio Toolbox

Adding the ScintillaNET control to the Visual Studio (or Visual C# Express Edition) toolbox makes adding it to one of your forms as easy as dragging and dropping.

With the Windows Forms designer open in Visual Studio, right-click on the ToolBox window and select Choose Items... from the context menu.
From the Choose Toolbox Items dialog, select the .NET Framework Components tab and then click the Browse... button.
Navigate to the location of the ScintillaNET.dll file on your system ("C:\ScintillaNET\ScintillaNET.dll" in our example) and after selecting the file, click the Open button.
When the Open dialog closes, one or more ScintillaNET components will have been added to the list.
Ensure that the entry named "Scintilla" is checked and then click the OK button.
1. The Scintilla control should now be listed in the Toolbox. Simply drag it onto a form in the designer to begin using it.

Target the full .NET Framework

At the time ScintillaNET first start development there was no concept of targeting Client Profile versus full .NET Framework. Because of that ScintillaNET has dependencies that prevent it from running on the Client Profile (namely we depend on System.Design). To target the full framework profile:

Right-click on your startup project from the Visual Studio Solution Explorer and select Properties.
From the Application tab of the project properties page change the Target framework field to .NET Framework 4.
1. ScintillaNET can also run on the 2.0, 3.0 and 3.5 versions of the framework.
Save the changes to the project properties.

Updated Wiki: Troubleshooting

jacobslusser — Mon, 21 May 2012 03:24:33 GMT

Troubleshooting

Not to be confused with the Frequently Asked Questions (FAQ), what follows is a list of common issues developers encounter while using ScintillaNET and suggestions on how to resolve them.

"Cannot load the 'SciLexer.dll' module into memory" at design time or run time
"'ScintillaNET' could not be found (are you missing a using directive or an assembly reference?)" when compiling

"Cannot load the 'SciLexer.dll' module into memory" at design time or run time

ScintillaNET is a wrapper around the unmanaged SciLexer (or SciLexer64) DLL. As such it is absolutely necessary to have that DLL for ScintillaNET to work. If you are encountering this problem at runtime, ensure that the SciLexer and SciLexer64 DLLs are in your application folder. If you are encountering this error when using the Visual Studio designer, the same problem is occuring but because of the way Visual Studio searches for DLLs you'll need to add it to your Path environment variable. Instructions for Configuring the Search Path can be found on the Installation documentation page.

"'ScintillaNET' could not be found (are you missing a using directive or an assembly reference?)" when compiling

This error is unfortunately very misleading and can cause of hair loss if you've never seen it before. The short answer is that your project is likely targeted at the Client Profile instead of the full .NET Framework. The Installation page of our documentation has a section on how to Target the full .NET Framework if you've never done it before.

Updated Wiki: Documentation

jacobslusser — Mon, 21 May 2012 02:32:26 GMT

ScintillaNET Documentation

Getting Started
Examples
Advanced Features
Developers Guide
Documentation
Help

Getting Started

Everything you need to know to download ScintillaNET, configure it in your development environment, and begin using it in your project.

Examples

The following examples are just the tip of the iceburg. More examples will be coming soon.

Advanced Features

Coming Soon

Developers Guide

Getting the Source Code
Creating a Patch

Documentation

Help

Updated Wiki: Documentation

jacobslusser — Mon, 21 May 2012 02:31:02 GMT

ScintillaNET Documentation

Getting Started
Examples
Advanced Features
Developers Guide
Documentation
Help

Getting Started

Everything you need to know to download ScintillaNET, configure it in your development environment, and begin using it in your project.

Examples

The following examples are just the tip of the iceburg. More examples will be coming soon.

Advanced Features

Coming Soon

Developers Guide

Getting the Source Code
Creating a Patch

Documentation

Help

Updated Wiki: Installation

jacobslusser — Mon, 21 May 2012 02:30:00 GMT

ScintillaNET Installation

The following guide is provided for users who wish to use the ScintillaNET control in their projects. This guide assumes the development platform is Visual Studio® 2010.

Downloading and Unzipping
Configuring the Search Path
Adding to the Visual Studio Toolbox
Target the full .NET Framework

Downloading and Unzipping

Download the binaries recommended release package from the ScintillaNET Downloads page by clicking the appropriate link and selecting I Agree from the license terms-of-use popup. (Other releases and versions maybe be available but we encourage you to download the "binaries" version of the recommended release unless you have a specific reason not to).
Unzip the package using a third-party tool or by right-clicking on the file/icon in Windows Explorer and selecting Extract All... from the context menu and following the wizard.
Once unzipped you'll want to place the files in a location where they can easily be referenced by any of the projects you wish to use ScintillaNET with. For the purposes of this guide, we'll assume that the target directory is C:\ScintillaNET.
1. If the previous steps were completed successfully you should have a folder on your computer with at least the files ScintillaNET.dll, SciLexer.dll, and SciLexer64.dll. Other license files and documentation may be included as well.

Configuring the Search Path

Right-click on the My Computer icon on the Desktop or in the Start Menu and select Properties from the context menu.
Select the Advanced tab.
Click the Environment Variables button.
Add the "C:\ScintillaNET" folder (assuming that is the location of the downloaded files, or substitute an alternate location) to the Path variable in the User Variables list.
1. If there is no Path variable in the User Variables list, add one by clicking New and inputing the value "Path" in the Variable Name field and "C:\ScintillaNET" in the Variable Value field.
2. If there is already a Path variable in the User Variables list, select the Path variable and then click Edit to modify. Append "C:\ScintillaNET" to the end of the Variable Value field separating it from any previous value(s) with a semicolon.
Close all open Visual Studio or Visual C# applications and restart them for the changes to take effect.

Adding to the Visual Studio Toolbox

Adding the ScintillaNET control to the Visual Studio (or Visual C# Express Edition) toolbox makes adding it to one of your forms as easy as dragging and dropping.

With the Windows Forms designer open in Visual Studio, right-click on the ToolBox window and select Choose Items... from the context menu.
From the Choose Toolbox Items dialog, select the .NET Framework Components tab and then click the Browse... button.
Navigate to the location of the ScintillaNET.dll file on your system ("C:\ScintillaNET\ScintillaNET.dll" in our example) and after selecting the file, click the Open button.
When the Open dialog closes, one or more ScintillaNET components will have been added to the list.
Ensure that the entry named "Scintilla" is checked and then click the OK button.
1. The Scintilla control should now be listed in the Toolbox. Simply drag it onto a form in the designer to begin using it.

Target the full .NET Framework

Right-click on your startup project from the Visual Studio Solution Explorer and select Properties.
From the Application tab of the project properties page change the Target framework field to .NET Framework 4.
1. ScintillaNET can also run on the 2.0, 3.0 and 3.5 versions of the framework.
Save the changes to the project properties.

Updated Wiki: Documentation

jacobslusser — Mon, 21 May 2012 02:28:41 GMT

ScintillaNET Documentation

Getting Started
Examples
Advanced Features
Developers Guide
Documentation
Help

Getting Started

Everything you need to know to download ScintillaNET, configure it in your development environment, and begin using it in your project.

Examples

The following examples are just the tip of the iceburg. More examples will be coming soon.

Advanced Features

Coming Soon

Developers Guide

Getting the Source Code
Creating a Patch

Documentation

Help

Updated Wiki: Installation

jacobslusser — Mon, 21 May 2012 02:27:13 GMT

ScintillaNET Installation

The following guide is provided for users who wish to use the ScintillaNET control in their projects. This guide assumes the development platform is Visual Studio® 2010.

Downloading and Unzipping
Configuring the Search Path
Adding to the Visual Studio Toolbox
Configure your project to target the full .NET framework

Downloading and Unzipping

Download the binaries recommended release package from the ScintillaNET Downloads page by clicking the appropriate link and selecting I Agree from the license terms-of-use popup. (Other releases and versions maybe be available but we encourage you to download the "binaries" version of the recommended release unless you have a specific reason not to).
Unzip the package using a third-party tool or by right-clicking on the file/icon in Windows Explorer and selecting Extract All... from the context menu and following the wizard.
Once unzipped you'll want to place the files in a location where they can easily be referenced by any of the projects you wish to use ScintillaNET with. For the purposes of this guide, we'll assume that the target directory is C:\ScintillaNET.
1. If the previous steps were completed successfully you should have a folder on your computer with at least the files ScintillaNET.dll, SciLexer.dll, and SciLexer64.dll. Other license files and documentation may be included as well.

Configuring the Search Path

Right-click on the My Computer icon on the Desktop or in the Start Menu and select Properties from the context menu.
Select the Advanced tab.
Click the Environment Variables button.
Add the "C:\ScintillaNET" folder (assuming that is the location of the downloaded files, or substitute an alternate location) to the Path variable in the User Variables list.
1. If there is no Path variable in the User Variables list, add one by clicking New and inputing the value "Path" in the Variable Name field and "C:\ScintillaNET" in the Variable Value field.
2. If there is already a Path variable in the User Variables list, select the Path variable and then click Edit to modify. Append "C:\ScintillaNET" to the end of the Variable Value field separating it from any previous value(s) with a semicolon.
Close all open Visual Studio or Visual C# applications and restart them for the changes to take effect.

Adding to the Visual Studio Toolbox

Adding the ScintillaNET control to the Visual Studio (or Visual C# Express Edition) toolbox makes adding it to one of your forms as easy as dragging and dropping.

With the Windows Forms designer open in Visual Studio, right-click on the ToolBox window and select Choose Items... from the context menu.
From the Choose Toolbox Items dialog, select the .NET Framework Components tab and then click the Browse... button.
Navigate to the location of the ScintillaNET.dll file on your system ("C:\ScintillaNET\ScintillaNET.dll" in our example) and after selecting the file, click the Open button.
When the Open dialog closes, one or more ScintillaNET components will have been added to the list.
Ensure that the entry named "Scintilla" is checked and then click the OK button.
1. The Scintilla control should now be listed in the Toolbox. Simply drag it onto a form in the designer to begin using it.

Configure your project to target the full .NET framework

At the time ScintillaNET first start development there was no concept of targeting Client Profile versus full .NET framework. Because of that ScintillaNET has dependencies that prevent it from running on the Client Profile (namely we depend on System.Design). To target the full framework profile:

Right-click on your startup project from the Visual Studio Solution Explorer and select Properties.
From the Application tab of the project properties page change the Target framework field to .NET Framework 4.
1. ScintillaNET can also run on the 2.0, 3.0 and 3.5 versions of the framework.
Save the changes to the project properties.

Updated Wiki: Installation

jacobslusser — Mon, 21 May 2012 02:13:00 GMT

ScintillaNET Installation

The following guide is provided for users who wish to use the ScintillaNET control in their projects. This guide assumes the development platform is Visual Studio® 2010.

Downloading and Unzipping
Configuring the Search Path
Adding to the Visual Studio Toolbox

Downloading and Unzipping

Download the binaries recommended release package from the ScintillaNET Downloads page by clicking the appropriate link and selecting I Agree from the license terms-of-use popup. (Other releases and versions maybe be available but we encourage you to download the "binaries" version of the recommended release unless you have a specific reason not to).
Unzip the package using a third-party tool or by right-clicking on the file/icon in Windows Explorer and selecting Extract All... from the context menu and following the wizard.
Once unzipped you'll want to place the files in a location where they can easily be referenced by any of the projects you wish to use ScintillaNET with. For the purposes of this guide, we'll assume that the target directory is C:\ScintillaNET.
1. If the previous steps were completed successfully you should have a folder on your computer with at least the files ScintillaNET.dll, SciLexer.dll, and SciLexer64.dll. Other license files and documentation may be included as well.

Configuring the Search Path

Right-click on the My Computer icon on the Desktop or in the Start Menu and select Properties from the context menu.
Select the Advanced tab.
Click the Environment Variables button.
Add the "C:\ScintillaNET" folder (assuming that is the location of the downloaded files, or substitute an alternate location) to the Path variable in the User Variables list.
1. If there is no Path variable in the User Variables list, add one by clicking New and inputing the value "Path" in the Variable Name field and "C:\ScintillaNET" in the Variable Value field.
2. If there is already a Path variable in the User Variables list, select the Path variable and then click Edit to modify. Append "C:\ScintillaNET" to the end of the Variable Value field separating it from any previous value(s) with a semicolon.
Close all open Visual Studio or Visual C# applications and restart them for the changes to take effect.

Adding to the Visual Studio Toolbox

Adding the ScintillaNET control to the Visual Studio (or Visual C# Express Edition) toolbox makes adding it to one of your forms as easy as dragging and dropping.

With the Windows Forms designer open in Visual Studio, right-click on the ToolBox window and select Choose Items... from the context menu.
From the Choose Toolbox Items dialog, select the .NET Framework Components tab and then click the Browse... button.
Navigate to the location of the ScintillaNET.dll file on your system ("C:\ScintillaNET\ScintillaNET.dll" in our example) and after selecting the file, click the Open button.
When the Open dialog closes, one or more ScintillaNET components will have been added to the list.
Ensure that the entry named "Scintilla" is checked and then click the OK button.
1. The Scintilla control should now be listed in the Toolbox. Simply drag it onto a form in the designer to begin using it.

Updated Wiki: FAQ

jacobslusser — Mon, 21 May 2012 02:08:16 GMT

ScintillaNET Frequently Asked Questions (FAQ)

These questions are frequently asked in our discussion forum.

Can ScintillaNET run on 64-bit platforms?
How do I create my own language and/or custom syntax highlighting?
How do I request a feature or report a bug?

Can ScintillaNET run on 64-bit platforms?

Yes, as of version 2.3. Make sure you distribute both SciLexer.dll and SciLexer64.dll with your application and ScintillaNET will automatically detect the platform and use the appropriate DLL.

How do I create my own language and/or custom syntax highlighting?

Scintilla.Indentation.SmartIndentType = SmartIndent.None;
Scintilla.ConfigurationManager.Language = String.Empty;
Scintilla.Lexing.LexerName = "container";
Scintilla.Lexing.Lexer = Lexer.Container;
Scintilla.StyleNeeded += Scintilla_StyleNeeded;

How do I request a feature or report a bug?

Updated Wiki: Documentation

jacobslusser — Mon, 21 May 2012 01:56:03 GMT

ScintillaNET Documentation

Getting Started
Examples
Advanced Features
Developers Guide
Documentation
Help

Getting Started

Everything you need to know to download ScintillaNET, configure it in your development environment, and begin using it in your project.

Examples

The following examples are just the tip of the iceburg. More examples will be coming soon.