{"id":4685,"date":"2012-09-12T14:20:00","date_gmt":"2012-09-12T22:20:00","guid":{"rendered":"http:\/\/www.sapien.com\/blog\/?p=4685"},"modified":"2012-09-12T14:20:18","modified_gmt":"2012-09-12T22:20:18","slug":"spotlight-on-the-statusstrip-control","status":"publish","type":"post","link":"https:\/\/dev.sapien.com\/blog\/2012\/09\/12\/spotlight-on-the-statusstrip-control\/","title":{"rendered":"Spotlight on the StatusStrip 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

Note: The StatusStrip control is only available for PowerShell Studio 2012 v3.0.6 or greater<\/font><\/em><\/p>\n

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

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

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

\"StatusStrip<\/p>\n

Default Event: ItemClick <\/p>\n

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

Use the StatusStrip control, to display status information to the user. The StatusStrip serves as a replacement to the StatusBar and also offers more support for user interaction than the StatusBar by allowing you to add buttons, progress bars, and other controls.<\/p>\n

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

AllowItemReorder<\/strong><\/p>\n

This property allows the items in the StatusStrip to be reordered when the ALT key is pressed.<\/p>\n

 <\/p>\n

SizingGrip<\/strong><\/p>\n

This property indicates whether a sizing handle (grip) is displayed in the lower-right corner of the control. This property is mainly cosmetic and should be set to False when using fixed sized forms, 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

Default Value: True<\/em><\/p>\n

\"SizingGrip\"<\/em><\/p>\n

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

ShowItemToolTips<\/strong><\/p>\n

This property indicates whether ToolTips are shown for the StatusStrip. Set this property to True<\/i> when you want to provide help information for items in the StatusStrip.<\/p>\n

Default Value: False<\/em><\/p>\n

\"ShowItemToolTips\"<\/p>\n

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

LayoutStyle<\/strong><\/p>\n

This property indicates how the StatusStrip lays out the items collection.<\/p>\n

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

\n

StackWithOverflow<\/em>
Specifies that items are laid out automatically. <\/p>\n

HorizontalStackWithOverflow<\/em>
Specifies that items are laid out horizontally and overflow as necessary. <\/p>\n

VerticalStackWithOverflow<\/em>
Specifies that items are laid out vertically, are centered within the control, and overflow as necessary. <\/p>\n

Flow<\/em>
Specifies that items flow horizontally or vertically as necessary. <\/p>\n

Table<\/em>
Specifies that items are laid out flush left.<\/p>\n<\/blockquote>\n

Note: If you want to ensure all the items on the status bar are visible even when the form is resized then you can use the Flow<\/em> layout style: <\/p>\n

\"Flow<\/p>\n

Otherwise the items that do not fit in the StatusStrip (depending on form size) will be hidden from view. <\/p>\n

Dock<\/strong><\/p>\n

This property indicates which StatusStrip borders are docked to its parent control and determines how a StatusStrip is resized with its parent.<\/p>\n

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

\n

None<\/em>
The control is not docked. The StatusStrip becomes a free floating control that cannot be moved by the user. <\/p>\n

Top<\/em>
The control’s top edge is docked to the top of its containing control. <\/p>\n

Bottom<\/em>
The control’s bottom edge is docked to the bottom of its containing control. <\/p>\n

Left<\/em>
The control’s left edge is docked to the left edge of its containing control. <\/p>\n

Right<\/em>
The control’s right edge is docked to the right edge of its containing control. <\/p>\n

Fill<\/em>
All the control’s edges are docked to the all edges of its containing control and sized appropriately. <\/p>\n

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

 <\/p>\n<\/blockquote>\n

Items<\/strong><\/p>\n

This property contains all the items that belong to the StatusStrip. This property consists of a collection of ToolStripItems, which come in various flavors. For more information, refer to the ToolStripItem Types section below. <\/p>\n

Adding Items to the StatusBar<\/strong><\/p>\n

Using the Designer:<\/p>\n

You can add ToolStripItems directly in the designer by accessing the dropdown inside the StatusStrip:<\/p>\n

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

Note: To edit the item\u2019s properties you will have to select the ToolStripItem and use the Property Panel.<\/p>\n

You can also use the Item Collection Editor to add items to the StatusStrip. <\/p>\n

Access the Item Collection Editor using the property panel: <\/p>\n

\"Property<\/p>\n

Or the by using the designer menu: <\/p>\n

\"Designer<\/p>\n

The Item Collection Editor allows you to add \/ remove ToolStripItems and alter their properties in a single location: <\/p>\n

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

 <\/p>\n

Using the Script Editor:<\/p>\n

You can add ToolStripItems using the Item property\u2019s Add methods:<\/p>\n

[ToolStripItem] <\/span>Add <\/span>([<\/span>Image] <\/span>image<\/span>)
<\/font>Adds a ToolStripItem that displays the specified image to the collection.
<\/font><\/p>\n

[ToolStripItem] <\/span>Add <\/span>([<\/span>String] <\/span>text<\/span>)
<\/font>Adds a ToolStripItem that displays the specified text to the collection.
<\/font><\/p>\n

[int] <\/span>Add <\/span>([<\/span>ToolStripItem] <\/span>value<\/span>)
<\/font>Adds the specified item to the end of the collection.
<\/font><\/p>\n

[ToolStripItem] <\/span>Add <\/span>([<\/span>String] <\/span>text, [<\/span>Image] <\/span>image<\/span><\/span>)
<\/font>Adds a ToolStripItem that displays the specified image and text to the collection.
<\/font><\/p>\n

[ToolStripItem] <\/span>Add <\/span>([<\/span>String] <\/span>text, [<\/span>Image] <\/span>image, [<\/span>EventHandler] <\/span>onClick<\/span><\/span><\/span>)
<\/font>Adds a ToolStripItem that displays the specified image and text to the collection and that raises the Click event.<\/font><\/p>\n

Example Code:<\/p>\n

$clickEvent<\/span> <\/span>=<\/span> {\n    <\/span>Write-Host<\/span> <\/span>'Click'<\/span>\n}\n<\/span>
<\/span><\/pre>\n
$image<\/span> <\/span>=<\/span> [System.Drawing.Image]<\/span>::<\/span>FromFile(<\/span>'c:\\image.png'<\/span>)\n<\/span>
$statusstrip1<\/span>.Items.Add(<\/span>'Text'<\/span>, <\/span>$image<\/span> , <\/span>$clickEvent<\/span>)<\/span><\/pre>\n
 <\/p>\n
Important Events:<\/strong><\/font><\/p>\n
ItemClicked<\/strong><\/p>\n
This event occurs when a ToolStripItem is clicked. This event allows you to handle all the click events in one location, but it is not recommend using this event if you are have DropDownButtons or SplitButtons. Instead you should use each ToolStripItem\u2019s individual event handlers.<\/p>\n
$statusstrip1_ItemClicked<\/span>=<\/span>[System.Windows.Forms.ToolStripItemClickedEventHandler]{\n<\/span>#Event Argument: $_ = [System.Windows.Forms.ToolStripItemClickedEventArgs]<\/span>\n\n    <\/span>Write-Host<\/span> <\/span>$_<\/span>.ClickedItem.Text\n<\/span><\/pre>\n
    <\/span>if<\/span>(<\/span>$_<\/span>.ClickedItem <\/span>-eq<\/span> <\/span>$toolstripstatuslabel1<\/span>)\n    {\n        <\/span>Write-Host<\/span> <\/span>\"You clicked the label\"<\/span>\n    } \n}<\/span><\/pre>\n
<\/font><\/strong> <\/p>\n
ToolStripItem Types:<\/font><\/strong><\/p>\n
You can add a variety of items to the StatusStrip, which are presented below. <\/p>\n
The following properties are shared with all the types of ToolStripItems, with the exception of the ProgressBar which only shares the ToolTipText property:<\/p>\n
Important Shared Properties<\/strong>:<\/p>\n\n\n\n\n\n\n\n\n\n\n
Property<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n
ToolTipText<\/td>\n\n
Specifies the text to show on the Tooltip.
If this property is not set and the AutoToolTip property is set to True<\/i>, the item will use the Text property as its ToolTip.<\/p>\n<\/td>\n<\/tr>\n
DisplayStyle<\/td>\nSpecifies whether text and images are displayed on an item.
Values:<\/p>\n
None<\/em>
Specifies that neither image nor text is to be rendered for this item. <\/p>\n
Text<\/em>
Specifies that only text is to be rendered for this item. <\/p>\n
\"Text <\/p>\n
Image<\/em>
Specifies that only an image is to be rendered for this item. <\/p>\n
\"Image <\/p>\n
ImageAndText<\/em>
Specifies that both an image and text are to be rendered for this item. <\/p>\n
\"Image<\/p>\n<\/td>\n<\/tr>\n
Image<\/td>\nThe image that will be displayed on the item.<\/td>\n<\/tr>\n
ImageScaling<\/td>\nIndicates whether the image on the item will automatically resize to fit in the StatusStrip.
Values:<\/p>\n
None<\/em>
Specifies that the size of the image on an item is not automatically adjusted to fit on a StatusStrip. The image retains its original size. <\/p>\n
\"ImageScaling <\/p>\n
SizeToFit<\/em>
Specifies that the size of the image on an item is automatically adjusted to fit on a StatusStrip. <\/p>\n
\"ImageScaling<\/p>\n<\/td>\n<\/tr>\n
Text<\/td>\nThe text that is to be displayed on the item.<\/td>\n<\/tr>\n
TextImageRelation<\/td>\nThe position of the item\u2019s text and image relative to each other.
Values:<\/p>\n
Overlay<\/em>
Specifies that the image and text share the same space on a control.<\/p>\n
\"TextImageRelation<\/p>\n
ImageBeforeText<\/em>
Specifies that the image is displayed horizontally before the text of a control.
\"TextImageRelation <\/p>\n
TextBeforeImage<\/em>
Specifies that the text is displayed horizontally before the image of a control.
\"TextImageRelation <\/p>\n
ImageAboveText<\/em>
Specifies that the image is displayed vertically above the text of a control.
\"TextImageRelation <\/p>\n
TextAboveImage<\/em>
Specifies that the text is displayed vertically above the image of a control.
\"TextImageRelation<\/p>\n<\/td>\n<\/tr>\n
DoubleClickEnabled<\/td>\nIndicated whether the item can be activated by double-clicking the mouse.
Values: True \/ False<\/em><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Important Shared Events:<\/strong><\/p>\n
The following events are shared with all the types of ToolStripItems: <\/p>\n\n\n\n\n\n
Event<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n
Click<\/td>\nOccurs when the item is clicked.<\/td>\n<\/tr>\n
DoubleClick<\/td>\nOccurs when the item is clicked. 
Note: Order for this event to be triggered, some types require that the DoubleClickEnabled property to be set to True.<\/em><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
 <\/p>\n
The following is a list of ToolStripItems types that can be added to the StatusStrip control:<\/p>\n
StatusLabel <\/strong>[System.Windows.Forms.ToolStripStatusLabel]<\/font><\/p>\n
\"Status<\/p>\n
Represents a panel in a StatusStrip control. Use the StatusLabel to show text and\/or an image.<\/p>\n
Important Properties<\/strong>:<\/p>\n\n\n\n\n\n\n\n\n
Properties<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n
BorderSides<\/td>\nIndicates which sides of the ToolStripStatusLabel show borders.
Values:
None, Top, Left, Right, Bottom, All
\"BorderSides
\"BorderSide<\/td>\n<\/tr>\n
BorderStyles<\/td>\nIndicates the border style of the ToolStripStatusLabel.<\/p>\n
Values (Default: Flat<\/em>):<\/p>\n
Adjust<\/em>
The border is drawn outside the specified rectangle, preserving the dimensions of the rectangle for drawing. <\/p>\n
 Bump<\/em>
The inner and outer edges of the border have a raised appearance. <\/p>\n
 Etched<\/em>
The inner and outer edges of the border have an etched appearance. <\/p>\n
 Flat<\/em>
The border has no three-dimensional effects. <\/p>\n
 Raised<\/em>
The border has raised inner and outer edges. <\/p>\n
 RaisedInner<\/em>
The border has a raised inner edge and no outer edge. <\/p>\n
 RaisedOuter<\/em>
The border has a raised outer edge and no inner edge. <\/p>\n
Sunken<\/em>
The border has sunken inner and outer edges. <\/p>\n
SunkenInner<\/em>
The border has a sunken inner edge and no outer edge. <\/p>\n
SunkenOuter<\/em>
The border has a sunken outer edge and no inner edge.<\/p>\n
\"BorderStyles\"<\/p>\n<\/td>\n<\/tr>\n
Spring<\/td>\nIndicates whether the ToolStripStatusLabel automatically fills the available space on the StatusStrip as the form is resized. <\/p>\n
Values: True \/ False
<\/em>
\"Spring\"<\/td>\n<\/tr>\n
IsLink<\/td>\nIndicated whether the ToolStripLabel is a hyperlink. <\/p>\n
Values: True \/ False<\/p>\n
\"Label<\/em><\/td>\n<\/tr>\n
LinkBehavior<\/td>\nIndicates the behavior of a link.<\/p>\n
Values (Default: SystemDefault<\/em>):<\/p>\n
SystemDefault<\/em>
The behavior of this setting depends on the options set using the Internet Options dialog box in Control Panel or Internet Explorer. <\/p>\n
AlwaysUnderline<\/em>
The link always displays with underlined text. <\/p>\n
HoverUnderline<\/em>
The link displays underlined text only when the mouse is hovered over the link text. <\/p>\n
NeverUnderline<\/em>
The link text is never underlined. The link can still be distinguished from other text by use of the LinkColor property.<\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
 <\/p>\n
Making a Link Functional:<\/strong><\/p>\n
In order to have the Label open a webpage you will need to handle the label\u2019s Click event:<\/p>\n
$toolstripstatuslabelLink_Click<\/span>=<\/span>{\n    <\/span>#Open the URL in the Default Application<\/span>\n    [System.Diagnostics.Process]<\/span>::<\/span>Start(<\/span>$this<\/span>.Text)\n}<\/span><\/pre>\n
In the case where you don\u2019t want the text to show the actual link, you can instead store the link in the label\u2019s Tag property:<\/p>\n
\"Tag<\/p>\n
And modify the Click event as follows:<\/p>\n
$toolstripstatuslabelLink_Click<\/span>=<\/span>{\n    <\/span>#Show the URL stored in the TAG property<\/span>\n    <\/span>if<\/span>(<\/span>$this<\/span>.Tag <\/span>-is<\/span> [string])\n    {\n        [System.Diagnostics.Process]<\/span>::<\/span>Start(<\/span>$this<\/span>.Tag)\n    }\n}<\/span><\/pre>\n
<\/strong><\/font> <\/p>\n
ProgressBar<\/strong> [System.Windows.Forms.ToolStripProgressBar]<\/font><\/p>\n
\"ProgressBar\"<\/p>\n
Represents a Windows progress bar control contained in a StatusStrip. Use the Progress bar to show the total progress of an operation. <\/p>\n
Important Properties:<\/strong><\/p>\n\n\n\n\n\n\n\n
Properties<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n
Maximum<\/td>\nThe upper bound of the range that is defined for this ToolStripProgressBar.<\/td>\n<\/tr>\n
Minimum<\/td>\nThe lower bound of the range that is defined for this ToolStripProgressBar.<\/td>\n<\/tr>\n
Step<\/td>\nThe amount by which to increment the current value of the ToolStripProgressBar when the PerformStep method is called.<\/td>\n<\/tr>\n
Value<\/td>\nIndicates the current value of the ToolStripProgressBar.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Please refer to the Spotlight on the ProgressBar Control<\/a> blog article for more details on the progress bar.<\/p>\n
<\/strong><\/font> <\/p>\n
DropDownButton<\/strong> [System.Windows.Forms.ToolStripDropDownButton]<\/font><\/p>\n
\"DropDownButton\"<\/p>\n
Represents a button that when clicked displays an associated menu from which the user can select a single item. <\/p>\n
Important Properties:<\/strong><\/p>\n\n\n\n\n\n\n
Properties<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n
DropDown<\/td>\nSpecifies a ToolStripDropDown (such as a ContextMenuStrip) that will be displayed when this item is clicked.<\/td>\n<\/tr>\n
DropDownItems<\/td>\nSpecifies a ToolStripItem to display when this item is clicked.<\/td>\n<\/tr>\n
ShowDropDownArrow<\/td>\nSpecifies whether an arrow is displayed on the item, which indicates that further options are available in a drop-down list.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Important Events:<\/strong><\/p>\n\n\n\n\n
Properties<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n
DropDownItemClicked <\/td>\nOccurs when the ToolStripDropDown is clicked.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
$toolstripdropdownbutton2_DropDownItemClicked<\/span>=<\/span>[System.Windows.Forms.ToolStripItemClickedEventHandler]{\n<\/span>#Event Argument: $_ = [System.Windows.Forms.ToolStripItemClickedEventArgs]<\/span>\n    <\/span>Write-Host<\/span> <\/span>$_<\/span>.ClickedItem.Text\n}<\/span><\/pre>\n
Please refer to the Spotlight on the ContextMenuStrip Control<\/a> blog article for more details on the menus. <\/p>\n
Making an ordinary button:<\/strong><\/p>\n
\"Normal
In order to make a DropDownButton function like an ordinary button, you must do the following:<\/p>\n
\n
1. Set the ShowDropDownArrow property to False.
2. Clear any DropDown Items from the button.
3. Create an event handler for the DropDownButton\u2019s Click event.<\/p>\n<\/blockquote>\n
<\/p>\n
SplitButton<\/strong> [System.Windows.Forms.ToolStripSplitButton]<\/font><\/p>\n
\"SplitButton\"<\/font><\/p>\n
Represents a combination of a standard button on the left and a drop-down button on the right, or the other way around if the value of RightToLeft is Yes<\/em>.<\/p>\n
Important Properties<\/strong>:<\/p>\n\n\n\n\n\n
Properties<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n
DropDown<\/td>\nSpecifies a ToolStripDropDown (such as a ContextMenuStrip) that will be displayed when this item is clicked.<\/td>\n<\/tr>\n
DropDownItems<\/td>\nSpecifies a ToolStripItem to display when this item is clicked.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
<\/strong> <\/p>\n
Important Events:<\/strong><\/p>\n\n\n\n\n\n
Properties<\/strong><\/td>\nDescription<\/strong><\/td>\n<\/tr>\n
Click<\/td>\nOccurs when the button is clicked.<\/td>\n<\/tr>\n
DropDownItemClicked <\/td>\nOccurs when the ToolStripDropDown is clicked.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
 <\/p>\n
Please refer to the Spotlight on the ContextMenuStrip Control<\/a> blog article for more details on the menus.<\/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. Note: The StatusStrip control is only available for […]<\/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,744,312],"class_list":["post-4685","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-statusstrip","tag-winforms"],"jetpack_featured_media_url":"","_links":{"self":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/4685","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=4685"}],"version-history":[{"count":10,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/4685\/revisions"}],"predecessor-version":[{"id":4804,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/posts\/4685\/revisions\/4804"}],"wp:attachment":[{"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/media?parent=4685"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/categories?post=4685"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/dev.sapien.com\/blog\/wp-json\/wp\/v2\/tags?post=4685"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}