Difference between revisions of "Editbox"
From Lianjapedia
Helen.george (Talk | contribs) |
Yvonne.milne (Talk | contribs) (→Description) |
||
(10 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==== | ||
− | This class supports the | + | This class supports the [[:Category:Common_Properties|Common Properties]] plus the following: |
− | {| class="wikitable" | + | {| 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 | ||
|- | |- | ||
− | | | + | |Alignment |
|RW | |RW | ||
− | | | + | |Numeric |
− | | | + | |Alignment: 0 = left, 1 = right, 2 = center |
|- | |- | ||
− | | | + | |ColumnNumber |
− | | | + | |R |
− | | | + | |Numeric |
− | | | + | |Current column number |
|- | |- | ||
|HTML | |HTML | ||
Line 26: | Line 33: | ||
|Object's text in HTML | |Object's text in HTML | ||
|- | |- | ||
− | | | + | |LineCount |
− | | | + | |R |
|Numeric | |Numeric | ||
− | | | + | |Number of lines |
|- | |- | ||
− | | | + | |LineNumber |
− | | | + | |R |
− | | | + | |Numeric |
− | | | + | |Current line number |
|- | |- | ||
− | | | + | |Modified |
|RW | |RW | ||
|Boolean | |Boolean | ||
− | |Whether text | + | |Whether text has been modified |
|- | |- | ||
− | | | + | |Readonly |
|RW | |RW | ||
|Boolean | |Boolean | ||
− | |Whether text | + | |Whether text is readonly |
|- | |- | ||
− | | | + | |valign="top"|SelectOnEntry |
− | | | + | |valign="top"|RW |
− | | | + | |valign="top"|Boolean |
− | | | + | |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 | |RW | ||
|Boolean | |Boolean | ||
− | |Whether text is | + | |Whether text is word-wrapped |
|- | |- | ||
|} | |} | ||
Line 70: | Line 77: | ||
====Methods==== | ====Methods==== | ||
− | This class supports the | + | This class supports the [[:Category:Common_Methods|Common Methods]] plus the following: |
− | {| class="wikitable" | + | {| class="wikitable" width="100%" |
!width="20%"|Method | !width="20%"|Method | ||
!Args | !Args | ||
!width="50%"|Description | !width="50%"|Description | ||
|- | |- | ||
− | | | + | |valign="top"|Append |
− | | | + | |valign="top"|text as Character |
− | | | + | |valign="top"|Add the specified text to the end of the existing text |
|- | |- | ||
− | | | + | |Clear |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
|None | |None | ||
− | | | + | |Clear all text |
|- | |- | ||
|Copy | |Copy | ||
Line 93: | Line 96: | ||
|Copy the currently selected text | |Copy the currently selected text | ||
|- | |- | ||
− | | | + | |Cut |
|None | |None | ||
− | | | + | |Cut the currently selected text |
|- | |- | ||
− | | | + | |DeleteLine |
− | | | + | |line as Numeric |
− | | | + | |Delete the line at the specified line number |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
|- | |- | ||
|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 | ||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
|HighlightLine | |HighlightLine | ||
Line 129: | Line 116: | ||
|Highlight the line at the specified line number | |Highlight the line at the specified line number | ||
|- | |- | ||
− | |InsertText | + | |valign="top"|InsertText |
− | |text as Character | + | |valign="top"|text as Character |
− | |Insert the specified plain text at the current position | + | |valign="top"|Insert the specified plain text at the current position |
|- | |- | ||
− | | | + | |Line |
− | | | + | |line as Numeric |
− | | | + | |Return the text at the specified line number |
|- | |- | ||
− | | | + | |MoveDown |
|None | |None | ||
− | |Move | + | |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 | ||
|- | |- | ||
− | | | + | |Paste |
|None | |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 | ||
|- | |- | ||
|} | |} | ||
Line 161: | Line 164: | ||
====Events==== | ====Events==== | ||
− | This class supports the | + | This class supports the [[:Category:Common_Events|Common Events]] plus the following: |
− | {| class="wikitable" | + | {| 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 10:57, 9 April 2018
Note: property, method and event names should be referred to in lowercase in case-sensitive scripting languages.
Contents
Description
Shown below in a standalone Form. Click the image to see in a Custom Section in a Lianja Page.
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 |
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 |
---|