Product Documentation
Cadence User Interface SKILL Reference
Product Version IC23.1, September 2023

hiDeleteBannerLabel

hiDeleteBannerLabel(
w_windowId 
x_labelPosition 
) 
=> t / nil

Description

Deletes a label from the banner bar of a window.

Arguments

w_windowId

Window from which you want to delete the label.

x_labelPosition

Integer specifying the position of the label that you want to delete. 0 represents the leftmost user-defined label, 1 the one to its right, and so on. If the label being deleted was the only label on the banner bar and there is no application data associated with the window, the banner bar is also removed.

Values Returned

t

The label was deleted.

nil

The label was not deleted. An error message is also issued.

Examples

Deletes a label from banner bar of hiGetCurrentWindow.

hiDeleteBannerLabel(hiGetCurrentWindow( ) 0)
=> t

Related Topics

Window Banner Functions

hiChangeBannerLabel

hiGetBannerLabels


Return to top
 ⠀
X