PdfFormField class. More...

#include <pdfix.h>

Public Member Functions
virtual PdfFieldType	GetType () const =0
	Gets the type of field. More...

virtual PdfFieldFlags	GetFlags () const =0
	Gets the form field's flags. More...

virtual bool	SetFlags (PdfFieldFlags flags)=0
	Sets the form field's flags. More...

virtual int	GetValue (wchar_t *buffer, int len) const =0
	Gets the field's value as string. More...

virtual bool	SetValue (const wchar_t *value)=0
	Sets the field's value as string. Multiple values should be comma-separated. More...

virtual int	GetDefaultValue (wchar_t *buffer, int len) const =0
	Gets the field's default value as string. More...

virtual int	GetFullName (wchar_t *buffer, int len) const =0
	Gets the field's full name within the document AcroForm field tree. More...

virtual int	GetTooltip (wchar_t *buffer, int len) const =0
	Gets the field's tooltip. More...

virtual int	GetNumOptions () const =0
	Gets the number of elements in the Opt array. More...

virtual int	GetOptionValue (int index, wchar_t *buffer, int len) const =0
	Gets the field's option value. More...

virtual int	GetOptionCaption (int index, wchar_t *buffer, int len) const =0
	Gets the field's option caption. More...

virtual PdfAction *	GetAction ()=0
	Gets a field's action object. More...

virtual PdfAction *	GetAAction (PdfActionEventType event)=0
	Gets a field's additional action object. More...

virtual int	GetMaxLength () const =0
	Gets maximum length of the field's text, in characters. More...

virtual int	GetWidgetExportValue (const PdfAnnot annot, wchar_t buffer, int len) const =0
	Gets the field's widget export value. More...

virtual PdsDictionary *	GetObject ()=0
	Gets the field's dictionary object. More...

virtual int	GetNumExportValues () const =0
	Gets the number of field's export values of the radio button and check box field. More...

virtual int	GetExportValue (int index, wchar_t *buffer, int len) const =0
	Gets the field's export value for n-th widget of the form field. More...

virtual void	NotifyWillChange (const wchar_t *key)=0

virtual void	NotifyDidChange (const wchar_t *key, int err)=0

Detailed Description

PdfFormField class.

PdfFormField object represents interactive form dictionary that shall be referenced from the AcroForm entry in the document catalogue

Member Function Documentation

◆ GetAAction()

virtual PdfAction * PdfFormField::GetAAction ( PdfActionEventType event )

pure virtual

Gets a field's additional action object.

Parameters

event The event which additional action to get.

Returns: The annotation's additional action object or nullptr if annotation does not have an action for specified event type.

See also: GetAction

◆ GetAction()

virtual PdfAction * PdfFormField::GetAction ( )

pure virtual

Gets a field's action object.

Returns: The annotation's action object or nullptr if annotation does not have an action.

See also: GetAAction

◆ GetDefaultValue()

virtual int PdfFormField::GetDefaultValue	(	wchar_t *	buffer,
		int	len
	)		const

pure virtual

Gets the field's default value as string.

Parameters

buffer	(filled by method) If the buffer is null function returns required length of string
len	Length of a buffer to be filled in.

Returns: Number of characters written into buffer of required length.

◆ GetExportValue()

virtual int PdfFormField::GetExportValue	(	int	index,
		wchar_t *	buffer,
		int	len
	)		const

pure virtual

Gets the field's export value for n-th widget of the form field.

Parameters

index	the index of the widget in the form field
buffer	(filled by method) If the buffer is null function returns required length of string
len	Length of a buffer to be filled in.

Returns: Number of characters written into buffer of required length.

See also: GetNumExportValues

◆ GetFlags()

virtual PdfFieldFlags PdfFormField::GetFlags ( ) const

pure virtual

Gets the form field's flags.

Returns: The form field's flags.

◆ GetFullName()

virtual int PdfFormField::GetFullName	(	wchar_t *	buffer,
		int	len
	)		const

pure virtual

Gets the field's full name within the document AcroForm field tree.

Parameters

buffer	(filled by method) If the buffer is null function returns required length of string
len	Length of a buffer to be filled in.

Returns: Number of characters written into buffer of required length.

◆ GetMaxLength()

virtual int PdfFormField::GetMaxLength ( ) const

pure virtual

Gets maximum length of the field's text, in characters.

Returns: The maximum number of characters.

◆ GetNumExportValues()

virtual int PdfFormField::GetNumExportValues ( ) const

pure virtual

Gets the number of field's export values of the radio button and check box field.

Returns: The number of the export values of the form field.

See also: GetExportValue

◆ GetNumOptions()

virtual int PdfFormField::GetNumOptions ( ) const

pure virtual

Gets the number of elements in the Opt array.

Returns: Number of field's options.

◆ GetObject()

virtual PdsDictionary * PdfFormField::GetObject ( )

pure virtual

Gets the field's dictionary object.

Returns: The requested field object.

◆ GetOptionCaption()

virtual int PdfFormField::GetOptionCaption	(	int	index,
		wchar_t *	buffer,
		int	len
	)		const

pure virtual

Gets the field's option caption.

Parameters

index	The index of option to retrieve.
buffer	(filled by method) If the buffer is null function returns required length of string
len	Length of a buffer to be filled in.

Returns: Number of characters written into buffer of required length.

◆ GetOptionValue()

virtual int PdfFormField::GetOptionValue	(	int	index,
		wchar_t *	buffer,
		int	len
	)		const

pure virtual

Gets the field's option value.

Parameters

index	The index of option to retrieve.
buffer	(filled by method) If the buffer is null function returns required length of string
len	Length of a buffer to be filled in.

Returns: Number of characters written into buffer of required length.

◆ GetTooltip()

virtual int PdfFormField::GetTooltip	(	wchar_t *	buffer,
		int	len
	)		const

pure virtual

Gets the field's tooltip.

Parameters

buffer	(filled by method) If the buffer is null function returns required length of string
len	Length of a buffer to be filled in.

Returns: Number of characters written into buffer of required length.

◆ GetType()

virtual PdfFieldType PdfFormField::GetType ( ) const

pure virtual

Gets the type of field.

Returns: The form field type.

◆ GetValue()

virtual int PdfFormField::GetValue	(	wchar_t *	buffer,
		int	len
	)		const

pure virtual

Gets the field's value as string.

Parameters

buffer	(filled by method) If the buffer is null function returns required length of string
len	Length of a buffer to be filled in.

Returns: Number of characters written into buffer of required length.

◆ GetWidgetExportValue()

virtual int PdfFormField::GetWidgetExportValue	(	const PdfAnnot *	annot,
		wchar_t *	buffer,
		int	len
	)		const

pure virtual

Gets the field's widget export value.

Parameters

annot	The widget annotation that holds the export value
buffer	(filled by method) If the buffer is null function returns required length of string
len	Length of a buffer to be filled in.

Returns: Number of characters written into buffer of required length.

◆ NotifyDidChange()

virtual void PdfFormField::NotifyDidChange	(	const wchar_t *	key,
		int	err
	)

pure virtual

Broadcasts a PdfFormFieldDidChange() notification. Clients must call this method after making low level changes on the field object.

Parameters

key	The name of the key in the field's dictionary that is changing.
err	An error code to pass to any method registered to receive the PdfFormFieldDidChange() notification. Pass zero if the form field was changed successfully. Pass a nonzero value if an error occurred while changing the form field.

◆ NotifyWillChange()

virtual void PdfFormField::NotifyWillChange ( const wchar_t * key )

pure virtual

Broadcasts a PdfFormWillChange() notification. Clients must call this method before making low level changes on the field object.

Parameters

key	The name of the key in the field's dictionary that is changing.

◆ SetFlags()

virtual bool PdfFormField::SetFlags ( PdfFieldFlags flags )

pure virtual

Sets the form field's flags.

Returns: true if the FormField's flags was set successfully.

◆ SetValue()

virtual bool PdfFormField::SetValue ( const wchar_t * value )

pure virtual

Sets the field's value as string. Multiple values should be comma-separated.

Parameters

buffer The new form field string value

Returns: true if succeeded, false otherwise. Sample SetFormFieldValue

Public Member Functions

Detailed Description

Member Function Documentation

◆ GetAAction()

◆ GetAction()

◆ GetDefaultValue()

◆ GetExportValue()

◆ GetFlags()

◆ GetFullName()

◆ GetMaxLength()

◆ GetNumExportValues()

◆ GetNumOptions()

◆ GetObject()

◆ GetOptionCaption()

◆ GetOptionValue()

◆ GetTooltip()

◆ GetType()

◆ GetValue()

◆ GetWidgetExportValue()

◆ NotifyDidChange()

◆ NotifyWillChange()

◆ SetFlags()

◆ SetValue()