cReBar.ctl

Project: VB6GUI
Version: 3.0.0
Report Date: 08/06/2023 12:06:14

By: Yaron Goali (WISERBIT DOT COM) for Microncode.com

User Control: cReBar

Properties

BackgroundBitmap [Get] - Public (Return Datatype: String)

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets/sets the background bitmap file. Has no effect unless it is called before the rebar is created. Note: you can't recreate a rebar at run-time if you have COMCTL32.DLL version lower than 4.71.

BackgroundBitmap [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	sFile	String

BandChevron [Get] - Public (Return Datatype: Boolean)

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lBand	Long

Procedure Attributes

Attribute	Value
Description	Gets/sets whether a band will show a chevron if it is sized too small for the contents to fit. (COMCTL32.DLL v5 or higher only)

BandChevron [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lBand	Long
	ByVal	bState	Boolean

BandChildEdge [Get] - Public (Return Datatype: Boolean)

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lBand	Long

Procedure Attributes

Attribute	Value
Description	Gets/sets whether a band draws a narrow internal border around the child control.

BandChildEdge [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lBand	Long
	ByVal	bState	Boolean

BandChildIdealWidth [Get] - Public (Return Datatype: Long)

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lBand	Long

BandChildIdealWidth [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lBand	Long
		lWidth	Long

BandChildMaxHeight [Get] - Public (Return Datatype: Long)

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lBand	Long

Procedure Attributes

Attribute	Value
Description	Gets/sets the maximum height a band can size to (COMCTL32.DLL v5 or higher only)

BandChildMaxHeight [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lBand	Long
		lHeight	Long

BandChildMinHeight [Get] - Public (Return Datatype: Long)

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lBand	Long

Procedure Attributes

Attribute	Value
Description	Gets/sets the minimum height of a rebar band.

BandChildMinHeight [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lBand	Long
		lHeight	Long

BandChildMinWidth [Get] - Public (Return Datatype: Long)

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lBand	Long

Procedure Attributes

Attribute	Value
Description	Gets/sets the minimum width of rebar band.

BandChildMinWidth [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lBand	Long
		lWidth	Long

BandCount [Get] - Public (Return Datatype: Long)

No Parameters

Procedure Attributes

Attribute	Value
Description	Returns the number of bands in the rebar.

BandData [Get] - Public (Return Datatype: Variant)

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	wId	Long

Procedure Attributes

Attribute	Value
Description	Gets/sets a variant value associated with a band in the rebar.

BandGripper [Get] - Public (Return Datatype: Boolean)

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lBand	Long

Procedure Attributes

Attribute	Value
Description	Gets/sets whether a rebar band has a gripper or not. (COMCTL32.DLL v5 or higher only)

BandGripper [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lBand	Long
	ByVal	bState	Boolean

BandIDForIndex [Get] - Public (Return Datatype: Long)

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lIndex	Long

Procedure Attributes

Attribute	Value
Description	Gets the ID of band given its 0-based index in the rebar.

BandIndexForData [Get] - Public (Return Datatype: Long)

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	vData	Variant

Procedure Attributes

Attribute	Value
Description	Returns the index of a band given the band's key.

BandIndexForId [Get] - Public (Return Datatype: Long)

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	wId	Long

Procedure Attributes

Attribute	Value
Description	Returns the internal index of a band given the band's id.

BandVisible [Get] - Public (Return Datatype: Boolean)

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lBand	Long

Procedure Attributes

Attribute	Value
Description	Gets/sets whether a rebar band is visible or not. Not available for COMCTL32.DLL version below 4.71.

BandVisible [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lBand	Long
	ByVal	bState	Boolean

HasBitmap [Get] - Public (Return Datatype: Boolean)

No Parameters

Procedure Attributes

Attribute	Value
Description	Returns whether a background bitmap is loaded into the rebar or not.

hWnd [Get] - Public (Return Datatype: Long)

No Parameters

Procedure Attributes

Attribute	Value
Description	Returns the window handle of the control. Use RebarhWnd to get the handle of the Rebar itself.

ImageFile [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	sFile	String

Procedure Attributes

Attribute	Value
Description	Sets a bitmap file to be used as the source of the rebar's background bitmap.

ImagePicture [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	picThis	StdPicture

Procedure Attributes

Attribute	Value
Description	ets a picture object to be used as the source of the rebar's background bitmap.

ImagePicture [Set] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	picThis	StdPicture

ImageResourcehInstance [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	hInstance	Long

Procedure Attributes

Attribute	Value
Description	Specifies the hInstance from which to load the resource set by the ImageResourceID property.

ImageResourceID [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lResourceId	Long

Procedure Attributes

Attribute	Value
Description	Sets a resource id to be used to be used as the source of the rebar's background bitmap.

ImageSource [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	eType	ECRBImageSourceTypes

Procedure Attributes

Attribute	Value
Description	Specifies which type of bitmap source (file, picture or resource) should be used as the source of the rebar's background bitmap.

Position [Get] - Public (Return Datatype: ERBPositionConstants)

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets/sets the orientation of the rebar on its container.
Attributes	Don't show in property browser

Position [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	ePosition	ERBPositionConstants

RebarHeight [Get] - Public (Return Datatype: Long)

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets the current height of the rebar.

RebarHwnd [Get] - Public (Return Datatype: Long)

No Parameters

Procedure Attributes

Attribute	Value
Description	Returns the windows handle of the Rebar window.

RebarWidth [Get] - Public (Return Datatype: Long)

No Parameters

RowCount [Get] - Public (Return Datatype: Long)

No Parameters

RowHeight [Get] - Public (Return Datatype: Long)

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lBand	Long

Visible [Get] - Public (Return Datatype: Boolean)

No Parameters

Procedure Attributes

Attribute	Value
Description	Gets/sets whether the entire rebar will be visible or not.

Visible [Let] - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	bState	Boolean

Subroutines

Autosize - Public

No Parameters

Procedure Attributes

Attribute	Value
Description	Attempts to automatically move the Rebar bands so they best fit the specified rectangle (in pixels relative to the rebar's container). Not available for COMCTL32.DLL version below 4.71.

BandChildResized - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lBand	Long
	ByVal	lWidth	Long
	ByVal	lHeight	Long

BandMaximise - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lBand	Long

Procedure Attributes

Attribute	Value
Description	Maximises a rebar band in the current layout.

BandMinimise - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lBand	Long

Procedure Attributes

Attribute	Value
Description	Minimises a rebar band in the current layout.

BandMove - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lBand	Long
	ByVal	lIndexTo	Long

Procedure Attributes

Attribute	Value
Description	Moves a band from one position to another. All bands in lower positions are moved up. Not available for COMCTL32.DLL version below 4.71.

DestroyRebar - Public

No Parameters

Procedure Attributes

Attribute	Value
Description	Removes all bands from a rebar and clears all resources associated with it.

DestroyRebarDontDestroyChildren - Public

No Parameters

Procedure Attributes

Attribute	Value
Description	Removes all bands from a rebar and clears all resources associated with it without posting a destroy window message to any children.

GetBandRectangle - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lBand	Long
Optional	ByRef	lLeft	Long
Optional	ByRef	lTop	Long
Optional	ByRef	lRight	Long
Optional	ByRef	lBottom	Long

Procedure Attributes

Attribute	Value
Description	Returns the internal bounding rectangle for a rebar band. Not available for COMCTL32.DLL version below 4.71.

RebarSize - Public

No Parameters

Procedure Attributes

Attribute	Value
Description	Sizes the rebar to the parent object.

RemoveAllRebarBands - Public

No Parameters

Procedure Attributes

Attribute	Value
Description	Removes all bands from the rebar. To prevent controls not terminating when a form unloads because they are contained by a different parent, call this method.

RemoveBand - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	lBand	Long

Procedure Attributes

Attribute	Value
Description	Removes a specified band from the rebar control.

RestoreLayout - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	sXml	String
	ByRef	sData()	String
	ByRef	lhWnd()	Long

Functions

AddBandByHwnd - Public (Return Datatype: Long)

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	hWnd	Long
Optional	ByVal	sBandText	String("")
Optional	ByVal	bBreakLine	Boolean(True)
Optional	ByVal	bFixedSize	Boolean(False)
Optional	ByVal	vData	Variant

Procedure Attributes

Attribute	Value
Description	Adds a band to the rebar and sets the band to contain the window with the specified hWnd.

AddResizeObject - Public (Return Datatype: Variant)

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	hWndParent	Long
	ByVal	hWnd	Long
	ByVal	ePosition	ERBPositionConstants

Procedure Attributes

Attribute	Value
Description	Adds a control to the list of objects to be considered when resizing a rebar on screen. Other rebars are automatically taken into account.

CreateRebar - Public (Return Datatype: Boolean)

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	hWndParent	Long

Procedure Attributes

Attribute	Value
Description	Initialises a rebar for use and allows you to specify the host window for the rebar. For a standard form, this should be the form. For an MDI form, this should be a PictureBox aligned to the top of the MDI form.

SaveLayout - Public (Return Datatype: String)

No Parameters

Event Declares

BandChildResize - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	wId	Long
	ByVal	lBandLeft	Long
	ByVal	lBandTop	Long
	ByVal	lBandRight	Long
	ByVal	lBandBottom	Long
	ByRef	lChildLeft	Long
	ByRef	lChildTop	Long
	ByRef	lChildRight	Long
	ByRef	lChildBottom	Long

BeginBandDrag - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	wId	Long
	ByRef	bCancel	Boolean

ChevronPushed - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	wId	Long
	ByVal	lLeft	Long
	ByVal	lTop	Long
	ByVal	lRight	Long
	ByVal	lBottom	Long

EndBandDrag - Public

Optional	ByVal/ByRef	Variable	Datatype
	ByVal	wId	Long

HeightChanged - Public

Optional	ByVal/ByRef	Variable	Datatype
		lNewHeight	Long

LayoutChanged - Public

No Parameters