Share

AcApStatusBar::Remove

C++

virtual BOOL Remove(
    AcTrayItem* pTrayItem, 
    BOOL bUpdate = TRUE
) = 0;

Description

This function removes a tray item from the status bar.

To prevent screen flicker when removing multiple tray items, set bUpdate to false. When you are finished removing tray items, call AcApStatusBar::Update() to update the display. The AcPane::OnDelete() callback method will not be called until the display is updated and the tray item is actually removed from the status bar.

Note

If this function is called with bUpdate set to false, the tray item will remain in the status bar array count until the next call to AcStatusBar::Update().

Returns true if the tray item is successfully removed. If the tray item cannot be removed or is not found, this function returns false.

Parameters

Parameters Description
pTrayItem Input pointer to the tray item object to remove
bUpdate Input Boolean: true to remove the tray item immediately and update the appearance of the status bar; false if the tray item should be displayed in the status bar until the next call to AcApStatusBar::Update()

Links

AcApStatusBar

Was this information helpful?