Struct ms_oforms::controls::user_form::ole_site_concrete::OleSiteConcreteControl

pub struct OleSiteConcreteControl {

    pub id: i32,
    pub help_context_id: i32,
    pub bit_flags: SiteFlags,
    pub object_stream_size: u32,
    pub tab_index: i16,
    pub clsid_cache_index: Clsid,
    pub group_id: Option<NonZeroU16>,
    pub name: String,
    pub tag: String,
    pub site_position: Position,
    pub control_tip_text: String,
    pub runtime_lic_key: String,
    pub control_source: String,
    pub row_source: String,
}

Specifies properties stored for each embedded control in a UserForm control.

Fields

id: i32

help_context_id: i32

bit_flags: SiteFlags

A SITE_FLAG that specifies Boolean properties of an embedded control on a form.

The file format default is 0x00000033, which means that the following flags are set to TRUE: fTabStop, fVisible, fStreamed, and fAutoSize.

object_stream_size: u32

An unsigned integer that specifies the size, in bytes, of an embedded control that is persisted to the Object stream of a Form.

The file format default is 0x00000000.

tab_index: i16

A signed integer that specifies the index of an embedded control in the tab order of a form. Values less than zero specify an invalid index in the tab order.

The file format default is 0xFFFF, or –1, an invalid index.

clsid_cache_index: Clsid

An unsigned integer that specifies the type of a FormEmbeddedActiveXControl on a parent control. A value less than 0x7FFF specifies an index value for FormEmbeddedActiveXControlCached. A value of 0x7FFF specifies that the index is invalid. A value greater than or equal to 0x8000 specifies an index into the FormSiteData.ClassTable of the FormControl in which the control is embedded, where information about the control is specified by the entry in ClassTable that corresponds to the value of this property minus 0x8000.

The file format default is 0x7FFF, an invalid index.

group_id: Option<NonZeroU16>

An unsigned integer that specifies the control group of a control. A value of zero specifies that the control is not in a control group. A value greater than zero specifies the unique identifier of the control group to which the control belongs. All controls that have the same value for this property are in the same control group.

The file format default is 0x0000.

name: String

An fmString that specifies the name of a control.

The file format default is a zero-length string.

tag: String

An fmString that is associated with a control and that contains data entered by the user. SHOULD be ignored.<13>

The file format default is a zero-length string.

site_position: Position

An fmPosition that specifies the location of the top-left corner of an embedded control on a form, relative to the top-left corner of the LogicalSize of the form. The file format default is (0, 0), which specifies that the top-left corner of the embedded control is at the top-left corner of the form.

control_tip_text: String

An fmString that specifies the tooltip for the control.

The file format default is a zero-length string.

runtime_lic_key: String

An fmString that specifies the license key of a control.

The file format default is a zero-length string.

control_source: String

An fmString that specifies a cell in a worksheet that sets the Value property of a control when the control is loaded and to which the new value of the Value property is stored after it changes in the control.

The file format default is a zero-length string.

row_source: String

An fmString that specifies the source for the list of values in a ComboBox or ListBox that is embedded in a form. This property MUST NOT be set for other controls. The format of the string is a range of cells in a worksheet.

The file format default is a zero-length string.

Trait Implementations

impl Clone for OleSiteConcreteControl

fn clone(&self) -> OleSiteConcreteControl

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OleSiteConcreteControl

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

Formats the value using the given formatter.

impl PartialEq<OleSiteConcreteControl> for OleSiteConcreteControl

fn eq(&self, other: &OleSiteConcreteControl) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for OleSiteConcreteControl

impl StructuralEq for OleSiteConcreteControl

impl StructuralPartialEq for OleSiteConcreteControl