{"id":3193,"date":"2011-07-14T09:54:00","date_gmt":"2011-07-14T17:54:00","guid":{"rendered":"http:\/\/www.sapien.com\/blog\/?p=3193"},"modified":"2011-07-14T09:54:24","modified_gmt":"2011-07-14T17:54:24","slug":"primalforms-2011-spotlight-on-the-progressbar-control","status":"publish","type":"post","link":"https:\/\/dev.sapien.com\/blog\/2011\/07\/14\/primalforms-2011-spotlight-on-the-progressbar-control\/","title":{"rendered":"PrimalForms 2011: Spotlight on the ProgressBar 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 RadioButton<\/a> control. This time we will look at the ProgressBar control:<\/p>\n

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

Represents a Windows progress bar control.<\/p>\n

Default Event: Click<\/p>\n

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

Use a ProgressBar when you need to show the user that progress is being made in some operation, such as copying files.<\/p>\n

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

Maximum<\/strong> <\/p>\n<\/td>\nThe Maximum is the upper bound of the range this ProgressBar is working with. <\/p>\n

Why use the Maximum property?<\/em> <\/p>\n

Use the Maximum property when you have a known limit for your ProgressBar. When the Value property is equal to the value of the Maximum property, the progress bar is completely filled. <\/p>\n

Example of setting the Maximum property in the Script Editor:<\/p>\n

$progressbar1<\/span>.Maximum <\/span>=<\/span> <\/span>$files<\/span>.Count<\/span><\/pre>\n<\/td>\n<\/tr>\n\nValues (Default: 100<\/em>):<\/p>\n
\n
Any Integer value [Int32]<\/p>\n<\/blockquote>\n
Minimum<\/strong> <\/p>\n<\/td>\nThe Minimum is the lower bound of the range this ProgressBar is working with. When the Value property is equal to the value of the Minimum property, the ProgressBar will be empty. <\/p>\n
Values (Default: 0<\/em>): <\/p>\n
\n
Any Integer value [Int32]<\/p>\n<\/blockquote>\n
Step<\/strong> <\/p>\n<\/td>\nThe Step is the amount to increment the current value of the ProgressBar by when the PerformStep() method is called. <\/p>\n
Why use the Step property?<\/em> <\/p>\n<\/td>\n
Use the Step property to specify the amount that each completed task in an operation changes the value of the progress bar.  The Step property default value is 10, so you may want to set the step to 1 when necessary. <\/p>\n
Values (Default: 10<\/em>):<\/p>\n
\n
Any Integer value [Int32]<\/p>\n<\/blockquote>\n
Style<\/strong> <\/p>\n<\/td>\nThis property allows the user to set the style of the ProgressBar. <\/p>\n
Why use the Style property?<\/em> <\/p>\n
Use the style property when you want to change the way  ProgressBar is displayed or in cases where you have an unknown amount of increments (See Marquee style). <\/p>\n
Values (Default: Blocks<\/em> ): <\/p>\n
\n
Blocks<\/em>
Indicates progress by increasing the number of segmented blocks in a ProgressBar. <\/p>\n
\"Block <\/p>\n
(Windows 7)<\/font> <\/p>\n
\"Block <\/p>\n
(Windows XP)<\/font> <\/p>\n
Continuous<\/em>
Indicates progress by increasing the size of a smooth, continuous bar in a ProgressBar. Since PrimalForms enables VisualStyles by default, Continuous will resemble Blocks style. <\/p>\n
Marquee<\/em>
Indicates progress by continuously scrolling a block across a ProgressBar in a marquee fashion. Use Marquee when you can\u2019t specify a quantity of progress, but still need to indicate that progress is being made. Use the MarqueeAnimationSpeed property to control the speed of the ProgressBar.<\/p>\n
\"Marquee\"<\/a><\/p>\n
(Windows 7)<\/font><\/p>\n
\"Marquee<\/p>\n
(Windows XP)<\/font><\/p>\n<\/blockquote>\n<\/td>\n<\/tr>\n\nValue<\/strong> <\/p>\n<\/td>\nThe current value of the ProgressBar, in the range specified by the Minimum and Maximum properties.<\/p>\n
Why use the Value property?<\/em><\/p>\n
Use the Value property if you want to set the progress at a specific point or to obtain the current position of the ProgressBar .<\/p>\n
Values (Default: 0<\/em>):<\/p>\n
\n
Any Integer value [Int32]<\/p>\n<\/blockquote>\n
MarqueeAnimationSpeed<\/strong><\/p>\n
This property indicates the speed of the marquee animation in milliseconds. The ProgressBar\u2019s Style must be set to Marquee in order to use this property.<\/p>\n
Why use the MarqueeAnimationSpeed property<\/em>?<\/p>\n
Use the MarqueeAnimationSpeed property if you want to change the speed of the ProgressBar \u2019s animation or to pause the marquee by setting the speed to 0.<\/p>\n
To clear the Marquee, it is recommended to change the Style property to Block and set the Value property to 0.<\/p>\n
Values (Default: 100<\/em>):<\/p>\n
\n
Any Integer value [Int32] (In milliseconds)<\/p>\n<\/blockquote>\n
Important Methods:<\/font><\/strong> <\/p>\n
Increment<\/strong> <\/p>\n
This method advances the current position of the ProgressBar by the specified amount. <\/p>\n
Why use the Increment method?<\/em> <\/p>\n
Use the Increment method when you need to increment the value of the ProgressBar by varying amounts.  This method of incrementing the ProgressBar is similar to using the Step property with the PerformStep method. Setting the Step property is not necessary when using the Increment method. <\/p>\n
Example of using Increment method in the script editor:<\/p>\n
$progressbar1<\/span>.Increment(<\/span>1<\/span>)<\/span><\/pre>\n
<\/span> <\/pre>\n
PerformStep<\/strong> <\/p>\n<\/td>\nThis method advances the current value of the ProgressBar by the amount of the Step property.<\/p>\n
Why use the PerformStep method?<\/em><\/p>\n
Use the PerformStep method when repeatedly incrementing the ProgressBar by the same amount (i.e., the value set in the Step property). <\/p>\n
 <\/p>\n
Here is a sample script block triggered by a button, that displays its progress as it creates a backup of all the text files located in a folder specified by the user:<\/p>\n<\/td>\n<\/tr>\n
$buttonBackupFiles_Click<\/span>=<\/span>{\n    <\/span>#Back up Text files from a selected directory<\/span>\n    <\/span>if<\/span>(<\/span>$folderbrowserdialog1<\/span>.ShowDialog() <\/span>-eq<\/span> <\/span>'OK'<\/span>)\n    {\n        <\/span>$selectedPath<\/span> <\/span>=<\/span> <\/span>$folderbrowserdialog1<\/span>.SelectedPath\n        \n        <\/span>#Get all the text files in the folder<\/span>\n        <\/span>$files<\/span> <\/span>=<\/span> <\/span>Get-ChildItem<\/span> <\/span>$selectedPath<\/span> <\/span>-<\/span>Filter<\/span> <\/span>*<\/span>.txt\n\n        <\/span>if<\/span>(<\/span>$files<\/span> <\/span>-eq<\/span> <\/span>$null<\/span> <\/span>-or<\/span> <\/span>$files<\/span>.Count <\/span>-eq<\/span> <\/span>0<\/span>)\n        {\n            <\/span>#No files to backup<\/span>\n            <\/span>return<\/span>    \n        }\n        \n        <\/span>#Initialize the Progress Bar<\/span>\n        <\/span>$progressbar1<\/span>.Maximum <\/span>=<\/span> <\/span>$files<\/span>.Count\n        <\/span>$progressbar1<\/span>.Step <\/span>=<\/span> <\/span>1<\/span>\n        <\/span>$progressbar1<\/span>.Value <\/span>=<\/span> <\/span>0<\/span>\n        \n        <\/span>#Create the Backup Folder<\/span>\n        <\/span>$destination<\/span> <\/span>=<\/span> (<\/span>'{0}\\\\Backup'<\/span> <\/span>-f<\/span> <\/span>$selectedPath<\/span>)\n        [System.IO.Directory]<\/span>::<\/span>CreateDirectory(<\/span>$destination<\/span>)\n        \n        <\/span>#Copy the files and update the progress bar<\/span>\n        <\/span>foreach<\/span> (<\/span>$file<\/span> <\/span>in<\/span> <\/span>$files<\/span>){    \n            <\/span>Copy-Item<\/span> (<\/span>'{0}\\\\{1}'<\/span> <\/span>-f<\/span> <\/span>$selectedPath<\/span>, <\/span>$file<\/span>) <\/span>-<\/span>Destination <\/span>$destination<\/span>\n            <\/span>$progressbar1<\/span>.PerformStep()\n        }\n    }\n}<\/span><\/pre>\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":[575,644,25],"tags":[641,28,633,663,327],"class_list":["post-3193","post","type-post","status-publish","format-standard","hentry","category-primalforms-2011-software-news","category-spotlight-on-controls","category-windows-powershell","tag-controls","tag-powershell","tag-primalforms-2011","tag-progressbar","tag-winform"],"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/3193","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=3193"}],"version-history":[{"count":4,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/3193\/revisions"}],"predecessor-version":[{"id":3203,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/3193\/revisions\/3203"}],"wp:attachment":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/media?parent=3193"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/categories?post=3193"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/tags?post=3193"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}