Document
Forms
Interface
constructor
base_
iface
name
document_
is_
modified
form_
field_
button_
get_
state
form_
field_
button_
set_
state
form_
field_
choice_
get_
item
form_
field_
choice_
get_
n_
items
form_
field_
choice_
get_
text
form_
field_
choice_
is_
item_
selected
form_
field_
choice_
select_
item
form_
field_
choice_
set_
text
form_
field_
choice_
toggle_
item
form_
field_
choice_
unselect_
all
form_
field_
text_
get_
text
form_
field_
text_
set_
text
get_
form_
fields
reset_
form
GJS API Reference
EvinceDocument-3.0
EvinceDocument
DocumentFormsInterface
Class DocumentFormsInterface
Hierarchy
DocumentFormsInterface
Index
Constructors
constructor
Properties
base_
iface
name
Methods
document_
is_
modified
form_
field_
button_
get_
state
form_
field_
button_
set_
state
form_
field_
choice_
get_
item
form_
field_
choice_
get_
n_
items
form_
field_
choice_
get_
text
form_
field_
choice_
is_
item_
selected
form_
field_
choice_
select_
item
form_
field_
choice_
set_
text
form_
field_
choice_
toggle_
item
form_
field_
choice_
unselect_
all
form_
field_
text_
get_
text
form_
field_
text_
set_
text
get_
form_
fields
reset_
form
Constructors
constructor
new
Document
Forms
Interface
(
)
:
DocumentFormsInterface
Returns
DocumentFormsInterface
Properties
base_
iface
base_
iface
:
TypeInterface
Static
name
name
:
string
Methods
document_
is_
modified
document_
is_
modified
(
document_forms
:
DocumentForms
)
:
boolean
Parameters
document_forms:
DocumentForms
Returns
boolean
form_
field_
button_
get_
state
form_
field_
button_
get_
state
(
document_forms
:
DocumentForms
, field
:
EvinceDocument
.
FormField
)
:
boolean
Parameters
document_forms:
DocumentForms
field:
EvinceDocument
.
FormField
Returns
boolean
form_
field_
button_
set_
state
form_
field_
button_
set_
state
(
document_forms
:
DocumentForms
, field
:
EvinceDocument
.
FormField
, state
:
boolean
)
:
void
Parameters
document_forms:
DocumentForms
field:
EvinceDocument
.
FormField
state:
boolean
Returns
void
form_
field_
choice_
get_
item
form_
field_
choice_
get_
item
(
document_forms
:
DocumentForms
, field
:
EvinceDocument
.
FormField
, index
:
number
)
:
string
Parameters
document_forms:
DocumentForms
field:
EvinceDocument
.
FormField
index:
number
Returns
string
form_
field_
choice_
get_
n_
items
form_
field_
choice_
get_
n_
items
(
document_forms
:
DocumentForms
, field
:
EvinceDocument
.
FormField
)
:
number
Parameters
document_forms:
DocumentForms
field:
EvinceDocument
.
FormField
Returns
number
form_
field_
choice_
get_
text
form_
field_
choice_
get_
text
(
document_forms
:
DocumentForms
, field
:
EvinceDocument
.
FormField
)
:
string
Parameters
document_forms:
DocumentForms
field:
EvinceDocument
.
FormField
Returns
string
form_
field_
choice_
is_
item_
selected
form_
field_
choice_
is_
item_
selected
(
document_forms
:
DocumentForms
, field
:
EvinceDocument
.
FormField
, index
:
number
)
:
boolean
Parameters
document_forms:
DocumentForms
field:
EvinceDocument
.
FormField
index:
number
Returns
boolean
form_
field_
choice_
select_
item
form_
field_
choice_
select_
item
(
document_forms
:
DocumentForms
, field
:
EvinceDocument
.
FormField
, index
:
number
)
:
void
Parameters
document_forms:
DocumentForms
field:
EvinceDocument
.
FormField
index:
number
Returns
void
form_
field_
choice_
set_
text
form_
field_
choice_
set_
text
(
document_forms
:
DocumentForms
, field
:
EvinceDocument
.
FormField
, text
:
string
)
:
void
Parameters
document_forms:
DocumentForms
field:
EvinceDocument
.
FormField
text:
string
Returns
void
form_
field_
choice_
toggle_
item
form_
field_
choice_
toggle_
item
(
document_forms
:
DocumentForms
, field
:
EvinceDocument
.
FormField
, index
:
number
)
:
void
Parameters
document_forms:
DocumentForms
field:
EvinceDocument
.
FormField
index:
number
Returns
void
form_
field_
choice_
unselect_
all
form_
field_
choice_
unselect_
all
(
document_forms
:
DocumentForms
, field
:
EvinceDocument
.
FormField
)
:
void
Parameters
document_forms:
DocumentForms
field:
EvinceDocument
.
FormField
Returns
void
form_
field_
text_
get_
text
form_
field_
text_
get_
text
(
document_forms
:
DocumentForms
, field
:
EvinceDocument
.
FormField
)
:
string
Parameters
document_forms:
DocumentForms
field:
EvinceDocument
.
FormField
Returns
string
form_
field_
text_
set_
text
form_
field_
text_
set_
text
(
document_forms
:
DocumentForms
, field
:
EvinceDocument
.
FormField
, text
:
string
)
:
void
Parameters
document_forms:
DocumentForms
field:
EvinceDocument
.
FormField
text:
string
Returns
void
get_
form_
fields
get_
form_
fields
(
document_forms
:
DocumentForms
, page
:
EvinceDocument
.
Page
)
:
MappingList
Parameters
document_forms:
DocumentForms
page:
EvinceDocument
.
Page
Returns
MappingList
reset_
form
reset_
form
(
document_forms
:
DocumentForms
, action
:
LinkAction
)
:
void
Parameters
document_forms:
DocumentForms
action:
LinkAction
Returns
void
Document
Forms
Interface
constructor
base_
iface
name
document_
is_
modified
form_
field_
button_
get_
state
form_
field_
button_
set_
state
form_
field_
choice_
get_
item
form_
field_
choice_
get_
n_
items
form_
field_
choice_
get_
text
form_
field_
choice_
is_
item_
selected
form_
field_
choice_
select_
item
form_
field_
choice_
set_
text
form_
field_
choice_
toggle_
item
form_
field_
choice_
unselect_
all
form_
field_
text_
get_
text
form_
field_
text_
set_
text
get_
form_
fields
reset_
form
base64:eyJwYWdlTmF2aWdhdGlvbiI6W3siY2xhc3NOYW1lcyI6InRzZC1raW5kLWNvbnN0cnVjdG9yIHRzZC1wYXJlbnQta2luZC1jbGFzcyIsImhyZWYiOiJFdmluY2VEb2N1bWVudF8zXzAuRXZpbmNlRG9jdW1lbnQuRG9jdW1lbnRGb3Jtc0ludGVyZmFjZS5odG1sI2NvbnN0cnVjdG9yIiwibmFtZSI6ImNvbnN0cnVjdG9yIiwiY2hpbGRyZW4iOltdLCJpc0V4dGVybiI6ZmFsc2UsImlzSW50ZXJuIjp0cnVlfSx7ImNsYXNzTmFtZXMiOiJ0c2Qta2luZC1wcm9wZXJ0eSB0c2QtcGFyZW50LWtpbmQtY2xhc3MiLCJocmVmIjoiRXZpbmNlRG9jdW1lbnRfM18wLkV2aW5jZURvY3VtZW50LkRvY3VtZW50Rm9ybXNJbnRlcmZhY2UuaHRtbCNiYXNlX2lmYWNlIiwibmFtZSI6ImJhc2VfaWZhY2UiLCJjaGlsZHJlbiI6W10sImlzRXh0ZXJuIjpmYWxzZSwiaXNJbnRlcm4iOnRydWV9LHsiY2xhc3NOYW1lcyI6InRzZC1raW5kLXByb3BlcnR5IHRzZC1wYXJlbnQta2luZC1jbGFzcyB0c2QtaXMtc3RhdGljIiwiaHJlZiI6IkV2aW5jZURvY3VtZW50XzNfMC5FdmluY2VEb2N1bWVudC5Eb2N1bWVudEZvcm1zSW50ZXJmYWNlLmh0bWwjbmFtZSIsIm5hbWUiOiJuYW1lIiwiY2hpbGRyZW4iOltdLCJpc0V4dGVybiI6ZmFsc2UsImlzSW50ZXJuIjp0cnVlfSx7ImNsYXNzTmFtZXMiOiJ0c2Qta2luZC1tZXRob2QgdHNkLXBhcmVudC1raW5kLWNsYXNzIiwiaHJlZiI6IkV2aW5jZURvY3VtZW50XzNfMC5FdmluY2VEb2N1bWVudC5Eb2N1bWVudEZvcm1zSW50ZXJmYWNlLmh0bWwjZG9jdW1lbnRfaXNfbW9kaWZpZWQiLCJuYW1lIjoiZG9jdW1lbnRfaXNfbW9kaWZpZWQiLCJjaGlsZHJlbiI6W10sImlzRXh0ZXJuIjpmYWxzZSwiaXNJbnRlcm4iOnRydWV9LHsiY2xhc3NOYW1lcyI6InRzZC1raW5kLW1ldGhvZCB0c2QtcGFyZW50LWtpbmQtY2xhc3MiLCJocmVmIjoiRXZpbmNlRG9jdW1lbnRfM18wLkV2aW5jZURvY3VtZW50LkRvY3VtZW50Rm9ybXNJbnRlcmZhY2UuaHRtbCNmb3JtX2ZpZWxkX2J1dHRvbl9nZXRfc3RhdGUiLCJuYW1lIjoiZm9ybV9maWVsZF9idXR0b25fZ2V0X3N0YXRlIiwiY2hpbGRyZW4iOltdLCJpc0V4dGVybiI6ZmFsc2UsImlzSW50ZXJuIjp0cnVlfSx7ImNsYXNzTmFtZXMiOiJ0c2Qta2luZC1tZXRob2QgdHNkLXBhcmVudC1raW5kLWNsYXNzIiwiaHJlZiI6IkV2aW5jZURvY3VtZW50XzNfMC5FdmluY2VEb2N1bWVudC5Eb2N1bWVudEZvcm1zSW50ZXJmYWNlLmh0bWwjZm9ybV9maWVsZF9idXR0b25fc2V0X3N0YXRlIiwibmFtZSI6ImZvcm1fZmllbGRfYnV0dG9uX3NldF9zdGF0ZSIsImNoaWxkcmVuIjpbXSwiaXNFeHRlcm4iOmZhbHNlLCJpc0ludGVybiI6dHJ1ZX0seyJjbGFzc05hbWVzIjoidHNkLWtpbmQtbWV0aG9kIHRzZC1wYXJlbnQta2luZC1jbGFzcyIsImhyZWYiOiJFdmluY2VEb2N1bWVudF8zXzAuRXZpbmNlRG9jdW1lbnQuRG9jdW1lbnRGb3Jtc0ludGVyZmFjZS5odG1sI2Zvcm1fZmllbGRfY2hvaWNlX2dldF9pdGVtIiwibmFtZSI6ImZvcm1fZmllbGRfY2hvaWNlX2dldF9pdGVtIiwiY2hpbGRyZW4iOltdLCJpc0V4dGVybiI6ZmFsc2UsImlzSW50ZXJuIjp0cnVlfSx7ImNsYXNzTmFtZXMiOiJ0c2Qta2luZC1tZXRob2QgdHNkLXBhcmVudC1raW5kLWNsYXNzIiwiaHJlZiI6IkV2aW5jZURvY3VtZW50XzNfMC5FdmluY2VEb2N1bWVudC5Eb2N1bWVudEZvcm1zSW50ZXJmYWNlLmh0bWwjZm9ybV9maWVsZF9jaG9pY2VfZ2V0X25faXRlbXMiLCJuYW1lIjoiZm9ybV9maWVsZF9jaG9pY2VfZ2V0X25faXRlbXMiLCJjaGlsZHJlbiI6W10sImlzRXh0ZXJuIjpmYWxzZSwiaXNJbnRlcm4iOnRydWV9LHsiY2xhc3NOYW1lcyI6InRzZC1raW5kLW1ldGhvZCB0c2QtcGFyZW50LWtpbmQtY2xhc3MiLCJocmVmIjoiRXZpbmNlRG9jdW1lbnRfM18wLkV2aW5jZURvY3VtZW50LkRvY3VtZW50Rm9ybXNJbnRlcmZhY2UuaHRtbCNmb3JtX2ZpZWxkX2Nob2ljZV9nZXRfdGV4dCIsIm5hbWUiOiJmb3JtX2ZpZWxkX2Nob2ljZV9nZXRfdGV4dCIsImNoaWxkcmVuIjpbXSwiaXNFeHRlcm4iOmZhbHNlLCJpc0ludGVybiI6dHJ1ZX0seyJjbGFzc05hbWVzIjoidHNkLWtpbmQtbWV0aG9kIHRzZC1wYXJlbnQta2luZC1jbGFzcyIsImhyZWYiOiJFdmluY2VEb2N1bWVudF8zXzAuRXZpbmNlRG9jdW1lbnQuRG9jdW1lbnRGb3Jtc0ludGVyZmFjZS5odG1sI2Zvcm1fZmllbGRfY2hvaWNlX2lzX2l0ZW1fc2VsZWN0ZWQiLCJuYW1lIjoiZm9ybV9maWVsZF9jaG9pY2VfaXNfaXRlbV9zZWxlY3RlZCIsImNoaWxkcmVuIjpbXSwiaXNFeHRlcm4iOmZhbHNlLCJpc0ludGVybiI6dHJ1ZX0seyJjbGFzc05hbWVzIjoidHNkLWtpbmQtbWV0aG9kIHRzZC1wYXJlbnQta2luZC1jbGFzcyIsImhyZWYiOiJFdmluY2VEb2N1bWVudF8zXzAuRXZpbmNlRG9jdW1lbnQuRG9jdW1lbnRGb3Jtc0ludGVyZmFjZS5odG1sI2Zvcm1fZmllbGRfY2hvaWNlX3NlbGVjdF9pdGVtIiwibmFtZSI6ImZvcm1fZmllbGRfY2hvaWNlX3NlbGVjdF9pdGVtIiwiY2hpbGRyZW4iOltdLCJpc0V4dGVybiI6ZmFsc2UsImlzSW50ZXJuIjp0cnVlfSx7ImNsYXNzTmFtZXMiOiJ0c2Qta2luZC1tZXRob2QgdHNkLXBhcmVudC1raW5kLWNsYXNzIiwiaHJlZiI6IkV2aW5jZURvY3VtZW50XzNfMC5FdmluY2VEb2N1bWVudC5Eb2N1bWVudEZvcm1zSW50ZXJmYWNlLmh0bWwjZm9ybV9maWVsZF9jaG9pY2Vfc2V0X3RleHQiLCJuYW1lIjoiZm9ybV9maWVsZF9jaG9pY2Vfc2V0X3RleHQiLCJjaGlsZHJlbiI6W10sImlzRXh0ZXJuIjpmYWxzZSwiaXNJbnRlcm4iOnRydWV9LHsiY2xhc3NOYW1lcyI6InRzZC1raW5kLW1ldGhvZCB0c2QtcGFyZW50LWtpbmQtY2xhc3MiLCJocmVmIjoiRXZpbmNlRG9jdW1lbnRfM18wLkV2aW5jZURvY3VtZW50LkRvY3VtZW50Rm9ybXNJbnRlcmZhY2UuaHRtbCNmb3JtX2ZpZWxkX2Nob2ljZV90b2dnbGVfaXRlbSIsIm5hbWUiOiJmb3JtX2ZpZWxkX2Nob2ljZV90b2dnbGVfaXRlbSIsImNoaWxkcmVuIjpbXSwiaXNFeHRlcm4iOmZhbHNlLCJpc0ludGVybiI6dHJ1ZX0seyJjbGFzc05hbWVzIjoidHNkLWtpbmQtbWV0aG9kIHRzZC1wYXJlbnQta2luZC1jbGFzcyIsImhyZWYiOiJFdmluY2VEb2N1bWVudF8zXzAuRXZpbmNlRG9jdW1lbnQuRG9jdW1lbnRGb3Jtc0ludGVyZmFjZS5odG1sI2Zvcm1fZmllbGRfY2hvaWNlX3Vuc2VsZWN0X2FsbCIsIm5hbWUiOiJmb3JtX2ZpZWxkX2Nob2ljZV91bnNlbGVjdF9hbGwiLCJjaGlsZHJlbiI6W10sImlzRXh0ZXJuIjpmYWxzZSwiaXNJbnRlcm4iOnRydWV9LHsiY2xhc3NOYW1lcyI6InRzZC1raW5kLW1ldGhvZCB0c2QtcGFyZW50LWtpbmQtY2xhc3MiLCJocmVmIjoiRXZpbmNlRG9jdW1lbnRfM18wLkV2aW5jZURvY3VtZW50LkRvY3VtZW50Rm9ybXNJbnRlcmZhY2UuaHRtbCNmb3JtX2ZpZWxkX3RleHRfZ2V0X3RleHQiLCJuYW1lIjoiZm9ybV9maWVsZF90ZXh0X2dldF90ZXh0IiwiY2hpbGRyZW4iOltdLCJpc0V4dGVybiI6ZmFsc2UsImlzSW50ZXJuIjp0cnVlfSx7ImNsYXNzTmFtZXMiOiJ0c2Qta2luZC1tZXRob2QgdHNkLXBhcmVudC1raW5kLWNsYXNzIiwiaHJlZiI6IkV2aW5jZURvY3VtZW50XzNfMC5FdmluY2VEb2N1bWVudC5Eb2N1bWVudEZvcm1zSW50ZXJmYWNlLmh0bWwjZm9ybV9maWVsZF90ZXh0X3NldF90ZXh0IiwibmFtZSI6ImZvcm1fZmllbGRfdGV4dF9zZXRfdGV4dCIsImNoaWxkcmVuIjpbXSwiaXNFeHRlcm4iOmZhbHNlLCJpc0ludGVybiI6dHJ1ZX0seyJjbGFzc05hbWVzIjoidHNkLWtpbmQtbWV0aG9kIHRzZC1wYXJlbnQta2luZC1jbGFzcyIsImhyZWYiOiJFdmluY2VEb2N1bWVudF8zXzAuRXZpbmNlRG9jdW1lbnQuRG9jdW1lbnRGb3Jtc0ludGVyZmFjZS5odG1sI2dldF9mb3JtX2ZpZWxkcyIsIm5hbWUiOiJnZXRfZm9ybV9maWVsZHMiLCJjaGlsZHJlbiI6W10sImlzRXh0ZXJuIjpmYWxzZSwiaXNJbnRlcm4iOnRydWV9LHsiY2xhc3NOYW1lcyI6InRzZC1raW5kLW1ldGhvZCB0c2QtcGFyZW50LWtpbmQtY2xhc3MiLCJocmVmIjoiRXZpbmNlRG9jdW1lbnRfM18wLkV2aW5jZURvY3VtZW50LkRvY3VtZW50Rm9ybXNJbnRlcmZhY2UuaHRtbCNyZXNldF9mb3JtIiwibmFtZSI6InJlc2V0X2Zvcm0iLCJjaGlsZHJlbiI6W10sImlzRXh0ZXJuIjpmYWxzZSwiaXNJbnRlcm4iOnRydWV9XSwiY2xhc3NOYW1lcyI6ImN1cnJlbnQgdHNkLWtpbmQtY2xhc3MgdHNkLXBhcmVudC1raW5kLW5hbWVzcGFjZSIsImhyZWYiOiJFdmluY2VEb2N1bWVudF8zXzAuRXZpbmNlRG9jdW1lbnQuRG9jdW1lbnRGb3Jtc0ludGVyZmFjZS5odG1sIiwibmFtZSI6IkRvY3VtZW50Rm9ybXNJbnRlcmZhY2UifQ==