DBID Command Flags enumeration

These command IDs can be sent to the band object's container with IOleCommandTarget::Exec.

Syntax


enum tagDESKBANDCID {
  DBID_BANDINFOCHANGED  = 0, 
  DBID_SHOWONLY         = 1, 
  DBID_MAXIMIZEBAND     = 2, 
  DBID_PUSHCHEVRON      = 3 

};

Constants

DBID_BANDINFOCHANGED

Updates all bands or a specific band.

  • To update all bands: Set pvaIn to NULL.
  • To update a specific band: Set pvaIn->lVal to the ID of the band to be updated, and pvaIn->vt to VT_I4.
DBID_SHOWONLY

Turns other bands in the container on or off. Set pvaIn->vt to VT_UNKNOWN, and set pvaIn->punkVal to one of the following values.

ValueResult
pUnkA pointer to the band object's IUnknown interface. The desk band pointed to is shown; all other desk bands are hidden.
0Hides all desk bands.
1Shows all desk bands.

 

DBID_MAXIMIZEBAND

Maximize the band. Set pvaIn->ulVal to the ID of the band to be maximized, and set pvaIn->vt to VT_UI4.

DBID_PUSHCHEVRON

Version 5. Displays a push chevron on a desk band. Set pvaIn->vt to VT_I4, set pvaIn->lVal to the ID of the desk band, and set the IOleCommandTarget::Exec method's nCmdExecOpt parameter to the band identifier received in the most recent call to IDeskBand::GetBandInfo. The container sends an RB_PUSHCHEVRON message, and the band object receives an RBN_CHEVRONPUSHED notification that prompts it to display the chevron. The band ID is passed back to the band object in the lParam parameter of the RBN_CHEVRONPUSHED message.

Remarks

Set the pguidCmdGroup parameter of the IOleCommandTarget::Exec method to CGID_DeskBand, the pvaIn parameter to the value indicated in the command description, and the nCmdID parameter to one of the command values listed above.

Requirements

Header

Shobjidl.h

See also

Creating Custom Explorer Bars, Tool Bands, and Desk Bands

 

 

Show: