Difference between revisions of "Editbox"

From Lianjapedia
Jump to: navigation, search
(→‎Description)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
Note: property, method and event names should be referred to in lowercase in case-sensitive scripting languages.
 
Note: property, method and event names should be referred to in lowercase in case-sensitive scripting languages.
 +
 +
====Description====
 +
Shown below in a standalone [[Form]].  Click the image to see in a [[Custom_Sections_and_Gadgets|Custom Section]] in a Lianja [[Page Attributes|Page]].
 +
 +
[[{{ns:file}}:editbox.png|link={{filepath:editbox_cs.png}}|Editbox]]
 +
 +
Editbox is a control for editing variable length or multi-line text.
  
 
====Properties====
 
====Properties====
Line 5: Line 12:
 
This class supports the [[:Category:Common_Properties|Common Properties]] plus the following:
 
This class supports the [[:Category:Common_Properties|Common Properties]] plus the following:
  
−
{| class="wikitable" width=100%
+
{| class="wikitable" width="100%"
 
!width="20%"|Property
 
!width="20%"|Property
 
!Access (R/RW)
 
!Access (R/RW)
Line 11: Line 18:
 
!width="50%"|Description
 
!width="50%"|Description
 
|-
 
|-
−
|Value
+
|Alignment
 
|RW
 
|RW
−
|Character
+
|Numeric
−
|Object's text contents
+
|Alignment: 0 = left, 1 = right, 2 = center
 
|-
 
|-
−
|Text
+
|ColumnNumber
−
|RW
+
|R
−
|Character
+
|Numeric
−
|Object's text in plain text
+
|Current column number
 
|-
 
|-
 
|HTML
 
|HTML
Line 25: Line 32:
 
|Character
 
|Character
 
|Object's text in HTML
 
|Object's text in HTML
−
|-
 
−
|Alignment
 
−
|RW
 
−
|Numeric
 
−
|Alignment: 0 = left, 1 = right, 2 = center
 
−
|-
 
−
|Readonly
 
−
|RW
 
−
|Boolean
 
−
|Whether text is readonly
 
−
|-
 
−
|WordWrap
 
−
|RW
 
−
|Boolean
 
−
|Whether text is word-wrapped
 
−
|-
 
−
|Modified
 
−
|RW
 
−
|Boolean
 
−
|Whether text has been modified
 
 
|-
 
|-
 
|LineCount
 
|LineCount
Line 56: Line 43:
 
|Current line number
 
|Current line number
 
|-
 
|-
−
|ColumnNumber
+
|Modified
−
|R
+
|RW
−
|Numeric
+
|Boolean
−
|Current column number
+
|Whether text has been modified
 +
|-
 +
|Readonly
 +
|RW
 +
|Boolean
 +
|Whether text is readonly
 
|-
 
|-
 
|valign="top"|SelectOnEntry
 
|valign="top"|SelectOnEntry
Line 65: Line 57:
 
|valign="top"|Boolean
 
|valign="top"|Boolean
 
|valign="top"|Whether text is selected when object is entered
 
|valign="top"|Whether text is selected when object is entered
 +
|-
 +
|Text
 +
|RW
 +
|Character
 +
|Object's text in plain text
 +
|-
 +
|Value
 +
|RW
 +
|Character
 +
|Object's text contents
 +
|-
 +
|WordWrap
 +
|RW
 +
|Boolean
 +
|Whether text is word-wrapped
 
|-
 
|-
 
|}
 
|}
Line 72: Line 79:
 
This class supports the [[:Category:Common_Methods|Common Methods]] plus the following:
 
This class supports the [[:Category:Common_Methods|Common Methods]] plus the following:
  
−
{| class="wikitable" width=100%
+
{| class="wikitable" width="100%"
 
!width="20%"|Method
 
!width="20%"|Method
 
!Args
 
!Args
 
!width="50%"|Description
 
!width="50%"|Description
−
|-
 
−
|Print
 
−
|None
 
−
|Print text contents
 
 
|-
 
|-
 
|valign="top"|Append
 
|valign="top"|Append
Line 85: Line 88:
 
|valign="top"|Add the specified text to the end of the existing text
 
|valign="top"|Add the specified text to the end of the existing text
 
|-
 
|-
−
|Cut
+
|Clear
 
|None
 
|None
−
|Cut the currently selected text
+
|Clear all text
 
|-
 
|-
 
|Copy
 
|Copy
Line 93: Line 96:
 
|Copy the currently selected text
 
|Copy the currently selected text
 
|-
 
|-
−
|Paste
+
|Cut
 
|None
 
|None
−
|Paste the current contents of the clipboard
+
|Cut the currently selected text
 
|-
 
|-
−
|Clear
+
|DeleteLine
−
|None
+
|line as Numeric
−
|Clear all text
+
|Delete the line at the specified line number
−
|-
+
−
|Undo
+
−
|None
+
−
|Undo last action
+
−
|-
+
−
|Redo
+
−
|None
+
−
|Redo last action
+
−
|-
+
−
|SelectAll
+
−
|None
+
−
|Select all text
+
 
|-
 
|-
 
|valign="top"|Find
 
|valign="top"|Find
Line 120: Line 111:
 
|line as Numeric
 
|line as Numeric
 
|Go to the specified line number
 
|Go to the specified line number
−
|-
 
−
|DeleteLine
 
−
|line as Numeric
 
−
|Delete the line at the specified line number
 
 
|-
 
|-
 
|HighlightLine
 
|HighlightLine
Line 133: Line 120:
 
|valign="top"|Insert the specified plain text at the current position
 
|valign="top"|Insert the specified plain text at the current position
 
|-
 
|-
−
|valign="top"|InsertHtml
+
|Line
−
|valign="top"|htmltext as Character
+
|line as Numeric
−
|valign="top"|Insert the specified HTML text at the current position
+
|Return the text at the specified line number
 
|-
 
|-
−
|MoveStart
+
|MoveDown
 
|None
 
|None
−
|Move to the start of the text
+
|Move down a line in the text
 
|-
 
|-
 
|MoveEnd
 
|MoveEnd
 
|None
 
|None
 
|Move to the end of the text
 
|Move to the end of the text
 +
|-
 +
|MoveStart
 +
|None
 +
|Move to the start of the text
 
|-
 
|-
 
|MoveUp
 
|MoveUp
Line 149: Line 140:
 
|Move up a line in the text
 
|Move up a line in the text
 
|-
 
|-
−
|MoveDown
+
|Paste
 
|None
 
|None
−
|Move down a line in the text
+
|Paste the current contents of the clipboard
 
|-
 
|-
−
|Line
+
|Print
−
|line as Numeric
+
|None
−
|Return the text at the specified line number
+
|Print text contents
 +
|-
 +
|Redo
 +
|None
 +
|Redo last action
 +
|-
 +
|SelectAll
 +
|None
 +
|Select all text
 +
|-
 +
|Undo
 +
|None
 +
|Undo last action
 
|-
 
|-
 
|}
 
|}
Line 163: Line 166:
 
This class supports the [[:Category:Common_Events|Common Events]] plus the following:
 
This class supports the [[:Category:Common_Events|Common Events]] plus the following:
  
−
{| class="wikitable" width=100%
+
{| class="wikitable" width="100%"
 
!width="20%"|Event
 
!width="20%"|Event
 
!Args
 
!Args
 
!width="50%"|Description
 
!width="50%"|Description
−
 
 
|}
 
|}
  
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Framework Classes]]
 
[[Category:Framework Classes]]

Latest revision as of 09:57, 9 April 2018

Note: property, method and event names should be referred to in lowercase in case-sensitive scripting languages.

Description

Shown below in a standalone Form. Click the image to see in a Custom Section in a Lianja Page.

Editbox

Editbox is a control for editing variable length or multi-line text.

Properties

This class supports the Common Properties plus the following:

Property Access (R/RW) Value Description
Alignment RW Numeric Alignment: 0 = left, 1 = right, 2 = center
ColumnNumber R Numeric Current column number
HTML RW Character Object's text in HTML
LineCount R Numeric Number of lines
LineNumber R Numeric Current line number
Modified RW Boolean Whether text has been modified
Readonly RW Boolean Whether text is readonly
SelectOnEntry RW Boolean Whether text is selected when object is entered
Text RW Character Object's text in plain text
Value RW Character Object's text contents
WordWrap RW Boolean Whether text is word-wrapped

Methods

This class supports the Common Methods plus the following:

Method Args Description
Append text as Character Add the specified text to the end of the existing text
Clear None Clear all text
Copy None Copy the currently selected text
Cut None Cut the currently selected text
DeleteLine line as Numeric Delete the line at the specified line number
Find text as Character[, flags as Numeric] Search for the specified text in the contents. Flags: 1 = search backwards instead of forwards, 2 = case sensitive, 4 = match only complete words
Goto line as Numeric Go to the specified line number
HighlightLine line as Numeric Highlight the line at the specified line number
InsertText text as Character Insert the specified plain text at the current position
Line line as Numeric Return the text at the specified line number
MoveDown None Move down a line in the text
MoveEnd None Move to the end of the text
MoveStart None Move to the start of the text
MoveUp None Move up a line in the text
Paste None Paste the current contents of the clipboard
Print None Print text contents
Redo None Redo last action
SelectAll None Select all text
Undo None Undo last action

Events

This class supports the Common Events plus the following:

Event Args Description
Retrieved from "https://www.lianja.com/doc/index.php?title=Editbox&oldid=20751"