StatusBarTextProvider.SetStatusBarText Method

StatusBarTextProviderSetStatusBarText Method

This stores the status bar text 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 SetStatusBarText(
	Component comp,
	string message
)

Public Sub SetStatusBarText ( 
	comp As Component,
	message As String
)

public:
void SetStatusBarText(
	Component^ comp, 
	String^ message
)

member SetStatusBarText : 
        comp : Component * 
        message : string -> unit

Parameters

comp: Type: System.ComponentModelComponent
The component associated with the message
message: Type: SystemString
The status bar text 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 won't serialize them to code. If you want a blank string to display, use SetShowAsBlank(Component, Boolean) to set the "show as blank" flag to true instead.

Reference

StatusBarTextProvider Class

SandcastleBuilder.Utils.Controls Namespace