Skip to content

Latest commit

 

History

History
231 lines (117 loc) · 7.02 KB

ns-shobjidl_core-deskbandinfo.md

File metadata and controls

231 lines (117 loc) · 7.02 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NS:shobjidl_core.DESKBANDINFO
DESKBANDINFO (shobjidl_core.h)
Receives information about a band object. This structure is used with the deprecated IDeskBand::GetBandInfo method.
DBIMF_ADDTOFRONT
DBIMF_ALWAYSGRIPPER
DBIMF_BKCOLOR
DBIMF_BREAK
DBIMF_DEBOSSED
DBIMF_FIXED
DBIMF_FIXEDBMP
DBIMF_NOGRIPPER
DBIMF_NOMARGINS
DBIMF_NORMAL
DBIMF_TOPALIGN
DBIMF_UNDELETEABLE
DBIMF_USECHEVRON
DBIMF_VARIABLEHEIGHT
DBIM_ACTUAL
DBIM_BKCOLOR
DBIM_INTEGRAL
DBIM_MAXSIZE
DBIM_MINSIZE
DBIM_MODEFLAGS
DBIM_TITLE
DESKBANDINFO
DESKBANDINFO structure [Windows Shell]
_win32_DESKBANDINFO
shell.DESKBANDINFO
shobjidl_core/DESKBANDINFO
shell\DESKBANDINFO.htm
shell
f44ef8a7-b05d-4908-95eb-b07d085e0c29
12/05/2018
DBIMF_ADDTOFRONT, DBIMF_ALWAYSGRIPPER, DBIMF_BKCOLOR, DBIMF_BREAK, DBIMF_DEBOSSED, DBIMF_FIXED, DBIMF_FIXEDBMP, DBIMF_NOGRIPPER, DBIMF_NOMARGINS, DBIMF_NORMAL, DBIMF_TOPALIGN, DBIMF_UNDELETEABLE, DBIMF_USECHEVRON, DBIMF_VARIABLEHEIGHT, DBIM_ACTUAL, DBIM_BKCOLOR, DBIM_INTEGRAL, DBIM_MAXSIZE, DBIM_MINSIZE, DBIM_MODEFLAGS, DBIM_TITLE, DESKBANDINFO, DESKBANDINFO structure [Windows Shell], _win32_DESKBANDINFO, shell.DESKBANDINFO, shobjidl_core/DESKBANDINFO
shobjidl_core.h
Shobjidl.h
Windows
Windows 2000 Professional, Windows XP [desktop apps only]
Windows 2000 Server [desktop apps only]
Shobjidl.idl
Windows
DESKBANDINFO
19H1
DESKBANDINFO
shobjidl_core/DESKBANDINFO
c++
APIRef
kbSyntax
HeaderDef
shobjidl_core.h
DESKBANDINFO

DESKBANDINFO structure

-description

Receives information about a band object. This structure is used with the deprecated IDeskBand::GetBandInfo method.

-struct-fields

-field dwMask

Type: DWORD

The set of flags that determine which members of this structure are being requested by the caller. One or more of the following values:

DBIM_MINSIZE

ptMinSize is requested.

DBIM_MAXSIZE

ptMaxSize is requested.

DBIM_INTEGRAL

ptIntegral is requested.

DBIM_ACTUAL

ptActual is requested.

DBIM_TITLE

wszTitle is requested.

DBIM_MODEFLAGS

dwModeFlags is requested.

DBIM_BKCOLOR

crBkgnd is requested.

-field ptMinSize

Type: POINTL

A POINTL structure that receives the minimum size of the band object. The minimum width is given in the POINTL structure's x member and the minimum height is given in the y member.

-field ptMaxSize

Type: POINTL

A POINTL structure that receives the maximum size of the band object. The maximum height is given in the POINTL structure's y member and the x member is ignored. If the band object has no limit for its maximum height, (LONG)-1 should be used.

-field ptIntegral

Type: POINTL

A POINTL structure that receives the sizing step value (increment) in which the band object is resized. The vertical step value is given in the POINTL structure's y member and the x member is ignored.

The dwModeFlags member must contain the DBIMF_VARIABLEHEIGHT flag; otherwise, ptIntegral is ignored.

-field ptActual

Type: POINTL

A POINTL structure that receives the ideal size of the band object. The ideal width is given in the POINTL structure's x member and the ideal height is given in the y member. The band container attempts to use these values, but the band is not guaranteed to be this size.

-field wszTitle

Type: WCHAR[256]

A WCHAR buffer that receives the title of the band.

-field dwModeFlags

Type: DWORD

A value that receives a set of flags that specify the mode of operation for the band object. One or more of the following values:

DBIMF_NORMAL

The band uses default properties. The other mode flags modify this flag.

DBIMF_FIXED

Windows XP and later: The band object is of a fixed sized and position. With this flag, a sizing grip is not displayed on the band object.

DBIMF_FIXEDBMP

Windows XP and later: The band object uses a fixed bitmap (.bmp) file as its background. Note that backgrounds are not supported in all cases, so the bitmap may not be seen even when this flag is set.

DBIMF_VARIABLEHEIGHT

The height of the band object can be changed. The ptIntegral member defines the step value by which the band object can be resized.

DBIMF_UNDELETEABLE

Windows XP and later: The band object cannot be removed from the band container.

DBIMF_DEBOSSED

The band object is displayed with a sunken appearance.

DBIMF_BKCOLOR

The band is displayed with the background color specified in crBkgnd.

DBIMF_USECHEVRON

Windows XP and later: If the full band object cannot be displayed (that is, the band object is smaller than ptActual, a chevron is shown to indicate that there are more options available. These options are displayed when the chevron is clicked.

DBIMF_BREAK

Windows XP and later: The band object is displayed in a new row in the band container.

DBIMF_ADDTOFRONT

Windows XP and later: The band object is the first object in the band container.

DBIMF_TOPALIGN

Windows XP and later: The band object is displayed in the top row of the band container.

DBIMF_NOGRIPPER

Windows Vista and later: No sizing grip is ever displayed to allow the user to move or resize the band object.

DBIMF_ALWAYSGRIPPER

Windows Vista and later: A sizing grip that allows the user to move or resize the band object is always shown, even if that band object is the only one in the container.

DBIMF_NOMARGINS

Windows Vista and later: The band object should not display margins.

-field crBkgnd

Type: COLORREF

A COLORREF structure that receives the background color of the band. The dwModeFlags member must contain the DBIMF_BKCOLOR flag; otherwise, crBkgnd is ignored.