SetFormFieldRichTextString

Form fields

Description

Sets the rich text (RV) or default style (DS) string of the specified form field using the given key. Writing either key requires PDF 1.5, and the library raises the effective save version automatically unless a lower version lock is active.

Syntax

Delphi

function TPDFlib.SetFormFieldRichTextString(Index: Integer; Const Key, NewValue: WideString): Integer;

ActiveX

Function PDFlib::SetFormFieldRichTextString(Index As Long, Key As String, NewValue As String) As Long

DLL

int DLSetFormFieldRichTextString(int InstanceID, int Index, wchar_t * Key, wchar_t * NewValue);

Parameters

IndexThe index of the required form field. The first form field has an index of 1.
KeyRV sets the rich text string. DS sets the default style string.
NewValueThe new value for the specified key. The required format is defined by the PDF rich text string and field dictionary rules.

Return values

0Could not find the specified form field
1The specified value of the form field was set successfully