{"id":3368,"date":"2011-08-18T09:04:00","date_gmt":"2011-08-18T17:04:00","guid":{"rendered":"http:\/\/www.sapien.com\/blog\/?p=3368"},"modified":"2011-08-24T13:47:46","modified_gmt":"2011-08-24T21:47:46","slug":"primalforms-2011-spotlight-on-the-errorprovider-control","status":"publish","type":"post","link":"https:\/\/dev.sapien.com\/blog\/2011\/08\/18\/primalforms-2011-spotlight-on-the-errorprovider-control\/","title":{"rendered":"PrimalForms 2011: Spotlight on the ErrorProvider Control"},"content":{"rendered":"

The \u201cSpotlight on Controls\u201d series focuses on a single WinForms control in PrimalForms 2011 , details the important Properties, Methods, and Events of the control and demonstrates how to utilize the control. Most of the information about the controls is still applicable to previous versions of PrimalForms.<\/p>\n

Last time we took a look at the Timer<\/a> control. This time we will look at the ErrorProvider control:<\/p>\n

ErrorProvider Control <\/strong>[System.Windows.Forms.ErrorProvider]<\/span><\/p>\n

Provides a user interface for indicating that a control on a form has an error associated with it.<\/p>\n

\"ErrorProvider\"<\/p>\n

Default Event: N\/A<\/p>\n

Why use a ErrorProvider control?<\/em><\/p>\n

Use the ErrorProvider if you want to notify the user that there is an input error by flashing an icon next to the input control. You can use a single ErrorProvider for multiple controls. In the case where you wish to display different icons or styles, you will need to use multiple ErrorProvider controls.<\/p>\n

<\/font><\/span><\/strong><\/p>\n

Important Properties:<\/font><\/span><\/strong><\/p>\n

Icon<\/strong> <\/p>\n

Use this property to change the icon used to indicate an error. <\/p>\n

Default Icon: \"DefaultIcon\"<\/em><\/p>\n

BlinkRate<\/strong><\/p>\n

This property controls the rate in milliseconds at which the error icon blinks.<\/p>\n

Use this property to increase or decrease the blink rate of the icon. Note: 1000 milliseconds = 1 sec.<\/p>\n

Default Value: 250<\/p>\n

BlinkStyle<\/strong><\/p>\n

This property controls whether the error icon blinks when an error is set.<\/p>\n

Values (Default: BlinkIfDifferentError<\/em>):<\/p>\n

\n

BlinkIfDifferentError<\/em>
Blinks when the icon is already displayed and a new error string is set for the control. <\/p>\n

AlwaysBlink<\/em>
Always blinks when the error icon is first displayed, or when an error description string is set for the control and the error icon is already displayed. <\/p>\n

NeverBlink<\/em>
Never blinks the error icon.<\/p>\n<\/blockquote>\n

Important Methods:<\/font><\/strong> <\/p>\n

SetError<\/strong> <\/p>\n

This method sets the error description string for the specified control. <\/p>\n

Use the SetError method to display the error icon next to the target control and display a specified error message when the user hovers the mouse over the error icon. To clear an error message, pass an empty string to the method, using the same control as a parameter.<\/p>\n

Example use of the SetError method when validating a TextBox:<\/p>\n

$textboxName_Validating<\/span>=<\/span>[System.ComponentModel.CancelEventHandler]{\n<\/span>#Event Argument: $_ = [System.ComponentModel.CancelEventArgs]<\/span>\n    <\/span>#Check if the Name field is empty<\/span>\n    <\/span>if<\/span>(<\/span>$textboxName<\/span>.Text.Trim() <\/span>-eq<\/span> <\/span>\"\"<\/span>)\n    {\n        <\/span>#Display an error message<\/span>\n        <\/span>$errorprovider1<\/span>.SetError(<\/span>$textboxName<\/span>, <\/span>\"Please enter your name.\"<\/span>);\n    }\n    <\/span>else<\/span>\n    {\n        <\/span>#Clear the error<\/span>\n        <\/span>$errorprovider1<\/span>.SetError(<\/span>$textboxName<\/span>, <\/span>\"\"<\/span>);    \n    }\n}<\/span><\/pre>\n
The ErrorProvider displayed in the form:<\/p>\n
\"Display<\/p>\n
SetIconAlignment<\/strong> <\/p>\n
This method sets the location where the error icon should be placed in relation to the control.<\/p>\n
Note: You have to set the alignment for each individual control.<\/p>\n
Note: You can set also set the Icon Alignment in the designer by setting the target control\u2019s \u201cIconAlignment on errorprovider1\u201d property.<\/p>\n
An example use of the SetIconAlignment method where the error Icon is set on the left side of the TextBox control:<\/p>\n
$errorprovider1<\/span>.SetIconAlignment(<\/span>$textboxName<\/span>, [System.Windows.Forms.ErrorIconAlignment]<\/span>::<\/span>MiddleLeft)<\/span><\/pre>\n
The resulting form:<\/p>\n
\"ErrorIconLeftAlignment\"<\/p>\n
The second parameter of the method accepts an enum<\/em> of type [System.Windows.Forms.ErrorIconAlignment]. Since PowerShell allows you to express enum<\/em> values as strings, you can shorten the call by just passing the name of the ErrorIconAlignment value:<\/p>\n
$errorprovider1<\/span>.SetIconAlignment(<\/span>$textboxName<\/span>, <\/span>\"MiddleLeft\"<\/span>)<\/span><\/pre>\n
Default Alignment: MiddleRight<\/em><\/p>\n
ErrorIconAlignment Values:<\/p>\n
\n
TopLeft<\/em>
The icon appears aligned with the top of the control and to the left of the control. <\/p>\n
\"TopLeft\" <\/p>\n
TopRight<\/em>
The icon appears aligned with the top of the control and to the right of the control. <\/p>\n
\"TopRight\" <\/p>\n
MiddleLeft<\/em>
The icon appears aligned with the middle of the control and the left of the control. <\/p>\n
\"MiddleLeft\" <\/p>\n
MiddleRight<\/em>
The icon appears aligned with the middle of the control and the right of the control. <\/p>\n
\"MiddleRight\" <\/p>\n
BottomLeft<\/em>
The icon appears aligned with the bottom of the control and the left of the control. <\/p>\n
\"BottomLeft\" <\/p>\n
BottomRight<\/em>
The icon appears aligned with the bottom of the control and the right of the control. <\/p>\n
\"BottomRight\"<\/p>\n<\/blockquote>\n
  <\/p>\n
SetIconPadding<\/strong> <\/p>\n
Sets the amount of extra space left between the specified control and the error icon. <\/p>\n
Note: You have to set the padding for each individual control.<\/p>\n
$errorprovider1<\/span>.SetIconPadding(<\/span>$textboxName<\/span>, <\/span>1<\/span>)<\/span><\/pre>\n
Note: You can set also set the Icon Padding in the designer by setting the target control\u2019s \u201cIconPadding on errorprovider1\u201d property.<\/p>\n
ErrorProvider with padding set to 1:<\/p>\n
\"Padding1\"<\/p>\n
ErrorProvider with the padding set to 10:<\/p>\n
\"Padding10\"<\/p>\n
 <\/p>\n
\"ErrorProvider<\/p>\n
<\/font><\/p>\n","protected":false},"excerpt":{"rendered":"
The \u201cSpotlight on Controls\u201d series focuses on a single WinForms control in PrimalForms 2011 , details the important Properties, Methods, and Events of the control and demonstrates how to utilize the control. Most of the information about the controls is still applicable to previous versions of PrimalForms. Last time we took a look at the […]<\/p>\n","protected":false},"author":10,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"footnotes":""},"categories":[509,575,644,25],"tags":[641,679,28,633,327],"class_list":["post-3368","post","type-post","status-publish","format-standard","hentry","category-primalforms-software-news","category-primalforms-2011-software-news","category-spotlight-on-controls","category-windows-powershell","tag-controls","tag-errorprovider","tag-powershell","tag-primalforms-2011","tag-winform"],"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/3368","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/users\/10"}],"replies":[{"embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/comments?post=3368"}],"version-history":[{"count":3,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/3368\/revisions"}],"predecessor-version":[{"id":3421,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/3368\/revisions\/3421"}],"wp:attachment":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/media?parent=3368"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/categories?post=3368"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/tags?post=3368"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}
Download the ErrorProvider Sample<\/a> from our Downloads<\/a> section.<\/p>\n