Welcome
Scin
0.1.0.0
This is a helper plugin for the Scintilla plugin by Reteset.
The XML action file for this plugin, and the help file, were created with AMS Action File Editor v1.0.0.6 by Dean Hall (AKA) RizlaUK, www.dnet-software.com
This plugin was compiled with the Action Plugin Compiler Version 1.1.0.0 developed by Reteset and Dermot and MicroByte: www.amsplugins.com and www.fitzsolutions.com
free
JimS
You must have Reteset’s Scintilla plugin installed and added to your project, before this will work.
2011
Place the "Scin" folder in your "AutoPlay Media Studio\Plugins\Action" folder.
Scin.Allocate
Scin.BraceBadLight
Scin.BraceHighLight
Scin.BraceMatch
Scin.CanRedo
Scin.CanUndo
Scin.Clear
Scin.ClearAll
Scin.ClearDocumentStyle
Scin.ClearUndoBuffer
Scin.Copy
Scin.Cut
Scin.GetAnchor
Scin.GetCharAt
Scin.GetCurrentLine
Scin.GetCurrentLinePos
Scin.GetCurrentPos
Scin.GetLength
Scin.GetLine
Scin.GetLineCount
GetLineEndPos
Scin.GetLineFromPos
Scin.GetLineLength
Scin.GetModify
Scin.GetOvertype
Scin.GetPosFromLine
Scin.GetReadOnly
Scin.GetSelectedEnd
Scin.GetSelectedLength
Scin.GetSelectedStart
Scin.GetText
Scin.GetStatus
Scin.GetZoom
Scin.GoToLine
Scin.GoToPos
Scin.InsertText
Scin.LinesOnScreen
Scin.MoveCaretInsideView
Scin.Paste
Scin.Redo
Scin.ResetStatus
Scin.ReplaceSelected
Scin.SelectAll
Scin.SetAnchor
Scin.SetCurrentPos
Scin.SetOvertype
Scin.SetReadOnly
Scin.SetSavePoint
Scin.SetSelected
Scin.SetText
Scin.SetZoom
Scin.Undo
Scin.ZoomIn
Scin.ZoomOut
Scin.Allocate ( | (string) ObjectName = "Plugin1", (number) TabID = 100, (number) iBytes = 0 ) |
Allocate a document buffer large enough to store a given number of bytes
Note: The document will not be made smaller than its current contents.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(number) The number of bytes to allocate.
This action dose not return any value.
Scin.BraceBadLight ( | (string) ObjectName = "Plugin1", (number) TabID = 100, (number) iPos = 1 ) |
Allows you to set a brace to the bad brace style.
Note: If there is no matching brace then the brace badlighting style, style STYLE_BRACEBAD (35), can be used to show the brace that is unmatched. Using a position of INVALID_POSITION (-1) removes the highlight.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(number) The position of the brace
This action dose not return any value.
Scin.BraceHighLight ( | (string) ObjectName = "Plugin1", (number) TabID = 100, (number) iPos = 1, (number) iPos2 ) |
Up to two characters can be highlighted in a 'brace highlighting style', which is defined as style number STYLE_BRACELIGHT (34). If you have enabled indent guides, you may also wish to highlight the indent that corresponds with the brace. You can locate the column with SCI_GETCOLUMN and highlight the indent with SCI_SETHIGHLIGHTGUIDE
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(number) The position of the brace
(number) Position of second brace.
This action dose not return any value.
(number) Scin.BraceMatch ( | (string) ObjectName = "Plugin1", (number) TabID = 100, (number) iPos = 1 ) |
This action finds a corresponding matching brace given pos, the position of one brace.
Note: The brace characters handled are '(', ')', '[', ']', '{', '}', '<', and '>'. The search is forwards from an opening brace and backwards from a closing brace. If the character at position is not a brace character, or a matching brace cannot be found, the return value is -1. Otherwise, the return value is the position of the matching brace.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(number) The position of the brace.
(number) The position of the corresponding matching brace.
(boolean) Scin.CanRedo ( | (string) ObjectName = "Plugin1", (number) TabID = 100 ) |
Returns a boolean. Returns false if there is no action to redo and true if there are undo actions to redo. You could typically use the result of this message to enable/disable the Edit menu Redo command.
Note: You could typically use the result of this message to enable/disable the Edit menu Redo command.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(boolean) Returns false if there is no action to redo and true if there are undo actions to redo.
(boolean) Scin.CanUndo ( | (string) ObjectName = "Plugin1", (number) TabID = 100 ) |
Returns a boolean. Returns false if there is no action to undo and true if there is. You would typically use the result of this message to enable/disable the Edit menu Undo command.
Note: You would typically use the result of this message to enable/disable the Edit menu Undo command.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(boolean) Returns false if there is no action to undo and true if there is.
Scin.Clear ( | (string) ObjectName = "Plugin1", (number) TabID = 100 ) |
Clear selected text from document.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
This action dose not return any value.
Scin.ClearAll ( | (string) ObjectName = "Plugin1", (number) TabID = 100 ) |
Unless the document is read-only, this deletes all the text.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
This action dose not return any value.
Scin.ClearDocumentStyle ( | (string) ObjectName = "Plugin1", (number) TabID = 100 ) |
When wanting to completely restyle the document, for example after choosing a lexer, this action can be used to clear all styling information and reset the folding state.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
This action dose not return any value.
Scin.ClearUndoBuffer ( | (string) ObjectName = "Plugin1", (number) TabID = 100 ) |
This command tells Scintilla to forget any saved undo or redo history. It also sets the save point to the start of the undo buffer, so the document will appear to be unmodified.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
This action dose not return any value.
Scin.Copy ( | (string) ObjectName = "Plugin1", (number) TabID = 100 ) |
Copy selected text from document to clipboard.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
This action dose not return any value.
Scin.Cut ( | (string) ObjectName = "Plugin1", (number) TabID = 100 ) |
Cut selected text from document.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
This action dose not return any value.
(number) Scin.GetAnchor ( | (string) ObjectName = "Plugin1", (number) TabID = 100 ) |
Returns the current anchor position as a number.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(number) The current anchor position as a number.
(string) Scin.GetCharAt ( | (string) ObjectName = "Plugin1", (number) TabID = 100, (number) iPos ) |
Returns the character at pos in the document as a string. If pos is negative or past the end of the document 0 will be returned. Remember that Position starts at 0
Note: Remember that Position starts at 0
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(number) The position of the character to return
(string) Returns the character at pos in the document as a string. If pos is negative or past the end of the document 0 will be returned.
(string) Scin.GetCurrentLine ( | (string) ObjectName = "Plugin1", (number) TabID = 100 ) |
Returns the text of the current line.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(string) Returns the text of the current line.
(number) Scin.GetCurrentLinePos ( | (string) ObjectName = "Plugin1", (number) TabID = 100 ) |
Returns the current caret position in the current line, as a number.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(number) Returns the current caret position in the current line, as a number.
(number) Scin.GetCurrentPos ( | (string) ObjectName = "Plugin1", (number) TabID = 100 ) |
Returns the current caret position of a specific tab, as a number.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(number) Returns the current caret position in a specific tab, as a number.
(number) Scin.GetLength ( | (string) ObjectName = "Plugin1", (number) TabID = 100 ) |
Returns the length of text in a specified tab as a number.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(number) Returns the length of text in a specified tab as a number. This number includes any non visible line endings. In this way, an empty line will generally return a length of 2.
(string) Scin.GetLine ( | (string) ObjectName = "Plugin1", (number) TabID = 100, (number) iLineNumber ) |
Returns the text of the specified line as a string (lines start at 0).
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(number) The line number to get. Remember line count starts at 0.
(string) Returns the text of the specified line as a string (lines start at 0). This string includes the line ending characters. In most cases you will want to trim the right most two characters before you use this string. If you ask for a line number outside the range of lines in the document, 0 characters are copied.
(number) Scin.GetLineCount ( | (string) ObjectName = "Plugin1", (number) TabID = 100 ) |
Returns the number of lines in the document.
Note: An empty document contains 1 line. A document holding only an end of line sequence has 2 lines.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(number) Returns the number of lines in the document.
(number) GetLineEndPos ( | (string) ObjectName = "Plugin1", (number) TabID = 100, (number) iLineNumber ) |
This returns the position at the end of the line, before any line end characters.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(number) The line number to find the end position for.
(number) This returns the position at the end of the line, before any line end characters. If line is the last line in the document (which does not have any end of line characters), the result is the size of the document. If line is negative or line >= Scin.GetLineCount(), the result is undefined.
(number) Scin.GetLineFromPos ( | (string) ObjectName = "Plugin1", (number) TabID = 100, (number) iPos ) |
This action returns the line (as a number) that contains the position iPos in the document.
Note: Remember that line counts start at 0.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(number) The position in the document to find the line number for.
(number) This action returns the line (as a number) that contains the position iPos in the document. The return value is 0 if pos <= 0. The return value is the last line if pos is beyond the end of the document.
(number) Scin.GetLineLength ( | (string) ObjectName = "Plugin1", (number) TabID = 100, (number) iLineNumber ) |
Returns the number of characters in the specified line as a number.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(number) The line you want the lenght of.
(number) Returns the number of characters in the specified line as a number. Remember, line numbers start at 0. This return number includes non visible line endings. Generally line endings are two characters in length.
(boolean) Scin.GetModify ( | (string) ObjectName = "Plugin1", (number) TabID = 100 ) |
Returns the modified status of a document as a boolean.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(boolean) Returns a boolean. True if the document is modified and false if it is unmodified. The modified status of a document is determined by the undo position relative to the save point. The save point is set by Scin.SetSavePoint, usually when you have saved data to a file.
(boolean) Scin.GetOvertype ( | (string) ObjectName = "Plugin1", (number) TabID = 100 ) |
Returns true if overtyping is active, otherwise false will be returned.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(boolean) Returns a boolean. Returns true if overtyping is active, otherwise false will be returned.
(number) Scin.GetPosFromLine ( | (string) ObjectName = "Plugin1", (number) TabID = 100, (number) iLineNumber ) |
This returns the document position that corresponds with the start of the line.
Note: Remember that line counts start at 0.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(number) The line number to get the position from.
Note: Remember that lines start at 0.
(number) This returns the document position that corresponds with the start of the line. If line is negative, the position of the line holding the start of the selection is returned. If line is greater than the lines in the document, the return value is -1. If line is equal to the number of lines in the document (i.e. 1 line past the last line), the return value is the end of the document.
(boolean) Scin.GetReadOnly ( | (string) ObjectName = "Plugin1", (number) TabID = 100 ) |
Returns the read-only flag for the document as a boolean.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(boolean) Returns the read-only flag for the document as a boolean.
(number) Scin.GetSelectedEnd ( | (string) ObjectName = "Plugin1", (number) TabID = 100 ) |
Returns the position of the end of the selection, as a number.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(number) Returns the position of the end of the selection, as a number.
(number) Scin.GetSelectedLength ( | (string) ObjectName = "Plugin1", (number) TabID = 100 ) |
Returns the length currently selected text and a terminating 0 byte as number.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(number) Returns the length currently selected text and a terminating 0 byte as number.
(number) Scin.GetSelectedStart ( | (string) ObjectName = "Plugin1", (number) TabID = 100 ) |
Returns the position of the start of the selection, as a number.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(number) Returns the position of the start of the selection, as a number.
(string) Scin.GetText ( | (string) ObjectName = "Plugin1", (number) TabID = 100 ) |
Returns all of the text from a specified tab as a string.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(string) Returns all of the text from a specified tab as a string.
(number) Scin.GetStatus ( | (string) ObjectName = "Plugin1", (number) TabID = 100 ) |
If an error occurs, Scintilla may set an internal error number that can be retrieved with this action.
Note: The currently defined statuses are: 0 No failures, 1 Generic failure, 2 Memory is exhausted.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(number) If an error occurs, Scintilla may set an internal error number that can be retrieved with this action. To clear the error status call Scin.ResetStatus.
(number) Scin.GetZoom ( | (string) ObjectName = "Plugin1", (number) TabID = 100 ) |
Returns the current zoom factor of a specified tab as a number.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(number) Returns the current zoom factor of a specified tab as a number.
Scin.GoToLine ( | (string) ObjectName = "Plugin1", (number) TabID = 100, (number) iLineNumber ) |
Removes any selection and sets the caret at the start of line number line and scrolls the view (if needed) to make it visible. The anchor position is set the same as the current position. If line is outside the lines in the document (first line is 0), the line set is the first or last.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(number) The line you want to move the caret to.
This action dose not return any value.
Scin.GoToPos ( | (string) ObjectName = "Plugin1", (number) TabID = 100, (number) iPos ) |
This removes any selection, sets the caret at pos and scrolls the view to make the caret visible, if necessary. It is equivalent to Scin.SetSelected(pos, pos). The anchor position is set the same as the current position.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(number) The position you want to move the caret to.
This action dose not return any value.
Scin.InsertText ( | (string) ObjectName = "Plugin1", (number) TabID = 100, (number) iPos, (string) sInsert = "Hello World" ) |
This inserts a text string at position pos or at the current position if pos is -1. If the current position is after the insertion point then it is moved along with its surrounding text but no scrolling is performed.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(number) The position you want to insert your string.
(string) The string you want to insert
This action dose not return any value.
(number) Scin.LinesOnScreen ( | (string) ObjectName = "Plugin1", (number) TabID = 100 ) |
This returns the number of complete lines visible on the screen.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(number) This returns the number of complete lines visible on the screen. With a constant line height, this is the vertical space available divided by the line separation. Unless you arrange to size your window to an integral number of lines, there may be a partial line visible at the bottom of the view.
Scin.MoveCaretInsideView ( | (string) ObjectName = "Plugin1", (number) TabID = 100 ) |
If the caret is off the top or bottom of the view, it is moved to the nearest line that is visible to its current position. Any selection is lost.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
This action dose not return any value.
Scin.Paste ( | (string) ObjectName = "Plugin1", (number) TabID = 100 ) |
Paste contents of clipboard to document at the position of the caret.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
This action dose not return any value.
Scin.Redo ( | (string) ObjectName = "Plugin1", (number) TabID = 100 ) |
Undoes the effect of the last Scin.Undo action.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
This action dose not return any value.
Scin.ResetStatus ( | (string) ObjectName = "Plugin1", (number) TabID = 100 ) |
Reset the Status back to 0 (OK). May be used after Scin.GetStatus
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
This action dose not return any value.
Scin.ReplaceSelected ( | (string) ObjectName = "Plugin1", (number) TabID = 100, (string) sReplaceString = "Hello World" ) |
Replace the currently selected text.
Note: If the anchor and current position are the same, the text is inserted at the caret position. The caret is positioned after the inserted text and the caret is scrolled into view.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(string) The string to replace what is selected
This action dose not return any value.
Scin.SelectAll ( | (string) ObjectName = "Plugin1", (number) TabID = 100 ) |
This selects all the text in the document
Note: The current position is not scrolled into view.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
This action dose not return any value.
Scin.SetAnchor ( | (string) ObjectName = "Plugin1", (number) TabID = 100, (number) iPos ) |
This sets the anchor position and creates a selection between the anchor position and the current position.
Note: The caret is not scrolled into view.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(number) The position to set the anchor.
This action dose not return any value.
Scin.SetCurrentPos ( | (string) ObjectName = "Plugin1", (number) TabID = 100, (number) iPos ) |
This sets the current position and creates a selection between the anchor and the current position
Note: The caret is not scrolled into view.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(number) The position to set the current position.
This action dose not return any value.
Scin.SetOvertype ( | (string) ObjectName = "Plugin1", (number) TabID = 100, (boolean) bOverType = true ) |
This sets whether Overtype is set or not.
Note: When overtype is enabled, each typed character replaces the character to the right of the text caret. When overtype is disabled, characters are inserted at the caret.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(boolean) Whether OverType is set or not.
This action dose not return any value.
Scin.SetReadOnly ( | (string) ObjectName = "Plugin1", (number) TabID = 100, (boolean) bReadOnly = true ) |
Set the read-only flag for the document
Note: If you mark a document as read only, attempts to modify the text cause the SCN_MODIFYATTEMPTRO notification.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(boolean) Whether to set the read-only flag
This action dose not return any value.
Scin.SetSavePoint ( | (string) ObjectName = "Plugin1", (number) TabID = 100 ) |
This message tells Scintilla that the current state of the document is unmodified.
Note: This is usually done when the file is saved or loaded, hence the name "save point". As Scintilla performs undo and redo operations, it notifies the container that it has entered or left the save point with SCN_SAVEPOINTREACHED and SCN_SAVEPOINTLEFT notification messages, allowing the container to know if the file should be considered dirty or not.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
This action dose not return any value.
Scin.SetSelected ( | (string) ObjectName = "Plugin1", (number) TabID = 100, (number) iAnchor, (number) iPos ) |
This action sets both the anchor and the current position.
Note: If currentPos is negative, it means the end of the document. If anchorPos is negative, it means remove any selection (i.e. set the anchor to the same position as currentPos). The caret is scrolled into view after this operation.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(number) The position of the anchor
(number) The position of the caret.
This action dose not return any value.
Scin.SetText ( | (string) ObjectName = "Plugin1", (number) TabID = 100, (string) sReplaceString = "Hello World" ) |
Replaces the text of the specified tab.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(string) The string to replace the text of the specified tab.
This action dose not return any value.
Scin.SetZoom ( | (string) ObjectName = "Plugin1", (number) TabID = 100, (number) iZoom = 10 ) |
Set the zoom factor directly.
Note: The proper range is between -10 and 20
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
(number) Zoom factor.
Note: The proper range is between -10 and 20
This action dose not return any value.
Scin.Undo ( | (string) ObjectName = "Plugin1", (number) TabID = 100 ) |
Undoes one action in the document.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
This action dose not return any value.
Scin.ZoomIn ( | (string) ObjectName = "Plugin1", (number) TabID = 100 ) |
Increases the zoom factor by one point
Note: Increases the zoom factor by one point if the current zoom factor is less than 20 points. Scintilla incorporates a "zoom factor" that lets you make all the text in the document larger or smaller in steps of one point. The displayed point size never goes below 2, whatever zoom factor you set. You can set zoom factors in the range -10 to +20 points.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
This action dose not return any value.
Scin.ZoomOut ( | (string) ObjectName = "Plugin1", (number) TabID = 100 ) |
Decreases the zoom factor by one point
Note: Decreases the zoom factor by one point if the current zoom factor is greater than -10 points. Scintilla incorporates a "zoom factor" that lets you make all the text in the document larger or smaller in steps of one point. The displayed point size never goes below 2, whatever zoom factor you set. You can set zoom factors in the range -10 to +20 points.
(string) The name of the Scintilla object
(number) The ID of the Scintilla tab you want to affect.
This action dose not return any value.
2011
This File Was Generated With AMS ActionFile Editor