A control that is embedded in a VBA user form or in another container control in a VBA user form. More...

#include <vbacontrol.hxx>

Inheritance diagram for oox::ole::VbaFormControl:

Collaboration diagram for oox::ole::VbaFormControl:

Public Member Functions
	VbaFormControl ()

virtual	~VbaFormControl ()

void	importModelOrStorage (BinaryInputStream &rInStrm, StorageBase &rStrg, const AxClassTable &rClassTable)
	Imports the model from the passed stream or storage, depending on the control's type. More...

OUString	getControlName () const
	Returns the programmatical name of the control. More...

void	createAndConvert (sal_Int32 nCtrlIndex, const css::uno::Reference< css::container::XNameContainer > &rxParentNC, const ControlConverter &rConv) const
	Creates the UNO control model, inserts it into the passed container, and converts all control properties. More...

Protected Member Functions
void	importControlModel (BinaryInputStream &rInStrm, const AxClassTable &rClassTable)
	Creates and imports the control model containing properties of the control. More...

void	importStorage (StorageBase &rStrg, const AxClassTable &rClassTable)
	Creates and imports the control model, and imports all embedded controls from the passed substorage. More...

bool	convertProperties (const css::uno::Reference< css::awt::XControlModel > &rxCtrlModel, const ControlConverter &rConv, sal_Int32 nCtrlIndex) const
	Converts all control properties, and inserts and converts embedded controls. More...

Protected Attributes
VbaSiteModelRef	mxSiteModel
	Common control properties. More...

ControlModelRef	mxCtrlModel
	Specific control properties. More...

Private Types
typedef RefVector< VbaFormControl >	VbaFormControlVector

typedef VbaFormControlVector::value_type	VbaFormControlRef

Private Member Functions
void	createControlModel (const AxClassTable &rClassTable)
	Creates the control model according to the current site model. More...

bool	importSiteModel (BinaryInputStream &rInStrm)
	Imports the site model data containing common properties of the control. More...

void	importEmbeddedSiteModels (BinaryInputStream &rInStrm)
	Imports the site models of all embedded controls from the 'f' stream. More...

void	finalizeEmbeddedControls ()

void	moveRelative (const AxPairData &rDistance)
	Moves the control relative to its current position by the passed distance. More...

void	moveEmbeddedToAbsoluteParent ()
	Moves all embedded controls from their relative position in this control to an absolute position in the parent of this control. More...

Static Private Member Functions
static bool	compareByTabIndex (const VbaFormControlRef &rxLeft, const VbaFormControlRef &rxRight)
	Functor for comparing controls by their tab index. More...

Private Attributes
VbaFormControlVector	maControls
	All embedded form controls. More...

AxClassTable	maClassTable
	Class identifiers for exotic embedded controls. More...

Detailed Description

A control that is embedded in a VBA user form or in another container control in a VBA user form.

The control may be a 'simple' control with its data stored in the 'o' stream, or it may be a container control with its data stored in an own substorage.

Definition at line 117 of file vbacontrol.hxx.

Member Typedef Documentation

◆ VbaFormControlRef

typedef VbaFormControlVector::value_type oox::ole::VbaFormControl::VbaFormControlRef

private

Definition at line 155 of file vbacontrol.hxx.

◆ VbaFormControlVector

typedef RefVector< VbaFormControl > oox::ole::VbaFormControl::VbaFormControlVector

private

Definition at line 154 of file vbacontrol.hxx.

Constructor & Destructor Documentation

◆ VbaFormControl()

oox::ole::VbaFormControl::VbaFormControl ( )

explicit

Definition at line 317 of file vbacontrol.cxx.

◆ ~VbaFormControl()

oox::ole::VbaFormControl::~VbaFormControl ( )

virtual

Definition at line 321 of file vbacontrol.cxx.

Member Function Documentation

◆ compareByTabIndex()

bool oox::ole::VbaFormControl::compareByTabIndex	(	const VbaFormControlRef &	rxLeft,
		const VbaFormControlRef &	rxRight
	)

staticprivate

Functor for comparing controls by their tab index.

Definition at line 721 of file vbacontrol.cxx.

References SAL_MAX_INT32.

Referenced by finalizeEmbeddedControls().

◆ convertProperties()

bool oox::ole::VbaFormControl::convertProperties	(	const css::uno::Reference< css::awt::XControlModel > &	rxCtrlModel,
		const ControlConverter &	rConv,
		sal_Int32	nCtrlIndex
	)		const

protected

Converts all control properties, and inserts and converts embedded controls.

Definition at line 488 of file vbacontrol.cxx.

References oox::ole::ControlConverter::bindToSources(), createAndConvert(), Exception, oox::RefVector< ObjType >::forEachMemWithIndex(), maControls, mxCtrlModel, mxSiteModel, and oox::PropertySet::setProperties().

Referenced by createAndConvert(), and oox::ole::VbaUserForm::importForm().

◆ createAndConvert()

void oox::ole::VbaFormControl::createAndConvert	(	sal_Int32	nCtrlIndex,
		const css::uno::Reference< css::container::XNameContainer > &	rxParentNC,
		const ControlConverter &	rConv
	)		const