C1.Win.C1SuperTooltip.C1SuperErrorProvider
C1SuperErrorProvider Class
Provides a user interface for indicating that a control on a form has an error associated with it.
Namespace: C1.Win.C1SuperTooltip
Assembly: C1.Win.C1SuperTooltip.4.8.dll
Syntax
[ToolboxBitmap(typeof(C1SuperErrorProvider), "C1SuperErrorProvider.png")]
[ComplexBindingProperties("DataSource", "DataMember")]
public class C1SuperErrorProvider : Component, IComponent, IDisposable, IExtenderProvider, ISupportInitializeRemarks
C1SuperErrorProvider presents a mechanism for indicating to the end user that a control on a form has an error associated with it. If an error description string is specified for the control, an icon appears next to the control. The icon flashes in the manner specified by BlinkStyle, at the rate specified by BlinkRate. When the mouse hovers over the icon, a C1SuperTooltip appears showing the error description as HTML text.
Constructors
| Name | Description |
|---|---|
| C1SuperErrorProvider() | Initializes a new instance of a C1SuperErrorProvider component. |
| C1SuperErrorProvider(IContainer) | Initializes a new instance of a C1SuperErrorProvider component. |
| C1SuperErrorProvider(ContainerControl) | Initializes a new instance of a C1SuperErrorProvider component. |
Properties
| Name | Description |
|---|---|
| Antiphased | Gets or sets whether the error icon should blink in different phase for various controls. |
| BlinkCount | Gets or sets the number of icon blinks when a new error text is set for the control. |
| BlinkRate | Gets or sets the rate, in milliseconds, at which the error icon should flash. The default is 250 milliseconds. |
| BlinkStyle | Gets or sets a value indicating when the error icon flashes. |
| ContainerControl | Gets or sets a value indicating the parent control for this C1SuperErrorProvider. |
| DataMember | Gets or sets the list within a data source to monitor. |
| DataSource | Gets or sets the data source that the C1SuperErrorProvider monitors. |
| Icon | Gets or sets the Icon that is displayed next to a control when an error description text has been set for the control. |
| Image | Gets or sets the Image that is displayed next to a control when an error description text has been set for the control. |
| ImageHot | Gets or sets the Image that appears next to a control when the mouse hovers over the error icon. |
| Site | Gets or sets the ISite of the Component. |
| Tag | Gets or sets an object that contains data about the component. |
| ToolTip | Gets or sets the associated C1SuperTooltip component displaying the error description text. |
Methods
| Name | Description |
|---|---|
| BeginInit() | |
| BindToDataAndErrors(object, string) | Provides a method to set both the DataSource and DataMember at run time. |
| Clear() | Removes all error glyphs and clears their settings associated with this component. |
| Dispose(bool) | Clean up any resources being used. |
| EndInit() | |
| GetError(Control) | Returns the current error description text for the specified control. |
| GetIconAlignment(Control) | Gets a value indicating where the error icon should be placed in relation to the control. |
| GetIconPadding(Control) | Returns the amount of extra space to leave next to the error icon. |
| OnIconClick(IconClickEventArgs) | Raises the IconClick event. |
| OnIconDoubleClick(IconClickEventArgs) | Raises the IconDoubleClick event. |
| ResetIcon() | This member is for internal use only. |
| SetError(Control, string) | Sets the error description text for the specified control. |
| SetIconAlignment(Control, ErrorIconAlignment) | Sets the location where the error icon should be placed in relation to the control. |
| SetIconPadding(Control, int) | Sets the amount of extra space to leave between the specified control and the error icon. |
| ShouldSerializeIcon() | This member is for internal use only. |
| UpdateBinding() | Provides a method to update the bindings of the DataSource, DataMember, and the error text. |
Events
| Name | Description |
|---|---|
| IconClick | Occurs when the error icon is clicked by the mouse. |
| IconDoubleClick | Occurs when the error icon is clicked two or more times. |