ControlCollection.AddPictureBox Method (Single, Single, Single, Single, String)

Article
06/18/2009

Adds a new PictureBox control to the document in the specified size and location.

Namespace: Microsoft.Office.Tools.Word
Assembly: Microsoft.Office.Tools.Word.v9.0 (in Microsoft.Office.Tools.Word.v9.0.dll)

Syntax

'Declaration
Public Function AddPictureBox ( _
    left As Single, _
    top As Single, _
    width As Single, _
    height As Single, _
    name As String _
) As PictureBox
'Usage
Dim instance As ControlCollection
Dim left As Single
Dim top As Single
Dim width As Single
Dim height As Single
Dim name As String
Dim returnValue As PictureBox

returnValue = instance.AddPictureBox(left, _
    top, width, height, name)

public PictureBox AddPictureBox(
    float left,
    float top,
    float width,
    float height,
    string name
)

Parameters

left
Type: System.Single
The distance in points between the left edge of the control and the left edge of the document.

top
Type: System.Single
The distance in points between the top edge of the control and the top edge of the document.

width
Type: System.Single
The width of the control in points.

height
Type: System.Single
The height of the control in points.

name
Type: System.String
The name that can be used to index the control in the ControlCollection instance.

Return Value

Type: Microsoft.Office.Tools.Word.Controls.PictureBox
The PictureBox control that was added to the ControlCollection instance.

Exceptions

Exception	Condition
ArgumentNullException	The name argument is nulla null reference (Nothing in Visual Basic) or has zero length.
ControlNameAlreadyExistsException	A control with the same name is already in the ControlCollection instance.

Remarks

This method enables you to add PictureBox objects to the end of the ControlCollection.

To remove a PictureBox that was added programmatically, use the Remove method.

Examples

The following code example adds a PictureBox control to the start of the document, and then adds an image. The example assumes a file named Image.jpg exists at the root of the C directory.

    Private Sub WordAddPictureBox()
        Me.Paragraphs(1).Range.InsertParagraphBefore()
        Dim PictureBox1 As Microsoft.Office.Tools.Word.Controls. _
            PictureBox = Me.Controls.AddPictureBox(0, 0, 150, 150, _
            "PictureBox1")
        PictureBox1.Image = System.Drawing.Image.FromFile( _
            "C:\Image.jpg")

    End Sub

private void WordAddPictureBox()
{
    this.Paragraphs[1].Range.InsertParagraphBefore();
    Microsoft.Office.Tools.Word.Controls.PictureBox
         pictureBox1 = this.Controls.AddPictureBox(
         0, 0, 150, 150, "pictureBox1");
    pictureBox1.Image = System.Drawing.Image.FromFile(
        "C:\\Image.jpg");
}

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via