Skip to main content

FormControlConfig

Struct FormControlConfig 

Source
pub struct FormControlConfig {
Show 14 fields pub control_type: FormControlType, pub cell: String, pub width: Option<f64>, pub height: Option<f64>, pub text: Option<String>, pub macro_name: Option<String>, pub cell_link: Option<String>, pub checked: Option<bool>, pub min_value: Option<u32>, pub max_value: Option<u32>, pub increment: Option<u32>, pub page_increment: Option<u32>, pub current_value: Option<u32>, pub three_d: Option<bool>,
}
Expand description

Configuration for adding a form control to a worksheet.

Fields§

§control_type: FormControlType

The type of form control.

§cell: String

Anchor cell (top-left corner), e.g. “B2”.

§width: Option<f64>

Width in points. Uses a sensible default per control type if None.

§height: Option<f64>

Height in points. Uses a sensible default per control type if None.

§text: Option<String>

Display text (Button, CheckBox, OptionButton, GroupBox, Label).

§macro_name: Option<String>

VBA macro name (Button only).

§cell_link: Option<String>

Linked cell reference for value binding (CheckBox, OptionButton, SpinButton, ScrollBar).

§checked: Option<bool>

Initial checked state (CheckBox, OptionButton).

§min_value: Option<u32>

Minimum value (SpinButton, ScrollBar).

§max_value: Option<u32>

Maximum value (SpinButton, ScrollBar).

§increment: Option<u32>

Step increment (SpinButton, ScrollBar).

§page_increment: Option<u32>

Page increment (ScrollBar only).

§current_value: Option<u32>

Current value (SpinButton, ScrollBar).

§three_d: Option<bool>

Enable 3D shading (default true for most controls).

Implementations§

Source§

impl FormControlConfig

Source

pub fn button(cell: &str, text: &str) -> Self

Create a Button configuration.

Source

pub fn checkbox(cell: &str, text: &str) -> Self

Create a CheckBox configuration.

Source

pub fn spin_button(cell: &str, min: u32, max: u32) -> Self

Create a SpinButton configuration.

Source

pub fn scroll_bar(cell: &str, min: u32, max: u32) -> Self

Create a ScrollBar configuration.

Source

pub fn validate(&self) -> Result<()>

Validate the configuration for correctness.

Trait Implementations§

Source§

impl Clone for FormControlConfig

Source§

fn clone(&self) -> FormControlConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for FormControlConfig

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.