DESKBANDINFO Structure

Contains and receives information for a band object. This structure is used with the IDeskBand::GetBandInfo method.

Syntax

typedef struct {
    DWORD dwMask;
    POINTL ptMinSize;
    POINTL ptMaxSize;
    POINTL ptIntegral;
    POINTL ptActual;
    WCHAR wszTitle[256];
    DWORD dwModeFlags;
    COLORREF crBkgnd;
} DESKBANDINFO;

Members

dwMask
Set of flags that determine which members of this structure are being requested. This will be a combination of the following values.
DBIM_MINSIZE
ptMinSize is being requested.
DBIM_MAXSIZE
ptMaxSize is being requested.
DBIM_INTEGRAL
ptIntegral is being requested.
DBIM_ACTUAL
ptActual is being requested.
DBIM_TITLE
wszTitle is being requested.
DBIM_MODEFLAGS
dwModeFlags is being requested.
DBIM_BKCOLOR
crBkgnd is being requested.
ptMinSize
POINTL structure that receives the minimum size of the band object. The minimum width is placed in the x member, and the minimum height is placed in the y member.
ptMaxSize
POINTL structure that receives the maximum size of the band object. The maximum height is placed in the y member and the x member is ignored. If there is no limit for the maximum height, (LONG)-1 should be used.
ptIntegral
POINTL structure that receives the sizing step value of the band object. The vertical step value is placed in the y member, and the x member is ignored. The step value determines in what increments the band will be resized. This member is ignored if dwModeFlags does not contain DBIMF_VARIABLEHEIGHT.
ptActual
POINTL structure that receives the ideal size of the band object. The ideal width is placed in the x member, and the ideal height is placed in the y member. The band container will attempt to use these values, but the band is not guaranteed to be this size.
wszTitle
WCHAR buffer that receives the title of the band.
dwModeFlags
Value that receives a set of flags that define the mode of operation for the band object. This must be one or a combination of the following values.
DBIMF_NORMAL
Band is normal in all respects. The other mode flags modify this flag.
DBIMF_VARIABLEHEIGHT
Height of the band object can be changed. The ptIntegral member defines the step value by which the band object can be resized.
DBIMF_DEBOSSED
Band object is displayed with a sunken appearance.
DBIMF_BKCOLOR
Band will be displayed with the background color specified in crBkgnd.
crBkgnd
Value that receives the background color of the band. This member is ignored if dwModeFlags does not contain the DBIMF_BKCOLOR flag.

Structure Information

Header shlobj.h
Minimum availability Internet Explorer 4.0
Minimum operating systems Windows NT 4.0, Windows 95

Community Additions

Show: