Share

AcApStatusBar::Remove

C++

virtual BOOL Remove(
    int nIndex, 
    BOOL bTrayItem = FALSE, 
    BOOL bUpdate = TRUE
) = 0;

Description

This function removes a pane or tray item from the status bar.

Note

The status bar may contain hidden panes, so the index and pane count may not match that of the visible panes.

To prevent screen flicker when removing multiple panes or tray items, set bUpdate to false. When you are finished removing panes or 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 pane is actually removed from the status bar.

Note

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

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

Parameters

Parameters Description
nIndex Input zero-based index of the pane or tray item to remove
bTrayItem Input Boolean: true if the item to remove is a tray item; false if it is a pane
bUpdate Input Boolean: true to remove the pane or tray item immediately and update the appearance of the status bar; false if the pane or tray item should be displayed in the status bar until the next call to AcApStatusBar::Update()

Links

AcApStatusBar

Was this information helpful?