StatusBarTextProvider.SetShowAsBlank Method

StatusBarTextProviderSetShowAsBlank Method

This stores the "show as blank" flag for the specified component.

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

Syntax

C++

Copy

public void SetShowAsBlank(
	Component comp,
	bool showBlank
)

Public Sub SetShowAsBlank ( 
	comp As Component,
	showBlank As Boolean
)

public:
void SetShowAsBlank(
	Component^ comp, 
	bool showBlank
)

member SetShowAsBlank : 
        comp : Component * 
        showBlank : bool -> unit

Parameters

comp: Type: System.ComponentModelComponent
The component associated with the property
showBlank: Type: SystemBoolean
The flag value for the component

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.

Remarks

The designer converts strings containing nothing but spaces to empty strings and this equates to the default and the value is not serialized to code. If you want a blank string to display, set this property to true instead. This property takes precedence over the StatusBarText property.

Reference

StatusBarTextProvider Class

SandcastleBuilder.Utils.Controls Namespace