Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
web:syntaxeditor [2018/06/28 18:47]
agcyphers [Properties]
web:syntaxeditor [2019/10/23 05:53] (current)
Line 185: Line 185:
 ==== Events ==== ==== Events ====
 ^ Definition ​     ^ Description ​      ^ ^ Definition ​     ^ Description ​      ^
-| BreakpointCleared( Row as [[http://​developer.xojo.com/​integer|Integer]] ) | Raised when the user clears a breakpoint by clicking on the line number gutter. | +| BreakpointCleared( Row as Integer ) | Raised when the user clears a breakpoint by clicking on the line number gutter. | 
-| BreakpointSet( Row as [[http://​developer.xojo.com/​integer|Integer]] ) | Raised when the user sets a breakpoint by clicking on the line number gutter. |+| BreakpointSet( Row as Integer ) | Raised when the user sets a breakpoint by clicking on the line number gutter. |
 | SelChange() | Fires when the user changes their selection, either by using the mouse or the keyboard. | | SelChange() | Fires when the user changes their selection, either by using the mouse or the keyboard. |
 | TextChange() | Fires when the user changes the text within the syntax editor. | | TextChange() | Fires when the user changes the text within the syntax editor. |
Line 193: Line 193:
 ==== Methods ==== ==== Methods ====
 ^ Definition ​     ^ Description ​      ^ ^ Definition ​     ^ Description ​      ^
-| AnnotationAdd( Row as [[http://​developer.xojo.com/​integer|Integer]], theText as [[http://​developer.xojo.com/​string|String]], theType as [[http://​developer.xojo.com/​string|String]] ) | This method will add an annotation icon with informational tooltip to the left of the line numbers in the gutter of the Row specified. | +| AnnotationAdd( Row as Integer, theText as String, theType as String ) | 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 [[http://​developer.xojo.com/​integer|Integer]] ) | Remove any annotation on Row. |+| AnnotationRemove( Row as Integer ) | Remove any annotation on Row. |
 | AnnotationRemoveAll() | Remove all annotations. | | AnnotationRemoveAll() | Remove all annotations. |
-| BreakpointAdd( Row as [[http://​developer.xojo.com/​integer|Integer]] ) | Add a breakpoint to Row. | +| BreakpointAdd( Row as Integer ) | Add a breakpoint to Row. | 
-| BreakpointRemove( Row as [[http://​developer.xojo.com/​integer|Integer]] ) | Remove breakpoint from Row. | +| BreakpointRemove( Row as Integer ) | Remove breakpoint from Row. | 
-| BreakpointRemoveAll( Row as [[http://​developer.xojo.com/​integer|Integer]] ) | Remove all breakpoints from the current document. |+| BreakpointRemoveAll( Row as Integer ) | Remove all breakpoints from the current document. |
 | DeselectAll() | Deselect all text in the current document. | | DeselectAll() | Deselect all text in the current document. |
-| Find( theText as [[http://​developer.xojo.com/​string|String]], intStartPosition as [[http://​developer.xojo.com/​integer|Integer]] = 0, blnBackward as [[http://​developer.xojo.com/​boolean|Boolean]] = false, blnWrap as [[http://​developer.xojo.com/​boolean|Boolean]] = False, blnCaseSensitive as [[http://​developer.xojo.com/​boolean|Boolean]] = False, blnWholeWord as [[http://​developer.xojo.com/​boolean|Boolean]] = False, blnRegEx as [[http://​developer.xojo.com/​boolean|Boolean]] = False, blnSkipCurrentLine as [[http://​developer.xojo.com/​boolean|Boolean]] = False ) | This starts the Find system. |+| 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 ) | This starts the Find system. |
 | FindNext() | Finds the next searched for match in the document. ​ Must follow a call to Find() | | FindNext() | Finds the next searched for match in the document. ​ Must follow a call to Find() |
 | FindPrevious() | Finds the searched for match in the document by moving backward from the current position. ​ Must follow a call to Find() | | FindPrevious() | Finds the searched for match in the document by moving backward from the current position. ​ Must follow a call to Find() |
-| GotoLine( Row as [[http://​developer.xojo.com/​integer|Integer]] ) | Automatically sets the cursor to the start of the line signified by Row. | +| GotoLine( Row as Integer ) | Automatically sets the cursor to the start of the line signified by Row. | 
-| Insert( theText as [[http://​developer.xojo.com/​string|String]] ) | Inserts theText in to the Syntax Editor at the cursor'​s current position. |+| Insert( theText as String ) | Inserts theText in to the Syntax Editor at the cursor'​s current position. |
 | Redo() | Redo an undone change to the text. | | Redo() | Redo an undone change to the text. |
-| Replace( replaceWith as [[http://​developer.xojo.com/​string|String]] ) | Replace a searched for match. ​ Must follow a call to Find() | +| Replace( replaceWith as String ) | Replace a searched for match. ​ Must follow a call to Find() | 
-| ReplaceAll( replaceWith as [[http://​developer.xojo.com/​string|String]] ) | Replace all matches for the previous search. ​ Must follow a call to Find() | +| ReplaceAll( replaceWith as String ) | Replace all matches for the previous search. ​ Must follow a call to Find() | 
-| ReplaceAll( strFind as [[http://​developer.xojo.com/​string|String]], replaceWith as [[http://​developer.xojo.com/​string|String]] ) | Replace all instances of strFind with replaceWith. |+| ReplaceAll( strFind as String, replaceWith as String ) | Replace all instances of strFind with replaceWith. |
 | ResetUndoStack() | Clears the Undo/Redo stack. ​ Useful if you are saving the document and don't want to allow reversing changes back beyond that point. | | ResetUndoStack() | Clears the Undo/Redo stack. ​ Useful if you are saving the document and don't want to allow reversing changes back beyond that point. |
-| ScrollToLine( Row as [[http://​developer.xojo.com/​integer|Integer]] ) | Scrolls Row in to the syntax editor view. |+| ScrollToLine( Row as Integer ) | Scrolls Row in to the syntax editor view. |
 | SelectAll() | Selects all text within the editor. | | SelectAll() | Selects all text within the editor. |
 | SelectionIndent() | Indents the current line. | | SelectionIndent() | Indents the current line. |
Line 217: Line 217:
 | SelectionToLowercase() | Convert all text in the current selection to lowercase. | | SelectionToLowercase() | Convert all text in the current selection to lowercase. |
 | SelectionToUppercase() | Convert all text in the current selection to uppercase. | | SelectionToUppercase() | Convert all text in the current selection to uppercase. |
-| SelectLine( Row as [[http://​developer.xojo.com/​integer|Integer]] ) | Select the line signified by Row. |+| SelectLine( Row as Integer ) | Select the line signified by Row. |
 | Undo() | Undo a user's change to the text. | | Undo() | Undo a user's change to the text. |
  
 ==== Properties ==== ==== Properties ====
 ^ Name      ^ Type       ^ Default Value       ^ Description ​      ^ ^ Name      ^ Type       ^ Default Value       ^ Description ​      ^
-| Annotations() ​| [[http://​developer.xojo.com/​dictionary|Dictionary]] | Nil | The currently applied row annotations. ​ Should not be modified directly. | +| Annotations() | Dictionary | Nil | The currently applied row annotations. ​ Should not be modified directly. | 
-| AvailableModes() ​| [[http://​developer.xojo.com/​string|String]] | Nil | The currently available syntax highlighting modes. | +| AvailableModes() | String | Nil | The currently available syntax highlighting modes. | 
-| AvailableThemes() ​| [[http://​developer.xojo.com/​string|String]] | Nil | The currently available display themes. |+| AvailableThemes() | String | Nil | The currently available display themes. |
 | CanRedo ''​Read-Only''​ | Boolean | False | If the editor can Redo a recently undone change. | | CanRedo ''​Read-Only''​ | Boolean | False | If the editor can Redo a recently undone change. |
 | CanUndo ''​Read-Only''​ | Boolean | False | If the editor can undo a recent change. | | CanUndo ''​Read-Only''​ | Boolean | False | If the editor can undo a recent change. |
-| CodeFolding ​| [[http://​developer.xojo.com/​boolean|Boolean]] | True | If True and supported by the selected Mode, code blocks will be allowed to fold by clicking an arrow on the gutter. |+| CodeFolding | Boolean | True | If True and supported by the selected Mode, code blocks will be allowed to fold by clicking an arrow on the gutter. |
 | CursorColumn ''​Read-Only''​ | Integer | 0 | The column of the document where the cursor currently resides. | | CursorColumn ''​Read-Only''​ | Integer | 0 | The column of the document where the cursor currently resides. |
 | CursorRow ''​Read-Only''​ | Integer | 0 | The row of the document where the cursor currently resides. | | CursorRow ''​Read-Only''​ | Integer | 0 | The row of the document where the cursor currently resides. |
 | FirstVisibleRow ''​Read-Only''​ | Integer | 0 | The first line that is visible in the editor'​s display. | | FirstVisibleRow ''​Read-Only''​ | Integer | 0 | The first line that is visible in the editor'​s display. |
-| FontSize ​| [[http://​developer.xojo.com/​integer|Integer]] | 0 | The size of font to use for the code in the editor. | +| FontSize | Integer | 0 | The size of font to use for the code in the editor. | 
-| HighlightActiveLine ​| [[http://​developer.xojo.com/​boolean|Boolean]] | True | Places a colored highlight over the line where the cursor resides. ​ This makes it easier for users to quickly find where they left off. |+| HighlightActiveLine | Boolean | True | 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 ''​Read-Only''​ | Integer | 0 | The last line that is visible in the editor'​s display. | | LastVisibleRow ''​Read-Only''​ | Integer | 0 | The last line that is visible in the editor'​s display. |
 | LineCount ''​Read-Only''​ | Integer | 0 | The number of lines in the current document. | | LineCount ''​Read-Only''​ | Integer | 0 | The number of lines in the current document. |
 | Mode | Modes | Modes.ABAP | The syntax highlight mode to use. | | Mode | Modes | Modes.ABAP | The syntax highlight mode to use. |
-| ReadOnly ​| [[http://​developer.xojo.com/​boolean|Boolean]] | False | If True, users will not be able to edit the contents of the field. | +| ReadOnly | Boolean | False | If True, users will not be able to edit the contents of the field. | 
-| SelEnd ​| [[http://​developer.xojo.com/​integer|Integer]] | 0 | The end position of the current selection range. | +| SelEnd | Integer | 0 | The end position of the current selection range. | 
-| SelStart ​| [[http://​developer.xojo.com/​integer|Integer]] | 0 | The start position of the current selection range. |+| SelStart | Integer | 0 | The start position of the current selection range. |
 | SelText ''​Read-Only''​ | String | ""​ | The currently selected text in the editor. | | SelText ''​Read-Only''​ | String | ""​ | The currently selected text in the editor. |
-| ShowPrintMargin ​| [[http://​developer.xojo.com/​boolean|Boolean]] | False | If True, a print margin line and color differentiation will be display along the left-side corresponding to the width of a 8.5x11 sheet. | +| ShowPrintMargin | Boolean | False | If True, a print margin line and color differentiation will be display along the left-side corresponding to the width of a 8.5x11 sheet. | 
-| SoftTabs ​| [[http://​developer.xojo.com/​boolean|Boolean]] | True | Pass true to enable the use of soft tabs. Soft tabs means you're using spaces instead of the tab character. | +| SoftTabs | Boolean | True | Pass true to enable the use of soft tabs. Soft tabs means you're using spaces instead of the tab character. | 
-| SyntaxChecker ​| [[http://​developer.xojo.com/​boolean|Boolean]] | True | Pass true to enable basic syntax checking for supported languages. ​ Note that while this is enabled, if there is an error in the code then annotations will be hidden in order to display only those errors which need to be resolved. | +| SyntaxChecker | Boolean | True | Pass true to enable basic syntax checking for supported languages. ​ Note that while this is enabled, if there is an error in the code then annotations will be hidden in order to display only those errors which need to be resolved. | 
-| Text | [[http://​developer.xojo.com/​string|String]] | ""​ | Get/Set the current text of the document, as a whole. |+| Text | String | ""​ | Get/Set the current text of the document, as a whole. |
 | Theme | Themes | Themes.Ambiance | The theme used to display the syntax editor. | | Theme | Themes | Themes.Ambiance | The theme used to display the syntax editor. |
-| WordWrap ​| [[http://​developer.xojo.com/​boolean|Boolean]] | False | Sets whether or not line wrapping is enabled. |+| WordWrap | Boolean | False | Sets whether or not line wrapping is enabled. |
  
 ==== Examples ==== ==== Examples ====
 There are currently no examples for this class. There are currently no examples for this class.