 | StatusBarTextProvider Class |
This is an IExtenderProvider component that allows you
to add status bar text for menu items and form controls. When built
for use with .NET 2.0, it also supports adding status bar text for
menu strip, tool strip, and status strip components.
Inheritance HierarchySystemObject
SystemMarshalByRefObject
System.ComponentModelComponent
SandcastleBuilder.Utils.ControlsStatusBarTextProvider
SystemMarshalByRefObject
System.ComponentModelComponent
SandcastleBuilder.Utils.ControlsStatusBarTextProvider
Namespace: SandcastleBuilder.Utils.Controls
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0
SyntaxThe StatusBarTextProvider type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | StatusBarTextProvider |
Default constructor
|
| StatusBarTextProvider(IContainer) |
Constructor. This one takes a reference to a container.
|
Methods| Name | Description | |
|---|---|---|
| CanExtend |
This is implemented to determine if the component can be extended
with the extra properties.
|
| CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.) |
| Dispose | Releases all resources used by the Component. (Inherited from Component.) |
 | Dispose(Boolean) |
Clean up any resources being used.
(Overrides ComponentDispose(Boolean).) |
| Equals | (Inherited from Object.) |
| Finalize | Releases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| GetService | (Inherited from Component.) |
| GetShowAsBlank |
This is used to retrieve the "show as blank" flag for a menu item
or control.
|
| GetStatusBarText |
This is used to retrieve the status bar text for a component.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
 | InitializeProgressBar(Int32) |
This can be used to initialize the status strip progress bar
controls.
|
| InitializeProgressBar(Int32, Int32) |
This can be used to initialize the status strip progress bar
controls.
|
| InitializeProgressBar(Int32, String) |
This can be used to initialize the status strip progress bar
controls.
|
| InitializeProgressBar(Int32, Int32, Int32) |
This can be used to initialize the status strip progress bar
controls.
|
| InitializeProgressBar(Int32, Int32, String) |
This can be used to initialize the status strip progress bar
controls.
|
| InitializeProgressBar(Int32, Int32, Int32, Int32, String) |
This can be used to initialize the status strip progress bar
controls.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.) |
| ResetProgressBar |
This can be used to reset the status strip progress bar
to its minimum value.
|
| ResetProgressBar(String) |
This can be used to reset the status strip progress bar
to its minimum value and display a new progress message.
|
| SetShowAsBlank |
This stores the "show as blank" flag for the specified component.
|
| SetStatusBarText |
This stores the status bar text for the specified component.
|
| ToString | Returns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.) |
| UpdateProgress |
This can be used to update the progress bar with a new value
|
| UpdateProgress(Int32) |
This can be used to update the progress bar with a new value
|
| UpdateProgress(String) |
This can be used to update the progress bar with a new value
|
| UpdateProgress(Int32, String) |
This can be used to update the progress bar with a new value
|
Properties| Name | Description | |
|---|---|---|
 | ApplicationDefaultText |
This is used to set or get the default text to show when no item
has the focus or no status text for the application status bar.
|
| ApplicationDisplayPanel |
This is used to set or get the status bar panel in which to
display the messages in the common application status bar.
|
 | ApplicationStatusBar |
This is used to set or get the default status bar component to use
for displaying the status bar text messages.
|
 | CanRaiseEvents | Gets a value indicating whether the component can raise an event. (Inherited from Component.) |
| Container | Gets the IContainer that contains the Component. (Inherited from Component.) |
| DesignMode | Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component.) |
| Events | Gets the list of event handlers that are attached to this Component. (Inherited from Component.) |
| InstanceDefaultText |
This is used to set or get the default text to show when no item
has the focus or no status text for the instance status bar.
|
| InstanceDisplayPanel |
This is used to set or get the status bar panel in which to
display the messages when the InstanceStatusBar
property is set to a status bar.
|
| InstanceStatusBar |
This is used to get or set the status bar component to use for this
instance.
|
| ProgressBar |
This is used to get or set the tool strip progress bar component
that can be used to display progress through a long running task.
|
| Site | (Inherited from Component.) |
| StatusLabel |
This is used to get or set the tool strip status label component
that can be used to display a status message in conjunction with
the ProgressBar component.
|
Events| Name | Description | |
|---|---|---|
 | Disposed | Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.) |
See Also