pub trait PdfFormFieldCommon {
// Required methods
fn name(&self) -> Option<String>;
fn appearance_stream(&self) -> Option<String>;
fn appearance_mode_value(
&self,
appearance_mode: PdfAppearanceMode,
) -> Option<String>;
fn is_read_only(&self) -> bool;
fn set_is_read_only(
&mut self,
is_read_only: bool,
) -> Result<(), PdfiumError>;
fn is_required(&self) -> bool;
fn set_is_required(&mut self, is_required: bool) -> Result<(), PdfiumError>;
fn is_exported_on_submit(&self) -> bool;
fn set_is_exported_on_submit(
&mut self,
is_exported: bool,
) -> Result<(), PdfiumError>;
}Expand description
Functionality common to all PdfFormField objects, regardless of their PdfFormFieldType.
Required Methods§
Sourcefn name(&self) -> Option<String>
fn name(&self) -> Option<String>
Returns the name of this PdfFormField, if any.
Sourcefn appearance_stream(&self) -> Option<String>
fn appearance_stream(&self) -> Option<String>
Returns the name of the currently set appearance stream for this PdfFormField, if any.
Sourcefn appearance_mode_value(
&self,
appearance_mode: PdfAppearanceMode,
) -> Option<String>
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.
Sourcefn is_read_only(&self) -> bool
fn is_read_only(&self) -> bool
Returns true if the value of this PdfFormField is read only.
Users may not change the value of read-only fields, and any associated widget annotations will not interact with the user; that is, they will not respond to mouse clicks or change their appearance in response to mouse motions.
Sourcefn set_is_read_only(&mut self, is_read_only: bool) -> Result<(), PdfiumError>
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.
Sourcefn is_required(&self) -> bool
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.
For more information on “submit form” actions, refer to Section 8.6.4 of The PDF Reference (Sixth Edition, PDF Format 1.7), starting on page 702.
Sourcefn set_is_required(&mut self, is_required: bool) -> Result<(), PdfiumError>
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.
For more information on “submit form” actions, refer to Section 8.6.4 of The PDF Reference (Sixth Edition, PDF Format 1.7), starting on page 702.
Sourcefn is_exported_on_submit(&self) -> bool
fn is_exported_on_submit(&self) -> bool
Returns true if the value of this PdfFormField will be exported by any
“submit form” action.
For more information on “submit form” actions, refer to Section 8.6.4 of The PDF Reference (Sixth Edition, PDF Format 1.7), starting on page 702.
Sourcefn set_is_exported_on_submit(
&mut self,
is_exported: bool,
) -> Result<(), PdfiumError>
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.
For more information on “submit form” actions, refer to Section 8.6.4 of The PDF Reference Manual, version 1.7, starting on page 702.