Button.Left Property

Definition

Namespace:

Microsoft.Office.Tools.Word.Controls

Assembly:

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

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

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

public float Left { get; set; }

member this.Left : single with get, set

Public Property Left As Single

Property Value

Single

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

Examples

The following code example demonstrates the Left property of the Button control. The example adds two Button controls named sizeButton and locationButton to a document. When sizeButton is clicked, the Height and Width properties are adjusted so that the button changes size. When locationButton is clicked, the Top and Left properties are adjusted so that the button changes location. After each button is modified, the example displays the new Right, Bottom, Height, Width, Top and Left property values of the clicked button in a message box.

This example is for a document-level customization.

private void ModifySizeAndLocation()
{
    // Create a button that resizes when clicked.
    Microsoft.Office.Tools.Word.Controls.Button sizeButton =
        this.Controls.AddButton(25, 25, 80, 30, "sizeButton");
    sizeButton.Name = "sizeButton";
    sizeButton.Text = "Click to change size";
    sizeButton.Click += new EventHandler(modifyButtons_Click);

    // Create a button that moves when clicked.
    Microsoft.Office.Tools.Word.Controls.Button locationButton =
        this.Controls.AddButton(50, 100, 80, 30, "locationButton");
    locationButton.Name = "locationButton";
    locationButton.Text = "Click to change location";
    locationButton.Click += new EventHandler(modifyButtons_Click);
}

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

// Modify the appearance of the clicked button.
void modifyButtons_Click(object sender, EventArgs e)
{
    Microsoft.Office.Tools.Word.Controls.Button clickedButton =
        (Microsoft.Office.Tools.Word.Controls.Button)sender;

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

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

    // Display the new property values.
    MessageBox.Show("Right: " +
        clickedButton.Right.ToString() +
        "\nBottom: " + clickedButton.Bottom.ToString() +
        "\nTop: " + clickedButton.Top.ToString() +
        "\nLeft: " + clickedButton.Left.ToString() +
        "\nHeight: " + clickedButton.Height.ToString() +
        "\nWidth: " + clickedButton.Width.ToString());
}

Private Sub ModifySizeAndLocation()

    ' Create a button that resizes when clicked.
    Dim SizeButton As Microsoft.Office.Tools.Word.Controls.Button = _
        Me.Controls.AddButton(25, 25, 80, 30, "SizeButton")
    SizeButton.Name = "SizeButton"
    SizeButton.Text = "Click to change size"
    AddHandler SizeButton.Click, AddressOf ModifyButtons_Click

    ' Create a button that moves when clicked.
    Dim LocationButton As Microsoft.Office.Tools.Word.Controls.Button = _
        Me.Controls.AddButton(50, 100, 80, 30, "LocationButton")
    LocationButton.Name = "LocationButton"
    LocationButton.Text = "Click to change location"
    AddHandler LocationButton.Click, AddressOf ModifyButtons_Click
End Sub

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

' Modify the appearance of the clicked button.
Private Sub ModifyButtons_Click(ByVal sender As Object, ByVal e As EventArgs)
    Dim ClickedButton As Microsoft.Office.Tools.Word.Controls.Button = _
        CType(sender, Microsoft.Office.Tools.Word.Controls.Button)

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

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

    ' Display the new Right and Bottom.
    MsgBox("Right: " & ClickedButton.Right.ToString() & _
        vbCr + "Bottom: " & ClickedButton.Bottom.ToString() & _
        vbCr + "Top: " & ClickedButton.Top.ToString() & _
        vbCr + "Left: " & ClickedButton.Left.ToString() & _
        vbCr + "Height: " & ClickedButton.Height.ToString() & _
        vbCr + "Width: " & ClickedButton.Width.ToString())
End Sub

Remarks

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