InputFieldDeleteCurrent PowerScript function
Description
Deletes the input field that is selected in a RichTextEdit
control.
Controls
RichTextEdit controls
Syntax
|
1 |
<span>rtename</span>.<span>InputFieldDeleteCurrent</span> ( ) |
|
Argument |
Description |
|---|---|
|
rtename |
The name of the RichTextEdit control |
Return Values
Integer. Returns 1 if it succeeds and
-1 if there is no input field at the insertion point, the input
field is activated for editing, or an error occurs.
Usage
All the input fields that have the same name contain the same
data but they can be deleted independently. If one of a group of
input fields with the same name is deleted, the others are not affected.
If all the input fields of the same name are deleted, the RichTextEdit
control remembers the data from those input fields. It will use
that data to initialize a new input field that has the same name as
the deleted fields.
The input field must be the only selection. If other text
is selected too, InputFieldDeleteCurrent fails.
When an input field is the current and only selection, the highlight
flashes.
InputFieldDeleteCurrent deletes only the
current field. Other fields with the same name within the document
are not affected. If the RichTextEdit control uses the DataSource function
to share data with a DataWindow, the current field is deleted from
all instances of the document.
Examples
This example deletes the input field containing the
insertion point:
|
1 |
integer li_rtn |
|
1 |
li_rtn = rte_1.<span>InputFieldDeleteCurrent</span>() |