Export (0) Print
Expand All

ErrorProvider Class

Provides a user interface for indicating that a control on a form has an error associated with it.

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

[<ComplexBindingPropertiesAttribute("DataSource", "DataMember")>]
type ErrorProvider =  
    class 
        inherit Component 
        interface IExtenderProvider 
        interface ISupportInitialize 
    end

The ErrorProvider type exposes the following members.

  NameDescription
Public methodErrorProvider()Initializes a new instance of the ErrorProvider class and initializes the default settings for BlinkRate, BlinkStyle, and the Icon.
Public methodErrorProvider(ContainerControl)Initializes a new instance of the ErrorProvider class attached to a container.
Public methodErrorProvider(IContainer)Initializes a new instance of the ErrorProvider class attached to an IContainer implementation.
Top

  NameDescription
Public propertyBlinkRateGets or sets the rate at which the error icon flashes.
Public propertyBlinkStyleGets or sets a value indicating when the error icon flashes.
Protected propertyCanRaiseEventsGets a value indicating whether the component can raise an event. (Inherited from Component.)
Public propertyContainerGets the IContainer that contains the Component. (Inherited from Component.)
Public propertyContainerControlGets or sets a value indicating the parent control for this ErrorProvider.
Public propertyDataMemberGets or sets the list within a data source to monitor.
Public propertyDataSourceGets or sets the data source that the ErrorProvider monitors.
Protected propertyDesignModeGets a value that indicates whether the Component is currently in design mode. (Inherited from Component.)
Protected propertyEventsGets the list of event handlers that are attached to this Component. (Inherited from Component.)
Public propertyIconGets or sets the Icon that is displayed next to a control when an error description string has been set for the control.
Public propertyRightToLeftGets or sets a value that indicates whether the component is used in a locale that supports right-to-left fonts.
Public propertySiteGets or sets the ISite of the Component. (Overrides Component.Site.)
Public propertyTagGets or sets an object that contains data about the component.
Top

  NameDescription
Public methodBindToDataAndErrorsProvides a method to set both the DataSource and DataMember at run time.
Public methodCanExtendGets a value indicating whether a control can be extended.
Public methodClearClears all settings associated with this component.
Public methodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public methodDispose()Releases all resources used by the Component. (Inherited from Component.)
Protected methodDispose(Boolean)Releases the unmanaged resources used by the Component and optionally releases the managed resources. (Overrides Component.Dispose(Boolean).)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeReleases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.)
Public methodGetErrorReturns the current error description string for the specified control.
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetIconAlignmentGets a value indicating where the error icon should be placed in relation to the control.
Public methodGetIconPaddingReturns the amount of extra space to leave next to the error icon.
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected methodGetServiceReturns an object that represents a service provided by the Component or by its Container. (Inherited from Component.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected methodMemberwiseClone()Creates a shallow copy of the current Object. (Inherited from Object.)
Protected methodMemberwiseClone(Boolean)Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Protected methodOnRightToLeftChangedRaises the RightToLeftChanged event.
Public methodSetErrorSets the error description string for the specified control.
Public methodSetIconAlignmentSets the location where the error icon should be placed in relation to the control.
Public methodSetIconPaddingSets the amount of extra space to leave between the specified control and the error icon.
Public methodToStringReturns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.)
Public methodUpdateBindingProvides a method to update the bindings of the DataSource, DataMember, and the error text.
Top

  NameDescription
Public eventDisposedOccurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)
Public eventRightToLeftChangedOccurs when the RightToLeft property changes value.
Top

  NameDescription
Explicit interface implemetationPrivate methodISupportInitialize.BeginInitSignals the object that initialization is starting.
Explicit interface implemetationPrivate methodISupportInitialize.EndInitSignals the object that initialization is complete.
Top

ErrorProvider presents a simple 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 ToolTip appears showing the error description string.

Typically, you use ErrorProvider in association with data-bound controls. When using ErrorProvider with data-bound controls, you must specify the ContainerControl, either in the constructor or by setting the ContainerControl property.

NoteNote

The ErrorProvider component does not provide built-in support for accessibility clients. To make your application accessible when using this component, you must provide an additional, accessible feedback mechanism.

The following code example demonstrates using the ErrorProvider class to notify the user of a data entry error. The example creates a Form that contains a TextBox control, a NumericUpDown control, and a ComboBox control, each validating its content, and an ErrorProvider for each control. The example sets error icon options using the BlinkRate and BlinkStyle properties and the SetIconAlignment and SetIconPadding methods. The SetError method is called with or without appropriate error text during a control’s Validated event, depending upon the content in the control.

No code example is currently available or this language may not be supported.

The following code example shows how to use the ErrorProvider with a DataSource and DataMember to indicate a data error to the user.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.5.3, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft