pub struct PdfFormListBoxField<'a> { /* private fields */ }Expand description
A single PdfFormField of type PdfFormFieldType::ListBox. The form field object defines an interactive drop-down list widget that allows the user to select a value from a list of options.
Form fields in Pdfium are wrapped inside page annotations of type PdfPageAnnotationType::Widget or PdfPageAnnotationType::XfaWidget. User-specified values can be retrieved directly from each form field object by unwrapping the form field from the annotation, or in bulk from the PdfForm::field_values() function.
Implementations§
Source§impl<'a> PdfFormListBoxField<'a>
impl<'a> PdfFormListBoxField<'a>
Sourcepub fn bindings(&self) -> &'a dyn PdfiumLibraryBindings
pub fn bindings(&self) -> &'a dyn PdfiumLibraryBindings
Returns the PdfiumLibraryBindings used by this PdfFormListBoxField object.
Sourcepub fn options(&self) -> &PdfFormFieldOptions<'_>
pub fn options(&self) -> &PdfFormFieldOptions<'_>
Returns the collection of selectable options in this PdfFormListBoxField.
Sourcepub fn value(&self) -> Option<String>
pub fn value(&self) -> Option<String>
Returns the displayed label for the currently selected option in this PdfFormListBoxField object, if any.
Sourcepub fn is_sorted(&self) -> bool
pub fn is_sorted(&self) -> bool
Returns true if the option items of this PdfFormListBoxField should be sorted
alphabetically.
This flag is intended for use by form authoring tools, not by PDF viewer applications.
Sourcepub fn is_multiselect(&self) -> bool
pub fn is_multiselect(&self) -> bool
Returns true if more than one of the option items in this PdfFormListBoxField
may be selected simultaneously. If false, only one item at a time may be selected.
This flag was added in PDF version 1.4.
Sourcepub fn is_commit_on_selection_change(&self) -> bool
pub fn is_commit_on_selection_change(&self) -> bool
Returns true if any new value is committed to this PdfFormListBoxField
as soon as a selection is made with the pointing device. This option enables
applications to perform an action once a selection is made, without requiring
the user to exit the field. If false, any new value is not committed until the
user exits the field.
This flag was added in PDF version 1.5.
Trait Implementations§
Source§impl<'a> From<PdfFormListBoxField<'a>> for PdfFormField<'a>
impl<'a> From<PdfFormListBoxField<'a>> for PdfFormField<'a>
Source§fn from(field: PdfFormListBoxField<'a>) -> Self
fn from(field: PdfFormListBoxField<'a>) -> Self
Auto Trait Implementations§
impl<'a> Freeze for PdfFormListBoxField<'a>
impl<'a> !RefUnwindSafe for PdfFormListBoxField<'a>
impl<'a> !Send for PdfFormListBoxField<'a>
impl<'a> !Sync for PdfFormListBoxField<'a>
impl<'a> Unpin for PdfFormListBoxField<'a>
impl<'a> !UnwindSafe for PdfFormListBoxField<'a>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<'a, T> PdfFormFieldCommon for Twhere
T: PdfFormFieldPrivate<'a>,
impl<'a, T> PdfFormFieldCommon for Twhere
T: PdfFormFieldPrivate<'a>,
Source§fn appearance_stream(&self) -> Option<String>
fn appearance_stream(&self) -> Option<String>
Source§fn appearance_mode_value(
&self,
appearance_mode: PdfAppearanceMode,
) -> Option<String>
fn appearance_mode_value( &self, appearance_mode: PdfAppearanceMode, ) -> Option<String>
Source§fn is_read_only(&self) -> bool
fn is_read_only(&self) -> bool
Source§fn is_required(&self) -> bool
fn is_required(&self) -> bool
true if this PdfFormField must have a value at the time it is exported
by any “submit form” action. Read moreSource§fn is_exported_on_submit(&self) -> bool
fn is_exported_on_submit(&self) -> bool
true if the value of this PdfFormField will be exported by any
“submit form” action. Read more