Version: API v2 Preview

`FormFieldObject`

Kind: class
Module/package: types
SDK: pdfdancer-client-python 2.0.0

Base class for selectable PDF object references (paths, text lines, etc.) providing shared behavior such as position, deletion, and movement.

Declaration

FormFieldObject(client: "'PDFDancer'", internal_id: 'str', object_type: 'ObjectType', position: 'Position', field_name: 'str', field_value: 'str')

__init__(self, client: "'PDFDancer'", internal_id: 'str', object_type: 'ObjectType', position: 'Position', field_name: 'str', field_value: 'str')

Initialize self. See help(type(self)) for accurate signature.

clear_clipping(self) -> 'bool'

Detach any active clipping path from this object.

delete(self) -> 'bool'

Delete this object from the PDF document.

move_to(self, x: 'float', y: 'float') -> 'bool'

Move this object to a new position.

object_ref(self) -> 'FormFieldRef'

set_value(self, value: 'str') -> 'bool'

page_number: 'int'

Page index where this object resides.