TableLayoutPanel.SetColumnSpan Method (Control, Int32)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Sets the number of columns spanned by the child control.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public void SetColumnSpan(
	Control control,
	int value
)

Parameters

control
Type: System.Windows.Forms.Control

A child control of the TableLayoutPanel.

value
Type: System.Int32

The number of columns to span.

Exception Condition
ArgumentOutOfRangeException

value is less than 1.

Column spanning is often useful for positioning a control that is considerably wider than its peers.

This method is called by the ColumnSpan property, which the panel adds to its child controls at design time.

The following code example uses the GetColumnSpan and SetColumnSpan methods to set the width of a Button control in a TableLayoutPanel.

  private void toggleSpanBtn_Click(
System.Object sender, 
System.EventArgs e)
  {
      Control c = this.TableLayoutPanel1.GetControlFromPosition(0, 0);

      if ( c != null )
      {
          int xSpan = this.TableLayoutPanel1.GetColumnSpan(c);
          int ySpan = this.TableLayoutPanel1.GetRowSpan(c);

          if (xSpan>1)
          {
              xSpan = 1;
              ySpan = 1;
          }
          else
          {
              xSpan = 2;
              ySpan = 2;
          }

          this.TableLayoutPanel1.SetColumnSpan(c, xSpan);
          this.TableLayoutPanel1.SetRowSpan(c, ySpan);
      }
  }

.NET Framework
Available since 2.0
Return to top
Show: