TextFieldGetTypeData

Description

Gets the type data of the specified text field in a RichTextEdit control.

Applies to

RichTextEdit controls

Syntax

rtename.TextFieldGetTypeData (integer id, ref string data)

Argument

Description

rtename

The name of the RichTextEdit control in which you want to get the type data of the specified text field

id

The ID of the text field you want to obtain

data

A string specifying the type data of the text field. If the function fails to get the type data, the string value will not be modified and remain unchanged as before the call.


Return value

Integer.

Returns 1 for success and -1 for failure. If any argument's value is null, returns null.

Examples

This example gets the type data "Report" through ID of the text field in a RichTextEdit rte_1 and displays a message if it succeeds:

string ls_data
integer li_rtn,li_id

ls_data = "test data"
li_id =  rte_1.TextFieldInsert("Test")
rte_1.TextFieldSetTypeAndData (li_id,"internallink","Report")
li_rtn = rte_1.TextFieldGetTypeData(li_id, ref ls_data)
if li_rtn = 1 then
         MessageBox("Data", ls_data)
end if

See also

TextFieldGetType

TextFieldSetTypeAndData