Windows Forms FAQs

How can I bind a list of items to entries in a ToolStripDropDown?

admin — Fri, 14 Jul 2006 03:22:27 GMT

Several people have asked on the newsgroups about a good method to bind a list of items to entries in a ToolStripDropDown instance. I've run into this issue a couple of times and wanted to share some sample code.

The class takes in a ToolStripDropDown instance. You can then set the data source to any IEnumerable collection. Whenever the data in the list changes, call ReloadFromSource(). Or alternately, if the list implements IBindingList then it will automatically update.

Imports System.ComponentModel

Public Class DropDownBinding
    Private m_dd As ToolStripDropDown
    Private m_list As IEnumerable
    Private m_bindingList As IBindingList

    Public Sub New(ByVal dd As ToolStripDropDown)
        m_dd = dd
        m_list = New List(Of Object)()
    End Sub

    Public Sub SetDataSource(ByVal e As IEnumerable)
        If Not m_bindingList Is Nothing Then
            RemoveHandler m_bindingList.ListChanged, New ListChangedEventHandler(AddressOf Me.OnListChanged)
        End If

        m_bindingList = TryCast(e, IBindingList)
        m_list = e

        If Not m_bindingList Is Nothing Then
            AddHandler m_bindingList.ListChanged, New ListChangedEventHandler(AddressOf Me.OnListChanged)
        End If

        RebuildList()
    End Sub

    Public Sub ReloadFromSource()
        RebuildList()
    End Sub

    Private Sub OnListChanged(ByVal sender As Object, ByVal e As ListChangedEventArgs)
        RebuildList()
    End Sub

    Private Sub RebuildList()
        m_dd.Items.Clear()

        For Each cur As Object In m_list
            m_dd.Items.Add(cur.ToString())
        Next
    End Sub
End Class

From Jared Parsons

How can I reset the settings?

admin — Wed, 12 Jul 2006 21:00:00 GMT

The sample code below will do that – it simply uses a named set of settings that captures the state before any custom settings are applied. Then, with button click or whatever you can apply the custom set.

private void Form1_Load(object sender, EventArgs e)
{
// save out a snapshop of init component
ToolStripManager.SaveSettings(this, "RESET");

// load and apply settings last saved
ToolStripManager.LoadSettings(this);
}

private void newToolStripMenuItem_Click(object sender, EventArgs e)
{
// apply the RESET settings
ToolStripManager.LoadSettings(this, "RESET");
}

private void Form1_FormClosing(object sender, FormClosingEventArgs e)
{
// Save out current state of ToolStrips
ToolStripManager.SaveSettings(this);
}

How do I programatically move ToolStrips within or across ToolStripPanels?

admin — Wed, 12 Jul 2006 20:58:01 GMT

Within a ToolStrip:

Simply set the ToolStrip Location property.

Across ToolStrips:

Either add the ToolStrip to the ToolStripPanel's Controls collection or use Join(ToolStrip).

NOTE: Join() simulates the drop operation of a ToolStrip and is order dependent.

How can I use the ToolStripPanel with MDI applications?

admin — Wed, 12 Jul 2006 20:57:40 GMT

The following is how to use ToolStripPanels correctly in an MDIParent. This is important, because due to layering and MDI limiations, use of ToolStripContainer doesn't work well.

  public Form1()
  {
   // Make Form MDI Parent
   this.IsMdiContainer = true;

   // Add toolstrip panels
   ToolStripPanel tspTop = new ToolStripPanel();
   ToolStripPanel tspBottom = new ToolStripPanel();
   ToolStripPanel tspLeft = new ToolStripPanel();
   ToolStripPanel tspRight = new ToolStripPanel();

   // dock the ToolStripPanels
   tspTop.Dock = DockStyle.Top;
   tspBottom.Dock = DockStyle.Bottom;
   tspLeft.Dock = DockStyle.Left;
   tspRight.Dock = DockStyle.Right;

   // add toolstrips to move around between the panels
   ToolStrip tsTop = new ToolStrip();
   tsTop.Items.Add("Top");
   tspTop.Join(tsTop);

   ToolStrip tsBottom = new ToolStrip();
   tsBottom.Items.Add("Bottom");
   tspBottom.Join(tsBottom);

   ToolStrip tsRight = new ToolStrip();
   tsRight.Items.Add("Right");
   tspRight.Join(tsRight);

   ToolStrip tsLeft = new ToolStrip();
   tsLeft.Items.Add("Left");
   tspLeft.Join(tsLeft);

   // add menustrip, with new window
   MenuStrip ms = new MenuStrip();
   ToolStripMenuItem windowMenu = new ToolStripMenuItem("Window");
   ToolStripMenuItem windowNewMenu = new ToolStripMenuItem("New", null, new EventHandler(windowNewMenu_Click));
   windowMenu.DropDownItems.Add(windowNewMenu);
   ((ToolStripDropDownMenu)(windowMenu.DropDown)).ShowImageMargin = false;
   ((ToolStripDropDownMenu)(windowMenu.DropDown)).ShowCheckMargin = true;

   ms.MdiWindowListItem = windowMenu;

   ms.Items.Add(windowMenu);
   ms.Dock = DockStyle.Top;

   // Form.MainMenuStrip determines merge target
   MainMenuStrip = ms;

   // add a button to the MDIClient area
   Button b = new Button();
   b.AutoSize = true;
   b.Text = "In the MDI Container";

   // Add the ToolStripPanels to the form in reverse order
   this.Controls.Add(tspRight);
   this.Controls.Add(tspLeft);
   this.Controls.Add(tspBottom);
   this.Controls.Add(tspTop);

   // add menustrip last - Z order!
   this.Controls.Add(ms);

  }

  void windowNewMenu_Click(object sender, EventArgs e)
  {
   Form f = new Form();
   f.MdiParent = this;
   f.Text = "Form - " + this.MdiChildren.Length.ToString();
   f.Show();

  }
 }

Why does the ToolStripContainer not support MDI?

admin — Wed, 12 Jul 2006 20:57:08 GMT

ToolStripContainer does not support MDI properly because, like any dock filled container, it would be layered above the MDI child container that is part of the MDI parent. To workaround this, use ToolStripPanel – see that section for a code example.

What is the ToolStripContainer?

admin — Wed, 12 Jul 2006 20:56:46 GMT

ToolStrip container is a composite control very similar in overall design to the SplitContainer. It takes four ToolStripPanels docked to the sides and one ContentPanel dock filled in the middle to make up the typical four sided arrangment commonly used today. Below are some quick notes on ToolStripContainer parts.

Sides – ToolStripPanels

The ToolStripPanels on the sides are not removable from the the container, but can be hidden via their respective visible property(Top -> TopToolStripPanelVisble, etc). Visible false means they would not participate in the drag to dock scnearions.

// to hide left and right panels
toolStripContainer1.LeftToolStripPanelVisible = false;
toolStripContainer1.RightToolStripPanelVisible = false;

Center – ContentPanel

The Content panel provides a way to get Renderer support into the body of your form to create a consistent look. It cannot be hidden. It does supports transparency and backcolor, but it may be prudent in many scenarios that require this to dock ToolStripPanels to the side instead.

Design Time

ToolStripContainer offers several design time features not found on other controls. Below is a description of a few of these.

Expando handles

On each ToolStripPanel we offer a handle to temporarily expand the ToolStripPanel to ease rearrangement of ToolStrips and enlarge the drop area. These are not rendered at runtime.

Reparent Controls

A designer verb, also shown on the Designer Action panel, is Reparent controls. This takes all controls on the form and reparents them to the ToolStripContainer. All ToolStrips are mapped into the ToolStripPanels and all other controls parented to the form are reparented to the ContentPanel.

How can I disable Visual Styles?

admin — Wed, 12 Jul 2006 20:56:22 GMT

The System Renderer renders ToolStrips similar to Win32 look and feel. You can use with or without VisualStyles by

ToolStripManager.VisualStylesEnabled = false;

How can I get the Office look and feel to have straight ends?

admin — Wed, 12 Jul 2006 20:56:00 GMT

Set RoundedEdges = false. You may also have to override OnRendererToolStripBorder and not call base.

 ((ToolStripProfessionalRenderer)ToolStripManager.Renderer).RoundedEdges = false;

How can I change text color on selection?

admin — Wed, 12 Jul 2006 20:55:40 GMT

Below is an example of changing text color on selection within a custom renderer:

protected override void OnRenderItemText(ToolStripItemTextRenderEventArgs e)
  {
  if (e.Item.Selected)
    {
       e.TextColor = Color.Gold;
    }
  else
    {
       e.Item.ForeColor = Color.White;
    }

  base.OnRenderItemText(e);
  }

What is the ConnectedArea?

admin — Wed, 12 Jul 2006 20:55:22 GMT

Connected area is that little bit of the dropdown for a menu where the border is discontinuous. Below is an examples of how to access and paint that.

protected override void OnRenderToolStripBorder(ToolStripRenderEventArgs e)
{
    using (Brush b = new SolidBrush(ColorTable.MyBackgroundColor))
    {
        e.Graphics.FillRectangle(b, e.ConnectedArea);
    }
}

How do I change the ProfessionalColorTable?

admin — Wed, 12 Jul 2006 20:55:03 GMT

Override ProfessionalColorTable and change only the colors you care about.

  Private Sub Form1_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Me.Load
     Dim t As MyColorTable = New MyColorTable
    ToolStrip1.Renderer = New ToolStripProfessionalRenderer(t)
  End Sub
  Class MyColorTable
    Inherits ProfessionalColorTable
    Public Overrides ReadOnly Property ButtonPressedGradientBegin() As Color
    Get
      Return Color.FromArgb(147, 210, 254)
    End Get
    End Property
    Public Overrides ReadOnly Property ButtonPressedGradientMiddle() As System.Drawing.Color
    Get
      Return Color.FromArgb(83, 132, 252)
    End Get
    End Property
    Public Overrides ReadOnly Property ButtonPressedGradientEnd() As System.Drawing.Color
    Get
      Return Color.FromArgb(18, 55, 250)
    End Get
    End Property
    Public Overrides ReadOnly Property ButtonSelectedGradientBegin() As Color
    Get
      Return Color.FromArgb(204, 227, 255)
    End Get
    End Property
    Public Overrides ReadOnly Property ButtonSelectedGradientMiddle() As System.Drawing.Color
    Get
      Return Color.FromArgb(160, 199, 255)
    End Get
    End Property
    Public Overrides ReadOnly Property ButtonSelectedGradientEnd() As System.Drawing.Color
    Get
      Return Color.FromArgb(116, 171, 255)
    End Get
    End Property
  End Class

Below is an example of Custom Professional Colors w/ built in ProfessionalRenderer and setting Renderer at runtime.

 class Form2 : Form
 {
  public Form2()
  {
   // new toolstrip
   ToolStrip ts = new ToolStrip();
   ts.Items.Add("Apples");
   ts.Items.Add("Oranges");
   ts.Items.Add("Pears");
   ts.Items.Add("Change Colors", null, new EventHandler(ChangeColors_Click));

   // new menustrip, with new window
   MenuStrip ms = new MenuStrip();
   ms.Dock = DockStyle.Top;

   // add top level items
   ms.Items.Add("File");
   ms.Items.Add("Edit");
   ms.Items.Add("View");
   ms.Items.Add("Window");

   // Add toolstrip to controls collection
   this.Controls.Add(ts);

   // Add menustrip to controls collection last - Z order!
   this.Controls.Add(ms);
  }

  void ChangeColors_Click(object sender, EventArgs e)
  {
   ToolStripManager.Renderer = new ToolStripProfessionalRenderer(new CustomProfessionalColors());
  }
 }

 class CustomProfessionalColors : ProfessionalColorTable
 {
  public override Color ToolStripGradientBegin
  { get { return Color.BlueViolet; } }

  public override Color ToolStripGradientMiddle
  { get { return Color.CadetBlue; } }

  public override Color ToolStripGradientEnd
  { get { return Color.CornflowerBlue; } }

  public override Color MenuStripGradientBegin
  { get { return Color.BlueViolet; } }

  public override Color MenuStripGradientEnd
  { get { return Color.CornflowerBlue; } }
 }

What order do the ToolStrip Renderer events come in?

admin — Wed, 12 Jul 2006 20:54:37 GMT

Generally its this - background, item background, item foregound effects, toolstrip border.

OnRenderToolStripBackground
OnRender[Label|Button|MenuItem...]Background
OnRenderItemText
OnRenderItemArrow
OnRenderItemImage
OnRenderToolStripBorder

The toolstrip border is painted last, as it's sort of a last chance fixup paint if the items happen to go edge to edge.

When should I use a renderer and when should I just override OnPaint

admin — Wed, 12 Jul 2006 20:54:19 GMT

Use draw from custom ToolStrip handler – which is the entry point into Renderer code. OnRender* will be called as a result. To change Renderer behavior, override OnRender*.

public class MyLabel : ToolStripLabel{
   protected override void OnPaint(PaintEventArgs e) {
    // Advantage here is that you'd get free disabled image support
    this.Parent.Renderer.DrawItemImage(new ToolStripItemImageRenderEventArgs(e.Graphics, this, this.Image, this.Bounds));
   }
}

Can I make the ProfessionalRenderer look like the old Office?

admin — Wed, 12 Jul 2006 20:54:00 GMT

Yes...

Create a class which overrides the ToolStripProfessionalRenderer called OldProfessionalRenderer

Pass in a new ProfessionalColorTable with professionalColorTable.UseSystemColors = false;

In the OldProfessionalRenderer class, override the following methods:

OnRenderImageMargin (clear with ControlLight),
OnRenderBorder (do nothing),
OnRenderToolStripBackground (clear with ControlLight).

How do I turn off the "Office" colors?

admin — Wed, 12 Jul 2006 20:53:31 GMT

For one ToolStrip

ProfessionalColorTable colorTable = new ProfessionalColorTable();
colorTable.UseSystemColors = true;
toolStrip.Renderer = new ToolStripProfessionalRenderer(colorTable);

For the entire app:

ToolStripManager.VisualStylesEnabled = false;