StatusBarTextProvider.GetStatusBarText Method

StatusBarTextProviderGetStatusBarText Method

This is used to retrieve the status bar text for a component.

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

Syntax

public string GetStatusBarText(
	Component comp
)

Public Function GetStatusBarText ( 
	comp As Component
) As String

public:
String^ GetStatusBarText(
	Component^ comp
)

member GetStatusBarText : 
        comp : Component -> string

comp: Type: System.ComponentModelComponent
The component for which to get the status bar text

Type: String
The message string if found or null if not found

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.