Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
desktop:syntaxeditor [2019/06/06 22:14]
agcyphers [Methods]
desktop:syntaxeditor [2019/10/23 05:53] (current)
Line 188: Line 188:
 ==== Events ==== ==== Events ====
 ^ Definition ​     ^ Description ​      ^ ^ Definition ​     ^ Description ​      ^
-| BreakpointAdded( Row as [[http://​developer.xojo.com/​integer|Integer]] ) | Breakpoint has been added by the user. | +| BreakpointAdded( Row as Integer ) | Breakpoint has been added by the user. | 
-| BreakpointRemoved( Row as [[http://​developer.xojo.com/​integer|Integer]] ) | Breakpoint has been removed by the user. |+| BreakpointRemoved( Row as Integer ) | Breakpoint has been removed by the user. |
 | Change() | Text content has changed. | | Change() | Text content has changed. |
 | SelChange() | Selected text has changed. | | SelChange() | Selected text has changed. |
Line 195: Line 195:
 ==== Methods ==== ==== Methods ====
 ^ Definition ​     ^ Description ​      ^ ^ Definition ​     ^ Description ​      ^
-| AddAnnotation( Line as [[http://​developer.xojo.com/​integer|Integer]], theText as [[http://​developer.xojo.com/​string|String]], AnnotationType as AnnotationTypes ) | Adds an annotation to the right-hand gutter. | +| AddAnnotation( Line as Integer, theText as String, AnnotationType as AnnotationTypes ) | Adds an annotation to the right-hand gutter. | 
-| AddBreakpoint( Line as [[http://​developer.xojo.com/​integer|Integer]] ) | Adds a breakpoint. |+| AddBreakpoint( Line as Integer ) | Adds a breakpoint. |
 | CenterSelection() | Centers the currently selected text in the viewport. | | CenterSelection() | Centers the currently selected text in the viewport. |
 | ClearAnnotations() | Remove all annotations. |  | ClearAnnotations() | Remove all annotations. | 
Line 206: Line 206:
 | Delete() | Deletes the currently selected text from the content. | | Delete() | Deletes the currently selected text from the content. |
 | DeselectAll() | Deselect all text. | | DeselectAll() | Deselect all text. |
-| Find( toFind as [[http://​developer.xojo.com/​string|String]], Backwards as [[http://​developer.xojo.com/​boolean|Boolean]] = False, Wrap as [[http://​developer.xojo.com/​boolean|Boolean]] = False, CaseSensitive as [[http://​developer.xojo.com/​boolean|Boolean]] = False, WholeWord as [[http://​developer.xojo.com/​boolean|Boolean]] = False ) | Search for toFind in the text. | +| Find( toFind as String, Backwards as Boolean = False, Wrap as Boolean = False, CaseSensitive as Boolean = False, WholeWord as Boolean = False ) | Search for toFind in the text. | 
-| FindAll( toFind as [[http://​developer.xojo.com/​string|String]] ) | Find all instances of toFind in the text. |+| FindAll( toFind as String ) | Find all instances of toFind in the text. |
 | FindNext() | Finds the next instance of the text.  Requires there first be a Find call. | | FindNext() | Finds the next instance of the text.  Requires there first be a Find call. |
 | FindPrev() | Finds the previous instance of the text.  Requires there first be a Find call. | | FindPrev() | Finds the previous instance of the text.  Requires there first be a Find call. |
 | Fold() | Folds the currently selected block. | | Fold() | Folds the currently selected block. |
 | FoldAll() | Folds all blocks in the document. | | FoldAll() | Folds all blocks in the document. |
-| GetLine( Line as [[http://​developer.xojo.com/​integer|Integer]] ) as [[http://​developer.xojo.com/​string|String]] | Get full line text. | +| GetLine( Line as Integer ) as String | Get full line text. | 
-| GotoLine( Line as [[http://​developer.xojo.com/​integer|Integer]] ) | Go to the specified line within the text. |+| GotoLine( Line as Integer ) | Go to the specified line within the text. |
 | GotoPageDown() | Go to line one page below current selection. | | GotoPageDown() | Go to line one page below current selection. |
 | GotoPageUp() | Go to line one page above current selection. | | GotoPageUp() | Go to line one page above current selection. |
 | Indent() | Indent the current line. | | Indent() | Indent the current line. |
-| InsertLines( newLines() as [[http://​developer.xojo.com/​string|String]] ) | Insert lines at selection. | +| InsertLines( newLines() as String ) | Insert lines at selection. | 
-| InsertText( theText as [[http://​developer.xojo.com/​string|String]] ) | Insert theText at current selection. | +| InsertText( theText as String ) | Insert theText at current selection. | 
-| IsBreakpoint( Row as [[http://​developer.xojo.com/​integer|Integer]] ) as [[http://​developer.xojo.com/​boolean|Boolean]] | Determine if the specified row has a breakpoint assigned. |+| IsBreakpoint( Row as Integer ) as Boolean | Determine if the specified row has a breakpoint assigned. |
 | LoaderHide() | Hides the loading spinner. | | LoaderHide() | Hides the loading spinner. |
 | LoaderShow() | Shows a loading spinner that covers the entire component. | | LoaderShow() | Shows a loading spinner that covers the entire component. |
 | MatchingExpandTo() | Expands the current selection within matching blocks. | | MatchingExpandTo() | Expands the current selection within matching blocks. |
 | MatchingJumpTo() | Moves the cursor to the matching block element corresponding to the current selection. | | MatchingJumpTo() | Moves the cursor to the matching block element corresponding to the current selection. |
-| NavigateDown( byLines as [[http://​developer.xojo.com/​integer|Integer]] ) | Move the cursor down. |+| NavigateDown( byLines as Integer ) | Move the cursor down. |
 | NavigateEnd() | Move the cursor to the end of the document. | | NavigateEnd() | Move the cursor to the end of the document. |
-| NavigateLeft( byCharacters as [[http://​developer.xojo.com/​integer|Integer]] ) | Move the cursor left by the specified number of characters. |+| NavigateLeft( byCharacters as Integer ) | Move the cursor left by the specified number of characters. |
 | NavigateLineEnd() | Move cursor to the end of the line. | | NavigateLineEnd() | Move cursor to the end of the line. |
 | NavigateLineStart() | Move cursor to the start of the line. | | NavigateLineStart() | Move cursor to the start of the line. |
-| NavigateRight( byCharacters as [[http://​developer.xojo.com/​integer|Integer]] ) | Move the cursor right by the specified number of characters. |+| NavigateRight( byCharacters as Integer ) | Move the cursor right by the specified number of characters. |
 | NavigateStart() | Move the cursor to the start of the document. | | NavigateStart() | Move the cursor to the start of the document. |
-| NavigateTo( Row as [[http://​developer.xojo.com/​integer|Integer]], Column as [[http://​developer.xojo.com/​integer|Integer]] ) | Move cursor to specified position. | +| NavigateTo( Row as Integer, Column as Integer ) | Move cursor to specified position. | 
-| NavigateUp( byLines as [[http://​developer.xojo.com/​integer|Integer]] ) |  Move the cursor up by the specified number of lines. |+| NavigateUp( byLines as Integer ) |  Move the cursor up by the specified number of lines. |
 | NavigateWordLeft() | Move cursor one word to the left. | | NavigateWordLeft() | Move cursor one word to the left. |
 | NavigateWordRight() | Move cursor one word to the right. | | NavigateWordRight() | Move cursor one word to the right. |
Line 239: Line 239:
 | PrintDocument( Title as String, Theme as Themes, WordWrap as Boolean = True ) as FolderItem | Creates a printable format file for the content, then launches the browser to automatically print. Returns a FolderItem in case you wish to retain a copy. | | PrintDocument( Title as String, Theme as Themes, WordWrap as Boolean = True ) as FolderItem | Creates a printable format file for the content, then launches the browser to automatically print. Returns a FolderItem in case you wish to retain a copy. |
 | Redo() | Redo an undone change. | | Redo() | Redo an undone change. |
-| RemoveAnnotation( Line as [[http://​developer.xojo.com/​integer|Integer]] ) | Removes an annotation from the specified line. | +| RemoveAnnotation( Line as Integer ) | Removes an annotation from the specified line. | 
-| RemoveBreakpoint( Line as [[http://​developer.xojo.com/​integer|Integer]] ) | Removes a breakpoint from the specified line. | +| RemoveBreakpoint( Line as Integer ) | Removes a breakpoint from the specified line. | 
-| Replace( replaceWith as [[http://​developer.xojo.com/​string|String]] ) | Replaces instance with replaceWith. ​ Requires Find or FindAll to be called first. | +| Replace( replaceWith as String ) | Replaces instance with replaceWith. ​ Requires Find or FindAll to be called first. | 
-| ReplaceAll( replaceWith as [[http://​developer.xojo.com/​string|String]] ) | Replaces all instances with replaceWith. ​ Requires Find or FindAll to be called first. |+| ReplaceAll( replaceWith as String ) | Replaces all instances with replaceWith. ​ Requires Find or FindAll to be called first. |
 | SelectAll() | Select all text in the document. | | SelectAll() | Select all text in the document. |
 | SelectDown() | Selects down one line. | | SelectDown() | Selects down one line. |
Line 277: Line 277:
 ==== Properties ==== ==== Properties ====
 ^ Name      ^ Type       ^ Default Value       ^ Description ​      ^ ^ Name      ^ Type       ^ Default Value       ^ Description ​      ^
-| CanRedo ​| [[http://​developer.xojo.com/​boolean|Boolean]] | False | If true, there are actions in the history which can be redone. | +| CanRedo | Boolean | False | If true, there are actions in the history which can be redone. | 
-| CanUndo ​| [[http://​developer.xojo.com/​boolean|Boolean]] | False | If true, there are actions in the history which can be undone. | +| CanUndo | Boolean | False | If true, there are actions in the history which can be undone. | 
-| Content ​| [[http://​developer.xojo.com/​string|String]] | ""​ | Full content of the control. |+| Content | String | ""​ | Full content of the control. |
 | CurrentColumn | Integer(ReadOnly) | 0 | Current column of the cursor within the document. | | CurrentColumn | Integer(ReadOnly) | 0 | Current column of the cursor within the document. |
 | CurrentLine | Integer(ReadOnly) | 0 | Current line of the cursor within the document. | | CurrentLine | Integer(ReadOnly) | 0 | Current line of the cursor within the document. |
 +| FadeFoldWidgets | Boolean | True | When True, fold widgets will fade out when the block is not hovered. |
 +| FontSize | Integer | 12 | Size of the font used to display text in the viewport. |
 | Modes | Modes | Modes.ABAP | Current syntax mode, or language, of the control. | | Modes | Modes | Modes.ABAP | Current syntax mode, or language, of the control. |
-SelLength ​[[http://​developer.xojo.com/​integer|Integer]] | 0 | Length of current selection. | +PrintMarginColumn ​Integer | 80 | Width of the print margin in pixels
-| SelStart ​| [[http://​developer.xojo.com/​integer|Integer]] | 0 | Starting point of current selection. | +| SelLength ​| Integer | 0 | Length of current selection. | 
-| SelText ​| [[http://​developer.xojo.com/​string|String]] | ""​ | Currently selected text. | +| SelStart | Integer | 0 | Starting point of current selection. | 
-ShowLoaderOnEvents ​[[http://​developer.xojo.com/boolean|Boolean]] | False | If true, the loading spinner will be shown to denote that the control is busy when communicating. | +| SelText | String | ""​ | Currently selected text. | 
-TabSize ​[[http://​developer.xojo.com/​integer|Integer]] | 4 | Length, in characters, of an indent/​outdent/​tab. |+ShowFoldWidget ​Boolean | True | When True, disclosure triangles are drawn in the left gutter for blocks
 +| ShowInvisible | Boolean | False | When True, invisible characters are made visible in the viewport
 +| ShowLoaderOnEvents ​| Boolean | False | If true, the loading spinner will be shown to denote that the control is busy when communicating. | 
 +ShowPrintMargin ​Boolean | True | When True, the print margin is displayed on the right side
 +| TabSize ​| Integer | 4 | Length, in characters, of an indent/​outdent/​tab. |
 | Theme | Themes | Themes.Ambiance | The visual style of the editor, including colors for syntax hightlighting. | | Theme | Themes | Themes.Ambiance | The visual style of the editor, including colors for syntax hightlighting. |
-| WordWrap ​| [[http://​developer.xojo.com/​boolean|Boolean]] | False | When true long lines will wrap down the next line. |+| WordWrap | Boolean | False | When true long lines will wrap down the next line. |
  
 ==== Examples ==== ==== Examples ====
 There are currently no examples for this class. There are currently no examples for this class.