GRAFFITISYNTAXEDITOR - GRAFFITISUITE DOCS

# GraffitiSyntaxEditor Class Inherits GraffitiWebUIControl ## About GraffitiSyntaxEditor is a full featured code and text editor component with support for 34 themes, 142 languages (modes), and the following features: ## Compatibility ### Framework API Version | 1.0 | 2.0 | | :---: | :---: | | True | True | ### Web | 32-Bit | 64-Bit | | :---: | :---: | | True | True | ## Enumerations | Name | Value | Description | | --- | :---: | --- | | AnnotationTypes | Info Warning Error | | | Modes | ABAP ABC ActionScript ADA ApacheConf AppleScript ASCIIDoc AssemblyX86 AutoHotKey BatchFile Bro C_CPP C9Search Cirru Clojure Cobol CoffeeScript ColdFusion CSharp CSS Curly D Dart Diff Django DockerFile Dot Drools Eiffel EJS Elixir Elm ERLang Forth Fortran FTL GCode Gherkin GitIgnore GLSL Gobstones GOLang Groovy HAML Handlebars Haskell HaskellCabal Haxe HJSON HTML HTMLElixir HTMLRuby INI IO Jack Jade Java JavaScript JSON JSONIQ JSP JSX Julia Kotlin LaTeX Lean LESS Liquid LISP Live_Script LiveScript LogIQL LSL LUA LUAPage Lucene MakeFile Markdown Mask MatLab Maze Mel MIPS_Assembler MIPSAssembler MushCode MySQL Nix NSIS ObjectiveC OCAML Pascal Perl PGSQL PHP PlainText PowerShell Praat Prolog Properties Protobuf Python R Razor RDoc RHTML RST Ruby Rust SASS SCAD Scala Scheme SCSS SH SJS Smarty Snippets SoyTemplate Space SQL SQLServer Stylus SVG Swift Swig TCL Tex Text Textile TOML TSX Twig TypeScript Vala VBScript Velocity Verilog VHDL Wollok XML Xojo XQuery YAML | | | Themes | Ambiance Chaos Chrome Clouds CloudsMidnight Cobalt CrimsonEditor Dawn Dreamweaver Eclipse GitHub IdleFingers iPlastic Katzenmilch KRTheme Kuroir Merbivore MerbivoreSoft MonoIndustrial Monokai PastelOnDark SolarizedDark SolarizedLight SQLServer Terminal TextMate Tomorrow TomorrowNight TomorrowNightBlue TomorrowNightBright TomorrowNightEighties Twilight VibrantInk XCode | | ## Event Definitions | Name | Parameters | Return Type | Description | | --- | :---: | :---: | --- | | BreakpointCleared | Row as Integer | (None) | Raised when the user clears a breakpoint by clicking on the line number gutter. | | BreakpointSet | Row as Integer | (None) | Raised when the user sets a breakpoint by clicking on the line number gutter. | | ContextClick | X as Integer Y as Integer CtrlKey as Boolean ShiftKey as Boolean | (None) | Raised when the user right-clicks or long-presses the editor. | | HTMLRendered | content as String | (None) | Raised when the content is returned after calling the ToHTML method. | | Open | (None) | (None) | | | Ready | (None) | (None) | Raised when the control is ready for interaction. | | SelChange | (None) | (None) | Fires when the user changes their selection, either by using the mouse or the keyboard. | | Shown | (None) | (None) | | | TextChange | (None) | (None) | Fires when the user changes the text within the syntax editor. | | UndoManager | (None) | (None) | This event signals a change in the CanUndo and CanRedo properties, allowing for dynamic menu enabling/disabling based on state. | ## Methods | Name | Parameters | Return Type | Description | | --- | :---: | :---: | --- | | AnnotationAdd | Row as Integer theText as String theType as AnnotationTypes | (None) | This method will add an annotation icon with informational tooltip to the left of the line numbers in the gutter of the Row specified. | | AnnotationRemove | Row as Integer | (None) | Remove any annotation on Row. | | AnnotationRemoveAll | (None) | (None) | Remove all annotations. | | BreakpointAdd | Row as Integer | (None) | Add a breakpoint to Row. | | BreakpointRemove | Row as Integer | (None) | Remove breakpoint from Row. | | BreakpointRemoveAll | (None) | (None) | Remove all breakpoints from the current document. | | DeselectAll | (None) | (None) | Deselect all text in the current document. | | Find | theText as String intStartPosition as Integer = 0 blnBackward as Boolean = false blnWrap as Boolean = False blnCaseSensitive as Boolean = False blnWholeWord as Boolean = False blnRegEx as Boolean = False blnSkipCurrentLine as Boolean = False | (None) | This starts the Find system. | | FindNext | (None) | (None) | Finds the next searched for match in the document. Must follow a call to Find() | | FindPrevious | (None) | (None) | Finds the searched for match in the document by moving backward from the current position. Must follow a call to Find() | | GotoLine | theLine as Integer | (None) | Automatically sets the cursor to the start of the line signified by Row. | | Insert | theText as String | (None) | Inserts theText in to the Syntax Editor at the cursor's current position. | | Redo | (None) | (None) | Redo an undone change to the text. | | Replace | replaceWith as String | (None) | Replace a searched for match. Must follow a call to Find() | | ReplaceAll | strReplace as String | (None) | Replace all matches for the previous search. Must follow a call to Find() | | ReplaceAll | strFind as String strReplace as String | (None) | Replace all matches for the previous search. Must follow a call to Find() | | ResetUndoStack | (None) | (None) | Clears the Undo/Redo stack. Useful if you are saving the document and don't want to allow reversing changes back beyond that point. | | Resize | (None) | (None) | | | ScrollToLine | Row as Integer | (None) | Scrolls Row in to the syntax editor view. | | SelectAll | (None) | (None) | Selects all text within the editor. | | SelectionIndent | (None) | (None) | Indents the current line. | | SelectionOutdent | (None) | (None) | Outdents the current line. | | SelectionToggleComment | (None) | (None) | Toggles comment on the current line. | | SelectionToLowercase | (None) | (None) | Convert all text in the current selection to lowercase. | | SelectionToUppercase | (None) | (None) | Convert all text in the current selection to uppercase. | | SelectLine | Row as Integer | (None) | Select the line signified by Row. | | SetFocus | (None) | (None) | | | ToHTML | includeCSS as Boolean = True | (None) | Signals the client to convert the content to styled HTML and send it back to the server. HTMLRendered event will be raised upon receipt. | | Undo | (None) | (None) | Undo a user's change to the text. | ## Properties | Name | Type | Default Value | Description | | --- | :---: | :---: | --- | | Annotations() | Dictionary | Nil | The currently applied row annotations. Should not be modified directly. | | AvailableModes() | String | Nil | The currently available syntax highlighting modes. | | AvailableThemes() | String | Nil | The currently available display themes. | | CanRedo | Boolean | Nil | If the editor can Redo a recently undone change. | | CanUndo | Boolean | Nil | If the editor can undo a recent change. | | CodeFolding | Boolean | Nil | If True and supported by the selected Mode, code blocks will be allowed to fold by clicking an arrow on the gutter. | | CursorColumn | Integer | Nil | The column of the document where the cursor currently resides. | | CursorRow | Integer | Nil | The row of the document where the cursor currently resides. | | FirstVisibleRow | Integer | Nil | The first line that is visible in the editor's display. | | FontFamily | String | Nil | Font family used for code within the editor. | | FontSize | Integer | Nil | The size of font to use for the code in the editor. | | HighlightActiveLine | Boolean | Nil | Places a colored highlight over the line where the cursor resides. This makes it easier for users to quickly find where they left off. | | LastVisibleRow | Integer | Nil | The last line that is visible in the editor's display. | | LineCount | Integer | Nil | The number of lines in the current document. | | Mode | String | Nil | The syntax highlight mode to use. | | ReadOnly | Boolean | Nil | If True, users will not be able to edit the contents of the field. | | SelEnd | Integer | Nil | The end position of the current selection range. | | SelStart | Integer | Nil | The start position of the current selection range. | | SelText | String | Nil | The currently selected text in the editor. | | ShowGutter | Boolean | Nil | Controls visibility of the left-hand editor gutter containing line numbers and collapsible section controllers. | | ShowIndentGuides | Boolean | Nil | Controls the display of indentation guides. | | ShowInvisibles | Boolean | Nil | Controls the display of invisible characters. | | ShowPrintMargin | Boolean | Nil | If True, a print margin line and color differentiation will be display along the left-side corresponding to the width of a 8.5×11 sheet. | | SoftTabs | Boolean | Nil | Pass true to enable the use of soft tabs. Soft tabs means you're using spaces instead of the tab character. | | SyntaxChecking | Boolean | Nil | Controls whether the component will check syntax for errors. | | Text | String | Nil | Get/Set the current text of the document, as a whole. | | Theme | String | Nil | The theme used to display the syntax editor. | | WordWrap | Boolean | Nil | Sets whether or not line wrapping is enabled. |