Button.Left Property

Definition

Namespace:

Microsoft.Office.Tools.Excel.Controls

Assembly:

Microsoft.Office.Tools.Excel.v4.0.Utilities.dll

Gets or sets the distance, in points, between the left edge of the Button and the left edge of the worksheet.

public:
 property double Left { double get(); void set(double value); };

public double Left { get; set; }

member this.Left : double with get, set

Public Property Left As Double

Property Value

Double

The distance, in points, between the left edge of the Button and the left edge of the worksheet.

Examples

The following code example compares the resizing and relocating behavior of two Button controls to a worksheet. The Click event handler of the first button adjusts the Height and Width properties of the button so that the button changes size, but remains in the same location on the worksheet. The Click event handler of the second button adjusts the Top and Left properties of the button so that the button changes location on the worksheet, but stays in the same size.

This example is for a document-level customization.

private void ModifySizeAndLocation()
{
    Microsoft.Office.Tools.Excel.Controls.Button sizeButton =
        this.Controls.AddButton(25, 30, 100, 25,
        "sizeButton");
    sizeButton.Name = "sizeButton";
    sizeButton.Text = "Click to resize";
    sizeButton.Click += new EventHandler(pointButtons_Click);

    Microsoft.Office.Tools.Excel.Controls.Button locationButton =
        this.Controls.AddButton(25, 150, 100, 25,
        "locationButton");
    locationButton.Name = "locationButton";
    locationButton.Text = "Click to move";
    locationButton.Click += new EventHandler(pointButtons_Click);
}

// Represents the toggle states of the buttons.
bool toggleState1 = true;
bool toggleState2 = true;

void pointButtons_Click(object sender, EventArgs e)
{
    Microsoft.Office.Tools.Excel.Controls.Button clickedButton =
        (Microsoft.Office.Tools.Excel.Controls.Button)sender;

    // Toggle the Height and Width of sizeButton.
    if (clickedButton.Name == "sizeButton")
    {
        if (toggleState1)
        {
            clickedButton.Height = 40;
            clickedButton.Width = 80;
            toggleState1 = false;
        }
        else
        {
            clickedButton.Height = 25;
            clickedButton.Width = 100;
            toggleState1 = true;
        }
    }

    // Toggle the Left and Top of locationButton.
    else
    {
        if (toggleState2)
        {
            clickedButton.Left = 50;
            clickedButton.Top = 100;
            toggleState2 = false;
        }
        else
        {
            clickedButton.Left = 25;
            clickedButton.Top = 150;
            toggleState2 = true;
        }
    }
}

Private Sub ModifySizeAndLocation()

    Dim SizeButton As Microsoft.Office.Tools.Excel.Controls.Button = _
        Me.Controls.AddButton(25, 30, 100, 25, "SizeButton")
    SizeButton.Name = "SizeButton"
    SizeButton.Text = "Click to resize"
    AddHandler SizeButton.Click, AddressOf PointButtons_Click

    Dim LocationButton As Microsoft.Office.Tools.Excel.Controls.Button = _
        Me.Controls.AddButton(25, 150, 100, 25, "LocationButton")
    LocationButton.Name = "LocationButton"
    LocationButton.Text = "Click to move"
    AddHandler LocationButton.Click, AddressOf PointButtons_Click
End Sub

' Represents the toggle states of the buttons.
Private toggleState1 As Boolean = True
Private toggleState2 As Boolean = True

Private Sub PointButtons_Click(ByVal sender As Object, ByVal e As EventArgs)
    Dim ClickedButton As Microsoft.Office.Tools.Excel.Controls.Button = _
        CType(sender, Microsoft.Office.Tools.Excel.Controls.Button)

    ' Toggle the Height and Width of sizeButton.
    If ClickedButton.Name = "SizeButton" Then
        If toggleState1 Then
            ClickedButton.Height = 40
            ClickedButton.Width = 80
            toggleState1 = False
        Else
            ClickedButton.Height = 25
            ClickedButton.Width = 100
            toggleState1 = True
        End If

    ' Toggle the Left and Top of locationButton.
    Else
        If toggleState2 Then
            ClickedButton.Left = 50
            ClickedButton.Top = 100
            toggleState2 = False
        Else
            ClickedButton.Left = 25
            ClickedButton.Top = 150
            toggleState2 = True
        End If
    End If
End Sub

Remarks

The Microsoft.Office.Tools.Excel.Controls.Button.Left property uses points, whereas System.Windows.Forms.Control.Left property uses pixels.

Setting the value to a negative number or a number higher than 12288 does not throw an exception but results in the control being set between 0 and 12288.