SetFormFieldRichTextString

Form fields

Description

Sets the rich text (RV) or default style (DS) string of the specified form field using the given key.

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. The Key used to set the required string "RV" = sets the rich text string "DS" = sets the default style string
KeyThe new value for the specified key. The required format of the input string is defined in the PDF Specification under the section titled "Field Dictionaries".
NewValue

Return values

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