{"id":4494,"date":"2012-07-05T10:18:00","date_gmt":"2012-07-05T18:18:00","guid":{"rendered":"http:\/\/www.sapien.com\/blog\/?p=4494"},"modified":"2012-07-05T10:18:06","modified_gmt":"2012-07-05T18:18:06","slug":"spotlight-on-the-statusbar-control","status":"publish","type":"post","link":"https:\/\/dev.sapien.com\/blog\/2012\/07\/05\/spotlight-on-the-statusbar-control\/","title":{"rendered":"Spotlight on the StatusBar Control"},"content":{"rendered":"

The \u201cSpotlight on Controls\u201d series focuses on a single WinForms control in PowerShell Studio 2012, 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.<\/em><\/p>\n

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

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

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

\"StatusBar<\/p>\n

Default Event: PanelClick <\/p>\n

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

Use the StatusBar control, to display status information to the user. The StatusBar can also be used for user interaction but typically plays a informative roll.<\/p>\n

 <\/p>\n

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

Panels<\/strong><\/p>\n

The collection of StatusBar panels contained within the control. Panels represent a subsection of the StatusBar that can display text and\/or an icon.<\/p>\n

Adding Panels:<\/p>\n

You can add panels by using the Property Pane:<\/p>\n

\"Panels<\/a><\/p>\n

Next you will be presented with a dialog that allows you to add or remove panels:<\/p>\n

\"StatusBarPanel<\/a><\/p>\n

Once you add a Panel, it will appear in the control list of the Property Pane thus allowing you to alter the properties directly without having to access the collection editor.<\/p>\n

\"Edit<\/a><\/p>\n

Each panel consists of a StatusBarPanel object:<\/p>\n

StatusBarPanel [System.Windows.Forms.StatusBarPanel]<\/p>\n\n\n\n\n\n\n\n\n\n\n\n
Properties<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n
Alignment<\/td>\nThe alignment of text and icons within the status bar panel.
Values (Default: Left<\/em>):
Left<\/em>
\"Left
Right<\/em>
\"Right
Center<\/em>
\"Center<\/td>\n<\/tr>\n
AutoSize<\/td>\nIndicates whether the status bar panel is automatically resized.
Values (Default: None<\/em>):<\/p>\n

None<\/em>
The StatusBarPanel does not change size when the StatusBar control resizes.

Spring<\/em>
The StatusBarPanel shares the available space on the StatusBar (the space not taken up by other panels whose AutoSize property is set to None<\/em> or Contents<\/em>) with other panels that have their AutoSize property set to Spring<\/em>.<\/p>\n

Contents
<\/em>The width of the StatusBarPanel is determined by its contents.<\/td>\n<\/tr>\n

BorderSize<\/td>\nThe border style of the status bar panel. The difference between Raised and Sunken can only be seen on older versions of Windows.
\"image\"
Values (Default: Sunken<\/em>):<\/p>\n

None<\/em>
No border is displayed.<\/p>\n

Raised<\/em>
The StatusBarPanel is displayed with a three-dimensional raised border.<\/p>\n

Sunken<\/em>
The StatusBarPanel is displayed with a three-dimensional sunken border.<\/td>\n<\/tr>\n

Icon<\/td>\nThe icon to display within the status bar panel.
\"Icon<\/td>\n<\/tr>\n
MinWidth<\/td>\nThe minimum allowed width of the status bar panel within the StatusBar control.<\/td>\n<\/tr>\n
Text<\/td>\nThe text of the status bar panel.<\/td>\n<\/tr>\n
ToolTipText<\/td>\nToolTip text associated with the status bar panel.
\"Panel<\/td>\n<\/tr>\n
Width<\/td>\nThe width of the status bar panel within the StatusBar control.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

 <\/p>\n

Adding Panels via Script Editor:<\/p>\n

You can manually add panels using the Panel properties\u2019 Add methods:<\/p>\n

[StatusBarPanel]<\/span> Add <\/span>([<\/span>string] <\/span>text<\/span>)<\/font><\/span><\/p>\n

Adds a StatusBarPanel with the specified text to the collection.
<\/font><\/p>\n

$panel<\/span> <\/span>=<\/span> <\/span>$statusbar1<\/span>.Panels.Add(<\/span>\"New Panel\"<\/span>)<\/span><\/pre>\n
<\/span><\/font><\/span> <\/p>\n
[int]<\/span> Add <\/span>([<\/span>StatusBarPanel] <\/span>value<\/span>)<\/font><\/span><\/p>\n
Adds a StatusBarPanel to the collection and returns an index.
<\/font><\/p>\n
$panel<\/span> <\/span>=<\/span> <\/span>New-Object<\/span> System.Windows.Forms.StatusBarPanel\n<\/span>$index<\/span> <\/span>=<\/span> <\/span>$statusbar1<\/span>.Panels.Add(<\/span>$panel<\/span>)<\/span><\/pre>\n
<\/strong> <\/p>\n
ShowPanels<\/strong><\/p>\n
This property indicates whether any panels that have been added to the control are displayed.<\/p>\n
ShowPanels set to True<\/em>:<\/p>\n
\"ShowPanels\"<\/p>\n
ShowPanels set to False<\/em>:
\"ShowPanels<\/p>\n
<\/strong> <\/p>\n
SizingGrip<\/strong><\/p>\n
This property indicates whether a sizing grip is displayed in the lower-right corner of the control. This property is mainly cosmetic and should be set to False when using a fixed sized Form. Such as  when the form\u2019s FormBorderStyle property is set to FixedDialog. <\/em>For more details about the Form control and the FormBorderStyle property, please refer to the Spotlight on the Form Control<\/a> article.<\/p>\n
<\/em> <\/p>\n
Text<\/strong><\/p>\n
This property indicates the text associated with the StatusBar control. Use this property to display a message in the StatusBar. 
Note: This text is not displayed when the ShowPanels property is set to True<\/em>.<\/p>\n
$statusbar1<\/span>.Text <\/span>=<\/span> <\/span>\"Loading...\"<\/span><\/pre>\n
<\/font><\/strong> <\/p>\n
Important Events:<\/font><\/strong><\/p>\n
PanelClick<\/strong><\/p>\n
This event occurs when a StatusBarPanel object on a StatusBar control is clicked. 
The PanelClick event uses the following argument, which is accessible via the $_ variable:<\/p>\n
\n
[System.Windows.Forms.StatusBarPanelClickEventArgs]<\/p>\n<\/blockquote>\n
\n\n\n\n\n\n\n\n\n\n
Properties<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n
Button<\/td>\nGets which mouse button was pressed.<\/td>\n<\/tr>\n
Clicks<\/td>\nGets the number of times the mouse button was pressed and released.<\/td>\n<\/tr>\n
Location<\/td>\nGets the location of the mouse during the generating mouse event.<\/td>\n<\/tr>\n
StatusBarPanel<\/td>\n\n
Gets the StatusBarPanel that was clicked.<\/p>\n<\/td>\n<\/tr>\n
X<\/td>\nGets the x-coordinate of the mouse during the generating mouse event.<\/td>\n<\/tr>\n
Y<\/td>\nGets the y-coordinate of the mouse during the generating mouse event.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/blockquote>\n
 <\/p>\n
How to Display Different Context Menus for Each Panel:<\/strong><\/p>\n
The StatusBar has a ContextMenuStrip property that displays a context menu when the user right clicks on the Statusbar. But what if you want to display a different menu depending on which panel is clicked? To do this you have clear the StatusBar\u2019s ContextMenuStrip property and handle the StatusBar\u2019s PanelClick event as follows:<\/p>\n
$statusbar1_PanelClick<\/span>=<\/span>[System.Windows.Forms.StatusBarPanelClickEventHandler]{\n<\/span>#Event Argument: $_ = [System.Windows.Forms.StatusBarPanelClickEventArgs]<\/span>\n    <\/span>if<\/span>(<\/span>$_<\/span>.Button <\/span>-eq<\/span> <\/span>'Right'<\/span>)\n    {\n        <\/span>if<\/span>(<\/span>$_<\/span>.StatusBarPanel <\/span>-eq<\/span> <\/span>$statusbarpanel2<\/span>)\n        {\n            <\/span>$contextmenustrip2<\/span>.Show(<\/span>$statusbar1<\/span>, <\/span>$_<\/span>.Location)\n        }\n        <\/span>elseif<\/span>(<\/span>$_<\/span>.StatusBarPanel <\/span>-eq<\/span> <\/span>$statusbarpanel1<\/span>)\n        {\n            <\/span>$contextmenustrip1<\/span>.Show(<\/span>$statusbar1<\/span>, <\/span>$_<\/span>.Location)\n        }\n    }\n}<\/span><\/pre>\n
First it checks if the user Right clicked on a panel and then determines which panel was clicked. Depending on which panel was clicked you display the corresponding context menu. <\/p>\n
\"Panel<\/p>\n
\"Panel<\/p>\n
For more details on the ContextMenuStrip please refer to the Spotlight on the ContextMenuStrip<\/a> article.<\/p>\n
 <\/p>\n
You can download the StatusBar Sample<\/a> from our Downloads<\/a> section.<\/p>\n","protected":false},"excerpt":{"rendered":"
The \u201cSpotlight on Controls\u201d series focuses on a single WinForms control in PowerShell Studio 2012, 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":[705,509,644,25],"tags":[641,28,633,728,327],"class_list":["post-4494","post","type-post","status-publish","format-standard","hentry","category-powershell-studio-2012","category-primalforms-software-news","category-spotlight-on-controls","category-windows-powershell","tag-controls","tag-powershell","tag-primalforms-2011","tag-statusbar","tag-winform"],"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/4494","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=4494"}],"version-history":[{"count":10,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/4494\/revisions"}],"predecessor-version":[{"id":4595,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/4494\/revisions\/4595"}],"wp:attachment":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/media?parent=4494"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/categories?post=4494"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/tags?post=4494"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}