### Comment Example

Source: https://github.com/breecew/winuiedit/blob/main/lexilla/test/examples/asciidoc/AllStyles.adoc

Single-line comments start with '//'.

```asciidoc
// Comment=17
```

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

### Indentation Guides

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaDoc.html

Functions to set and get the visibility and behavior of indentation guides.

```APIDOC
## SCI_SETINDENTATIONGUIDES

### Description
Sets the indentation guide view. Indentation guides are dotted vertical lines that appear within indentation white space every indent size columns. They make it easy to see which constructs line up especially when they extend over multiple pages. Style STYLE_INDENTGUIDE (37) is used to specify the foreground and background colour of the indentation guides. There are 4 indentation guide views: SC_IV_NONE (no guides), SC_IV_REAL (guides in real indentation), SC_IV_LOOKFORWARD (guides beyond actual indentation), and SC_IV_LOOKBOTH (guides beyond actual indentation up to the next or previous non-empty line).

### Method
SCI_SETINDENTATIONGUIDES

### Parameters
#### Path Parameters
- **indentView** (int) - Description: The indentation guide view mode (SC_IV_NONE, SC_IV_REAL, SC_IV_LOOKFORWARD, SC_IV_LOOKBOTH).

## SCI_GETINDENTATIONGUIDES

### Description
Gets the current indentation guide view setting.

### Method
SCI_GETINDENTATIONGUIDES

### Response
#### Success Response (int)
- **return value** (int) - The current indentation guide view mode.
```

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

### Get Substyles Start and Length

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaDoc.html

Returns the starting index and the count of substyles allocated for a specific base style.

```C
SCI_GETSUBSTYLESSTART(int styleBase) → int
```

```C
SCI_GETSUBSTYLESLENGTH(int styleBase) → int
```

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

### Wildcard Include Example (ClCompile)

Source: https://github.com/breecew/winuiedit/blob/main/Tools/README.md

Example of a wildcard include comment for source files in vcxproj files, used by the Vcxproj tool.

```xml
<!--<WildcardClCompile Include="path\*.cpp" PrecompiledHeader="NotUsing">-->
...
<!--</WildcardClCompile>-->

```

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

### Tabs and Indentation Guides Configuration

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaDoc.html

Configures tab behavior, indentation, and the display of indentation guides.

```APIDOC
## SCI_SETTABWIDTH

### Description
Sets the width of a tab in columns.

### Method
N/A (Scintilla Message)

### Parameters
* **tabWidth** (int) - The number of columns for a tab.

### Response
N/A
```

```APIDOC
## SCI_GETTABWIDTH

### Description
Retrieves the current tab width in columns.

### Method
N/A (Scintilla Message)

### Parameters
None

### Response
* **int** - The current tab width.
```

```APIDOC
## SCI_SETTABMINIMUMWIDTH

### Description
Sets the minimum width in pixels for tabs. This affects how tabs are displayed when `SCI_SETTABWIDTH` is used.

### Method
N/A (Scintilla Message)

### Parameters
* **pixels** (int) - The minimum width in pixels.

### Response
N/A
```

```APIDOC
## SCI_GETTABMINIMUMWIDTH

### Description
Retrieves the current minimum tab width in pixels.

### Method
N/A (Scintilla Message)

### Parameters
None

### Response
* **int** - The current minimum tab width in pixels.
```

```APIDOC
## SCI_CLEARTABSTOPS

### Description
Clears all explicitly set tab stops for a given line.

### Method
N/A (Scintilla Message)

### Parameters
* **line** (line) - The line number.

### Response
N/A
```

```APIDOC
## SCI_ADDTABSTOP

### Description
Adds an explicit tab stop at a specified horizontal position for a given line.

### Method
N/A (Scintilla Message)

### Parameters
* **line** (line) - The line number.
* **x** (int) - The horizontal position (in pixels) for the tab stop.

### Response
N/A
```

```APIDOC
## SCI_GETNEXTTABSTOP

### Description
Gets the position of the next explicit tab stop on a given line at or after a specified horizontal position.

### Method
N/A (Scintilla Message)

### Parameters
* **line** (line) - The line number.
* **x** (int) - The horizontal position (in pixels) to start searching from.

### Response
* **int** - The horizontal position of the next tab stop, or -1 if none is found.
```

```APIDOC
## SCI_SETUSETABS

### Description
Configures whether the editor should use actual tab characters or spaces for indentation.

### Method
N/A (Scintilla Message)

### Parameters
* **useTabs** (bool) - True to use tabs, false to use spaces.

### Response
N/A
```

```APIDOC
## SCI_GETUSETABS

### Description
Retrieves the current setting for using tabs or spaces for indentation.

### Method
N/A (Scintilla Message)

### Parameters
None

### Response
* **bool** - True if tabs are used, false if spaces are used.
```

```APIDOC
## SCI_SETINDENT

### Description
Sets the size of indentation in columns. This is the amount added or removed when indenting or un-indenting a line.

### Method
N/A (Scintilla Message)

### Parameters
* **indentSize** (int) - The number of columns for each indentation level.

### Response
N/A
```

```APIDOC
## SCI_GETINDENT

### Description
Retrieves the current indentation size in columns.

### Method
N/A (Scintilla Message)

### Parameters
None

### Response
* **int** - The current indentation size.
```

```APIDOC
## SCI_SETTABINDENTS

### Description
Configures whether the Tab key should indent the line to the next indent position or insert a tab character.

### Method
N/A (Scintilla Message)

### Parameters
* **tabIndents** (bool) - True to indent the line, false to insert a tab character.

### Response
N/A
```

```APIDOC
## SCI_GETTABINDENTS

### Description
Retrieves the current setting for Tab key behavior regarding indentation.

### Method
N/A (Scintilla Message)

### Parameters
None

### Response
* **bool** - True if the Tab key indents the line, false otherwise.
```

```APIDOC
## SCI_SETBACKSPACEUNINDENTS

### Description
Configures whether the Backspace key should unindent the line or delete a character when at the start of a line.

### Method
N/A (Scintilla Message)

### Parameters
* **bsUnIndents** (bool) - True to unindent the line, false to delete a character.

### Response
N/A
```

```APIDOC
## SCI_GETBACKSPACEUNINDENTS

### Description
Retrieves the current setting for Backspace key behavior regarding unindentation.

### Method
N/A (Scintilla Message)

### Parameters
None

### Response
* **bool** - True if Backspace unindents the line, false otherwise.
```

```APIDOC
## SCI_SETLINEINDENTATION

### Description
Sets the indentation level for a specific line.

### Method
N/A (Scintilla Message)

### Parameters
* **line** (line) - The line number.
* **indentation** (int) - The indentation level (number of columns).

### Response
N/A
```

```APIDOC
## SCI_GETLINEINDENTATION

### Description
Retrieves the indentation level for a specific line.

### Method
N/A (Scintilla Message)

### Parameters
* **line** (line) - The line number.

### Response
* **int** - The indentation level in columns.
```

```APIDOC
## SCI_GETLINEINDENTPOSITION

### Description
Gets the horizontal position of the start of the indentation for a given line.

### Method
N/A (Scintilla Message)

### Parameters
* **line** (line) - The line number.

### Response
* **position** - The horizontal position of the indentation start.
```

```APIDOC
## SCI_SETINDENTATIONGUIDES

### Description
Configures the display of indentation guides (vertical lines indicating indentation levels).

### Method
N/A (Scintilla Message)

### Parameters
* **indentView** (int) - Controls the visibility and style of indentation guides. Values can be `SC_IV_NONE`, `SC_IV_REAL`, `SC_IV_LOOKFORWARD`.

### Response
N/A
```

```APIDOC
## SCI_GETINDENTATIONGUIDES

### Description
Retrieves the current setting for indentation guide display.

### Method
N/A (Scintilla Message)

### Parameters
None

### Response
* **int** - The current indentation guide setting.
```

```APIDOC
## SCI_SETHIGHLIGHTGUIDE

### Description
Highlights a specific indentation guide column.

### Method
N/A (Scintilla Message)

### Parameters
* **column** (position) - The column position to highlight as an indentation guide.

### Response
N/A
```

```APIDOC
## SCI_GETHIGHLIGHTGUIDE

### Description
Retrieves the position of the currently highlighted indentation guide column.

### Method
N/A (Scintilla Message)

### Parameters
None

### Response
* **position** - The column position of the highlighted guide.
```

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

### Wildcard Include Example (ClInclude)

Source: https://github.com/breecew/winuiedit/blob/main/Tools/README.md

Example of a wildcard include comment for header files in vcxproj files, used by the Vcxproj tool.

```xml
<!--<WildcardClInclude Include="path\*.h">-->
...
<!--</WildcardClInclude>-->

```

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

### Configure Indentation Guides

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaDoc.html

Control the display of indentation guides (vertical lines) to visually represent code structure. Set or retrieve the highlight guide position.

```C++
SCI_SETINDENTATIONGUIDES(int indentView)
SCI_GETINDENTATIONGUIDES → int
SCI_SETHIGHLIGHTGUIDE(position column)
SCI_GETHIGHLIGHTGUIDE → position
```

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

### Highlighting Current Indentation Guide

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaDoc.html

Functions to set and get the column for highlighting the current indentation guide.

```APIDOC
## SCI_SETHIGHLIGHTGUIDE

### Description
When brace highlighting occurs, the indentation guide corresponding to the braces may be highlighted with the brace highlighting style, STYLE_BRACELIGHT (34). Set `column` to 0 to cancel this highlight.

### Method
SCI_SETHIGHLIGHTGUIDE

### Parameters
#### Path Parameters
- **column** (position) - Description: The column to highlight the indentation guide at. Set to 0 to disable.

## SCI_GETHIGHLIGHTGUIDE

### Description
Gets the current column set for highlighting the indentation guide.

### Method
SCI_GETHIGHLIGHTGUIDE

### Response
#### Success Response (position)
- **return value** (position) - The current column for highlighting the indentation guide.
```

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

### Get Selection Nth Start

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaDoc.html

Retrieves the start position for a specific selection. The selection index is zero-based.

```C
#define SCI_GETSELECTIONNSTART (2000 + 251)
```

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

### Get Selection Nth Start Virtual Space

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaDoc.html

Retrieves the virtual space at the start of a specific selection. The selection index is zero-based.

```C
#define SCI_GETSELECTIONNSTARTVIRTUALSPACE (2000 + 252)
```

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

### SCI_GETSUBSTYLESSTART

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaDoc.html

Retrieves the starting style index for sub-styles of a given style base.

```APIDOC
## SCI_GETSUBSTYLESSTART

### Description
Retrieves the starting style index for sub-styles associated with a given style base.

### Method
SCI_GETSUBSTYLESSTART

### Parameters
#### Path Parameters
- **styleBase** (int) - Input - The base style for which to find the sub-style start index.
```

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

### Block Code Example

Source: https://github.com/breecew/winuiedit/blob/main/lexilla/test/examples/markdown/AllStyles.md

Illustrates how to format a block of code using triple backticks.

```markdown
```
Block code=21
```
```

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

### Get Technology

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaDoc.html

Retrieves the currently set drawing technology.

```c
SCI_GETTECHNOLOGY → int
```

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

### Example of Tagged Replacement

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaDoc.html

Demonstrates how tagged regions in a search regex are replaced using backreferences in the replacement string. This example shows replacing 'Fred' followed by a digit with 'Sam' followed by that same digit.

```c
Search: Fred\([1-9]\)XXX
Replace: Sam\1YYY
Applied to: Fred2XXX
Result: Sam2YYY
```

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

### SCI_AUTOCPOSSTART

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaDoc.html

Retrieves the starting position of the text when the autocompletion list was initially displayed.

```APIDOC
## SCI_AUTOCPOSSTART → position

### Description
This returns the value of the current position when `SCI_AUTOCSHOW` started display of the list.
```

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

### Comment Block Example

Source: https://github.com/breecew/winuiedit/blob/main/lexilla/test/examples/asciidoc/AllStyles.adoc

Multi-line comments are enclosed in '////'.

```asciidoc
////
Comment Block=18
////
```

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

### Get Text Visibility

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaDoc.html

Retrieves the visibility setting for a given style.

```C
SCI_STYLEGETVISIBLE(int style) -> bool
```

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

### SCI_AUTOCGETCANCELATSTART

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaDoc.html

Retrieves the current setting for cancelling the autocompletion list at the start position.

```APIDOC
## SCI_AUTOCGETCANCELATSTART

### Description
Retrieves the current setting for cancelling the autocompletion list at the start position.

### Method
Message

### Returns
- **bool** - True if the list cancels at the start position, false otherwise.
```

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

### Example of Using SetLibraryProperty

Source: https://github.com/breecew/winuiedit/blob/main/lexilla/doc/LexillaDoc.html

Shows how SetLibraryProperty can be used for lexer library initialization, such as setting a directory for definition files.

```c
SetLibraryProperty("definitions.directory", "/usr/share/xeditor/language-definitions")
```

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

### Qt Example: Loading and Using a Lexer

Source: https://github.com/breecew/winuiedit/blob/main/lexilla/doc/LexillaDoc.html

Demonstrates how to load a Lexilla shared library in a Qt application, resolve the CreateLexer function, and set the lexer for Scintilla. This approach is useful when integrating Lexilla into existing Qt projects.

```cpp
#if _WIN32 
    typedef void *(__stdcall *CreateLexerFn)(const char *name); 
#else 
    typedef void *(*CreateLexerFn)(const char *name); 
#endif 
    QFunctionPointer fn = QLibrary::resolve("lexilla", "CreateLexer"); 
    void *lexCpp = ((CreateLexerFn)fn)("cpp"); 
    Call(SCI_SETILEXER, 0, (sptr_t)(void *)lexCpp);

```

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

### Various Macro Examples

Source: https://github.com/breecew/winuiedit/blob/main/lexilla/test/examples/asciidoc/AllStyles.adoc

Demonstrates usage of different AsciiDoc macros for audio, images, links, and more.

```asciidoc
audio::Macro=23
include::Macro=23
image::Macro=23
video::Macro=23
asciimath:Macro=23
btn:Macro=23
image:Macro=23
kbd:Macro=23
latexmath:Macro=23
link:Macro=23
mailto:Macro=23
menu:Macro=23
pass:Macro=23
stem:Macro=23
xref:Macro=23
```

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

### Configure for UWP Build

Source: https://github.com/breecew/winuiedit/blob/main/Tools/README.md

Run the Uwp tool to switch the editor project configuration to build the UWP version of the control.

```bash
Uwp

```

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

### Example of Using CreateLexer

Source: https://github.com/breecew/winuiedit/blob/main/lexilla/doc/LexillaDoc.html

Illustrates the main call to create a lexer for a specific language. The returned lexer can then be set as the current lexer in Scintilla.

```c
ILexer5 *lexer = CreateLexer("cpp");
// Then set this lexer in Scintilla using SCI_SETILEXER
```

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

### Get Word Start Position in Scintilla

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaDoc.html

Returns the position of the start of the word at the given position. The behavior depends on the `onlyWordCharacters` flag.

```c
SCI_WORDSTARTPOSITION(pos, onlyWordCharacters);
```

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

### Build NuGet Packages with Versioning

Source: https://github.com/breecew/winuiedit/blob/main/Tools/README.md

Use the Package tool to build WinUI 3 and UWP variants. Specify versions for packages as needed.

```bash
Package

```

```bash
Package x.y.z

```

```bash
Package winui3

```

```bash
Package uwp:x.y.z

```

```bash
Package winui3:a.b.c uwp:x.y.z

```

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

### Adding LexillaAccess to Build Dependencies (Make Example)

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/Scintilla5Migration.html

When building applications that use LexillaAccess, ensure the header files are included and LexillaAccess.cxx is added to the source files in your build system.

```makefile
LEXILLA_DIR ?= $(srcdir)/../../lexilla
INCLUDES += -I $(LEXILLA_DIR)/include -I $(LEXILLA_DIR)/access
SOURCES += $(LEXILLA_DIR)/access/LexillaAccess.cxx
```

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

### Run Lexilla Tests with Make (GCC/Clang)

Source: https://github.com/breecew/winuiedit/blob/main/lexilla/doc/LexillaDoc.html

Execute this command in the lexilla/test directory to run the test suite with GCC or Clang.

```bash
make test
```

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

### Line Selection Position Retrieval

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaDoc.html

Functions to get the start and end positions of a selection on a specific line.

```APIDOC
## SCI_GETLINESELSTARTPOSITION

### Description
Retrieves the starting position of the selection on the specified line.

### Method
SCI_GETLINESELSTARTPOSITION

### Parameters
- **line** (int) - Required - The line number to query.

### Response
#### Success Response
- **position** (int) - The starting position of the selection on the line, or `INVALID_POSITION` if no selection on this line.

## SCI_GETLINESELENDPOSITION

### Description
Retrieves the ending position of the selection on the specified line.

### Method
SCI_GETLINESELENDPOSITION

### Parameters
- **line** (int) - Required - The line number to query.

### Response
#### Success Response
- **position** (int) - The ending position of the selection on the line, or `INVALID_POSITION` if no selection on this line.
```

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

### Configure for WinUI 3 Build

Source: https://github.com/breecew/winuiedit/blob/main/Tools/README.md

Run the WinUI3 tool to switch the editor project configuration to build the WinUI 3 version of the control.

```bash
WinUI3

```

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

### Get Start Position of a Line

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaDoc.html

Returns the document position corresponding to the beginning of a specified line. Handles negative line numbers and lines beyond the document's bounds.

```c
#define SCI_POSITIONFROMLINE(line) \
    (2000 + 7)
```

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

### Start Styling Range

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaUsage.html

Initiates the styling process for a given text range. This message is typically sent before applying individual styles.

```C
SendMessage(hwnd, SCI_STARTSTYLING, startPos, 31);
```

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

### Setting and Getting Target Range

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaDoc.html

Functions to set and retrieve the start and end positions of the target range within the document. The target range defines the area for search and replace operations.

```C
SCI_SETTARGETSTART(position start)
SCI_GETTARGETSTART → position
SCI_SETTARGETSTARTVIRTUALSPACE(position space)
SCI_GETTARGETSTARTVIRTUALSPACE → position
SCI_SETTARGETEND(position end)
SCI_GETTARGETEND → position
SCI_SETTARGETENDVIRTUALSPACE(position space)
SCI_GETTARGETENDVIRTUALSPACE → position
SCI_SETTARGETRANGE(position start, position end)
```

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

### Build Lexilla with Make (GCC/Clang)

Source: https://github.com/breecew/winuiedit/blob/main/lexilla/doc/LexillaDoc.html

Use this command to build Lexilla when using GCC or Clang.

```bash
make
```

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

### Prepare for Text Styling

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaDoc.html

Use SCI_STARTSTYLING to set the starting position for subsequent styling operations. This message must be called before using SCI_SETSTYLING or SCI_SETSTYLINGEX.

```C
SCI_STARTSTYLING(position start, int unused)
```

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

### Set Selection Nth Start

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaDoc.html

Sets the start position for a specific selection. The selection index is zero-based.

```C
#define SCI_SETSELECTIONNSTART (2000 + 250)
```

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

### Search Flags - Word Start

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaDoc.html

Restricts matches to the start of a word, based on Scintilla's definition of word characters.

```c
SCFIND_WORDSTART
```

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

### Find Matching Brace from Specific Start

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaDoc.html

Similar to SCI_BRACEMATCH, but the search for a matching brace begins at an explicitly provided start position.

```C++
SCI_BRACEMATCHNEXT(position pos, position startPos) → position
```

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

### Setting Foreground and Background Colors

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaDoc.html

Use SCI_STYLESETFORE and SCI_STYLESETBACK to define the text and background colors for a style.

```c
SCI_STYLESETFORE(int style, colour fore);
```

```c
SCI_STYLESETBACK(int style, colour back);
```

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

### Get Two-Phase Draw (Deprecated)

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaDoc.html

Deprecated function to get the current two-phase drawing mode. Consider replacing with an alternative if possible.

```C
SCI_GETTWOPHASEDRAW → bool
```

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

### Get Keys Unicode (Deprecated)

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaDoc.html

Deprecated function to get the current keys Unicode mode. Consider replacing with an alternative if possible.

```C
SCI_GETKEYSUNICODE → bool
```

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

### Example Test Failure Output

Source: https://github.com/breecew/winuiedit/blob/main/lexilla/doc/LexillaDoc.html

This is an example of a diagnostic message shown when a test case fails, indicating a difference between actual and expected results.

```text
C:\u\hg\lexilla\test\examples\python\x.py:1: is different
```

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

### Get Style Bits (Deprecated)

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaDoc.html

Deprecated function to get the number of style bits per character. Consider replacing with an alternative if possible.

```C
SCI_GETSTYLEBITS → int
```

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

### Run Lexilla Tests with NMake (MSVC)

Source: https://github.com/breecew/winuiedit/blob/main/lexilla/doc/LexillaDoc.html

Execute this command in the lexilla/test directory to run the test suite with Microsoft Visual C++.

```bash
nmake -f testlexers.mak test
```

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

### Build Lexilla with NMake (MSVC)

Source: https://github.com/breecew/winuiedit/blob/main/lexilla/doc/LexillaDoc.html

Use this command to build Lexilla when using Microsoft Visual C++.

```bash
nmake -f lexilla.mak
```

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

### Get Style Bits Needed (Deprecated)

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaDoc.html

Deprecated function to get the number of style bits needed for the current configuration. Consider replacing with an alternative if possible.

```C
SCI_GETSTYLEBITSNEEDED → int
```

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

### Create and Apply Lexer (C++)

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/Scintilla5Migration.html

Creates a lexer instance using its name and applies it to a Scintilla instance. The lexer name can be determined dynamically.

```cpp
std::string lexerName = "cpp";
Scintilla::ILexer5 *pLexer = Lexilla::MakeLexer(lexerName);
CallScintilla(scintilla, SCI_SETILEXER, 0, pLexer);
```

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

### Get End of Styled Text Position

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaDoc.html

Use SCI_GETENDSTYLED to get the position of the last character likely to be styled correctly. This is useful for determining where styling needs to begin.

```C
SCI_GETENDSTYLED -> position
```

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

### Mako Loop Context Example

Source: https://github.com/breecew/winuiedit/blob/main/lexilla/test/examples/hypertext/mako.html

Demonstrates accessing loop context variables like 'index' within a for loop.

```html
% for a in ("one", "two", "three"):
*   Item ${loop.index}: ${a}
% endfor
```

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

### C++ Naming Conventions

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/SciCoding.html

Shows the naming conventions for C++ identifiers in Scintilla, distinguishing between class/function/method names (starting with uppercase) and variable names (starting with lowercase). It also illustrates the use of '::' for global scope.

```C++
class StorageZone {  
public: 				void Store(const char *s) { 								Media *mediaStore = ::GetBaseMedia(zoneDefault); 								for (int i=mediaStore->cursor; mediaStore[i], i++) { 												mediaStore->Persist(s[i]); 								} 				}  
};
```

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

### SCI_COLOURISE

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaDoc.html

Styles the document between the specified start and end positions.

```APIDOC
## SCI_COLOURISE

### Description
Requests the current lexer or the container (if the lexer is set to `NULL`) to style the document between `start` and `end`. If `end` is -1, the document is styled from `start` to the end. If the `"fold"` property is set to `"1"` and your lexer or container supports folding, fold levels are also set. This message causes a redraw.

### Method
SCI_COLOURISE

### Parameters
#### Path Parameters
- **start** (position) - Input - The starting position for styling.
- **end** (position) - Input - The ending position for styling. If -1, styles to the end of the document.
```

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

### Starting Macro Recording

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaDoc.html

This message turns on macro recording mode. Actions performed while recording are reported to the container via SCN_MACRORECORD notifications.

```C++
SCI_STARTRECORD
```

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

### Initialize Diff Editor

Source: https://github.com/breecew/winuiedit/blob/main/Tools/Diff/template.html

Configures the Monaco Editor to use the diff editor. Requires the Monaco editor core to be loaded.

```javascript
require.config({
  paths: {
    vs: '../Diff/monaco/min/vs',
  },
});

require(['vs/editor/editor.main'], function () {
  const diffEditor = monaco.editor.createDiffEditor(document.getElementById('container'), {
    readOnly: true,
    ignoreTrimWhitespace: false,
  });

  diffEditor.setModel({
    original: monaco.editor.createModel('{original}', 'cpp'),
    modified: monaco.editor.createModel('{modified}', 'cpp'),
  });
});
```

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

### Create New Document

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaDoc.html

Creates a new, empty document with a specified initial memory allocation. The caller gains ownership and must manage the document's reference count.

```c
SCI_CREATEDOCUMENT(position bytes, int documentOptions)
```

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

### Get Caret Style

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaDoc.html

Retrieves the current style of the caret.

```C++
SCI_GETCARETSTYLE → int
```

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

### SCI_GETDRAGDROPENABLED

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaDoc.html

Gets the flag controlling whether drag-and-drop is enabled.

```APIDOC
## SCI_GETDRAGDROPENABLED

### Description
Gets the flag controlling whether drag-and-drop is enabled or not.

### Method
SCI_GETDRAGDROPENABLED

### Return Value
- bool: True if drag-and-drop is enabled, false otherwise.
```

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

### Include System Header for Shared Objects (C)

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/Scintilla5Migration.html

Includes the appropriate system header for loading shared libraries, which is <windows.h> on Windows and <dlfcn.h> on Unix-like systems.

```c
#include <windows.h>
```

```c
#include <dlfcn.h>
```

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

### Get Bidirectional Text

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaDoc.html

Retrieves the current bidirectional text setting.

```c
SCI_GETBIDIRECTIONAL → int
```

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

### Admonition Macro Examples

Source: https://github.com/breecew/winuiedit/blob/main/lexilla/test/examples/asciidoc/AllStyles.adoc

Shows AsciiDoc macros for common admonition blocks like CAUTION, IMPORTANT, NOTE, TIP, and WARNING.

```asciidoc
CAUTION:Macro=23
IMPORTANT:Macro=23
NOTE:Macro=23
TIP:Macro=23
WARNING:Macro=23
```

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

### Get IME Interaction

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaDoc.html

Retrieves the current IME interaction setting.

```c
SCI_GETIMEINTERACTION → int
```

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

### Setting Margin Options

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaDoc.html

Configures options for margins, such as sub-line selection for wrapped lines. Use bit flags.

```c
SCI_SETMARGINOPTIONS(int marginOptions)
```

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

### Setting and Getting Search Flags

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaDoc.html

Allows configuration of search behavior, such as enabling case sensitivity or regular expression matching, for subsequent search operations.

```C
SCI_SETSEARCHFLAGS(int searchFlags)
SCI_GETSEARCHFLAGS → int
```

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

### Get Code Page

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaDoc.html

Retrieves the current code page setting.

```c
SCI_GETCODEPAGE → int
```

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

### Mako Include Tag

Source: https://github.com/breecew/winuiedit/blob/main/lexilla/test/examples/hypertext/mako.html

Example of using the <%include/> tag to embed content from another template file.

```html
<%include file="foo.txt"/>
```

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

### Get Font Quality

Source: https://github.com/breecew/winuiedit/blob/main/scintilla/doc/ScintillaDoc.html

Retrieves the current font quality setting.

```c
SCI_GETFONTQUALITY → int
```