TableLayoutPanel.SetColumnSpan(Control, Int32) Method

Reference

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

Source:: TableLayoutPanel.cs

Source:: TableLayoutPanel.cs

Source:: TableLayoutPanel.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Sets the number of columns spanned by the child control.

public:
 void SetColumnSpan(System::Windows::Forms::Control ^ control, int value);

public void SetColumnSpan(System.Windows.Forms.Control control, int value);

member this.SetColumnSpan : System.Windows.Forms.Control * int -> unit

Public Sub SetColumnSpan (control As Control, value As Integer)

Parameters

control: Control

A child control of the TableLayoutPanel.

value: Int32

The number of columns to span.

Exceptions

ArgumentOutOfRangeException

value is less than 1.

Examples

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);
    }
}

Private Sub toggleSpanBtn_Click( _
ByVal sender As System.Object, _
ByVal e As System.EventArgs) _
Handles toggleSpanBtn.Click

    Dim c As Control = Me.TableLayoutPanel1.GetControlFromPosition(0, 0)

    If c IsNot Nothing Then

        Dim xSpan As Integer = Me.TableLayoutPanel1.GetColumnSpan(c)
        Dim ySpan As Integer = Me.TableLayoutPanel1.GetRowSpan(c)

        If xSpan > 1 Then

            xSpan = 1
            ySpan = 1

        Else

            xSpan = 2
            ySpan = 2

        End If

        Me.TableLayoutPanel1.SetColumnSpan(c, xSpan)
        Me.TableLayoutPanel1.SetRowSpan(c, ySpan)

    End If

End Sub

Remarks

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.

Applies to

Product	Versions
.NET Framework	2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop	3.0, 3.1, 5, 6, 7, 8, 9, 10

Share via