PdfFormField

Enum PdfFormField 

Source
pub enum PdfFormField<'a> {
    PushButton(PdfFormPushButtonField<'a>),
    Checkbox(PdfFormCheckboxField<'a>),
    RadioButton(PdfFormRadioButtonField<'a>),
    ComboBox(PdfFormComboBoxField<'a>),
    ListBox(PdfFormListBoxField<'a>),
    Signature(PdfFormSignatureField<'a>),
    Text(PdfFormTextField<'a>),
    Unknown(PdfFormUnknownField<'a>),
}
Expand description

A single interactive form field in a PdfForm.

Variants§

Implementations§

Source§

impl<'a> PdfFormField<'a>

Source

pub fn field_type(&self) -> PdfFormFieldType

The type of this PdfFormField.

Source

pub fn as_push_button_field(&self) -> Option<&PdfFormPushButtonField<'_>>

Returns a reference to the underlying PdfFormPushButtonField for this PdfFormField, if this form field has a field type of PdfFormField::PushButton.

Source

pub fn as_checkbox_field(&self) -> Option<&PdfFormCheckboxField<'_>>

Returns a reference to the underlying PdfFormCheckboxField for this PdfFormField, if this form field has a field type of PdfFormField::Checkbox.

Source

pub fn as_checkbox_field_mut(&mut self) -> Option<&mut PdfFormCheckboxField<'a>>

Returns a mutable reference to the underlying PdfFormCheckboxField for this PdfFormField, if this form field has a field type of PdfFormField::Checkbox.

Source

pub fn as_radio_button_field(&self) -> Option<&PdfFormRadioButtonField<'_>>

Returns a reference to the underlying PdfFormRadioButtonField for this PdfFormField, if this form field has a field type of PdfFormField::RadioButton.

Source

pub fn as_radio_button_field_mut( &mut self, ) -> Option<&mut PdfFormRadioButtonField<'a>>

Returns a mutable reference to the underlying PdfFormRadioButtonField for this PdfFormField, if this form field has a field type of PdfFormField::RadioButton.

Source

pub fn as_combo_box_field(&self) -> Option<&PdfFormComboBoxField<'_>>

Returns a reference to the underlying PdfFormComboBoxField for this PdfFormField, if this form field has a field type of PdfFormField::ComboBox.

Source

pub fn as_list_box_field(&self) -> Option<&PdfFormListBoxField<'_>>

Returns a reference to the underlying PdfFormListBoxField for this PdfFormField, if this form field has a field type of PdfFormField::ListBox.

Source

pub fn as_signature_field(&self) -> Option<&PdfFormSignatureField<'_>>

Returns a reference to the underlying PdfFormSignatureField for this PdfFormField, if this form field has a field type of PdfFormField::Signature.

Source

pub fn as_text_field(&self) -> Option<&PdfFormTextField<'_>>

Returns a reference to the underlying PdfFormTextField for this PdfFormField, if this form field has a field type of PdfFormField::Text.

Source

pub fn as_text_field_mut(&mut self) -> Option<&mut PdfFormTextField<'a>>

Returns a mutable reference to the underlying PdfFormTextField for this PdfFormField, if this form field has a field type of PdfFormField::Text.

Source

pub fn as_unknown_field(&self) -> Option<&PdfFormUnknownField<'_>>

Returns a reference to the underlying PdfFormUnknownField for this PdfFormField, if this form field has a field type of PdfFormField::Unknown.

Trait Implementations§

Source§

impl<'a> From<PdfFormCheckboxField<'a>> for PdfFormField<'a>

Source§

fn from(field: PdfFormCheckboxField<'a>) -> Self

Converts to this type from the input type.
Source§

impl<'a> From<PdfFormComboBoxField<'a>> for PdfFormField<'a>

Source§

fn from(field: PdfFormComboBoxField<'a>) -> Self

Converts to this type from the input type.
Source§

impl<'a> From<PdfFormListBoxField<'a>> for PdfFormField<'a>

Source§

fn from(field: PdfFormListBoxField<'a>) -> Self

Converts to this type from the input type.
Source§

impl<'a> From<PdfFormPushButtonField<'a>> for PdfFormField<'a>

Source§

fn from(field: PdfFormPushButtonField<'a>) -> Self

Converts to this type from the input type.
Source§

impl<'a> From<PdfFormRadioButtonField<'a>> for PdfFormField<'a>

Source§

fn from(field: PdfFormRadioButtonField<'a>) -> Self

Converts to this type from the input type.
Source§

impl<'a> From<PdfFormSignatureField<'a>> for PdfFormField<'a>

Source§

fn from(field: PdfFormSignatureField<'a>) -> Self

Converts to this type from the input type.
Source§

impl<'a> From<PdfFormTextField<'a>> for PdfFormField<'a>

Source§

fn from(field: PdfFormTextField<'a>) -> Self

Converts to this type from the input type.
Source§

impl<'a> From<PdfFormUnknownField<'a>> for PdfFormField<'a>

Source§

fn from(field: PdfFormUnknownField<'a>) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl<'a> Freeze for PdfFormField<'a>

§

impl<'a> !RefUnwindSafe for PdfFormField<'a>

§

impl<'a> !Send for PdfFormField<'a>

§

impl<'a> !Sync for PdfFormField<'a>

§

impl<'a> Unpin for PdfFormField<'a>

§

impl<'a> !UnwindSafe for PdfFormField<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
Source§

impl<'a, T> PdfFormFieldCommon for T
where T: PdfFormFieldPrivate<'a>,

Source§

fn name(&self) -> Option<String>

Returns the name of this PdfFormField, if any.
Source§

fn appearance_stream(&self) -> Option<String>

Returns the name of the currently set appearance stream for this PdfFormField, if any.
Source§

fn appearance_mode_value( &self, appearance_mode: PdfAppearanceMode, ) -> Option<String>

Returns the value currently set for the given appearance mode for this PdfFormField, if any.
Source§

fn is_read_only(&self) -> bool

Returns true if the value of this PdfFormField is read only. Read more
Source§

fn set_is_read_only(&mut self, is_read_only: bool) -> Result<(), PdfiumError>

Controls whether or not the value of this PdfFormField is read only.
Source§

fn is_required(&self) -> bool

Returns true if this PdfFormField must have a value at the time it is exported by any “submit form” action. Read more
Source§

fn set_is_required(&mut self, is_required: bool) -> Result<(), PdfiumError>

Controls whether or not this PdfFormField must have a value at the time it is exported by any “submit form” action. Read more
Source§

fn is_exported_on_submit(&self) -> bool

Returns true if the value of this PdfFormField will be exported by any “submit form” action. Read more
Source§

fn set_is_exported_on_submit( &mut self, is_exported: bool, ) -> Result<(), PdfiumError>

Controls whether or not the value of this PdfFormField will be exported by any “submit form” action. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.