StatusBarTextProvider.GetShowAsBlank Method

StatusBarTextProviderGetShowAsBlank Method

This is used to retrieve the "show as blank" flag for a menu item or control.

Namespace: SandcastleBuilder.Utils.Controls
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0

Syntax

public bool GetShowAsBlank(
	Component comp
)

Public Function GetShowAsBlank ( 
	comp As Component
) As Boolean

public:
bool GetShowAsBlank(
	Component^ comp
)

member GetShowAsBlank : 
        comp : Component -> bool

comp: Type: System.ComponentModelComponent
The item for which to get the flag

Type: Boolean
True if it will show a blank status bar message or false if not.

Exceptions

Exception	Condition
ArgumentException	This is thrown if the component is null or if it is not a menu item, control, or a tool strip item.