OLEObjects.Add Method

  • Article

Adds a new OLE object to a sheet. Returns an OLEObject object.

Namespace:  Microsoft.Office.Interop.Excel
Assembly:  Microsoft.Office.Interop.Excel (in Microsoft.Office.Interop.Excel.dll)

Syntax

'Declaration
Function Add ( _
    ClassType As Object, _
    Filename As Object, _
    Link As Object, _
    DisplayAsIcon As Object, _
    IconFileName As Object, _
    IconIndex As Object, _
    IconLabel As Object, _
    Left As Object, _
    Top As Object, _
    Width As Object, _
    Height As Object _
) As OLEObject
'Usage
Dim instance As OLEObjects
Dim ClassType As Object
Dim Filename As Object
Dim Link As Object
Dim DisplayAsIcon As Object
Dim IconFileName As Object
Dim IconIndex As Object
Dim IconLabel As Object
Dim Left As Object
Dim Top As Object
Dim Width As Object
Dim Height As Object
Dim returnValue As OLEObject

returnValue = instance.Add(ClassType, _
    Filename, Link, DisplayAsIcon, IconFileName, _
    IconIndex, IconLabel, Left, Top, Width, _
    Height)

OLEObject Add(
    Object ClassType,
    Object Filename,
    Object Link,
    Object DisplayAsIcon,
    Object IconFileName,
    Object IconIndex,
    Object IconLabel,
    Object Left,
    Object Top,
    Object Width,
    Object Height
)

Parameters

  • ClassType
    Type: System.Object

    Optional Object. (You must specify either ClassType or FileName.) A string that contains the programmatic identifier for the object to be created. If ClassType is specified, FileName and Link are ignored.

  • Filename
    Type: System.Object

    Optional Object. (You must specify either ClassType or FileName.) A string that specifies the file to be used to create the OLE object.

  • Link
    Type: System.Object

    Optional Object. True to have the new OLE object based on FileName be linked to that file. If the object isn't linked, the object is created as a copy of the file. The default value is False.

  • DisplayAsIcon
    Type: System.Object

    Optional Object. True to display the new OLE object either as an icon or as its regular picture. If this argument is True, IconFileName and IconIndex can be used to specify an icon.

  • IconFileName
    Type: System.Object

    Optional Object. A string that specifies the file that contains the icon to be displayed. This argument is used only if DisplayAsIcon is True. If this argument isn't specified or the file contains no icons, the default icon for the OLE class is used

  • IconIndex
    Type: System.Object

    Optional Object. The number of the icon in the icon file. This is used only if DisplayAsIcon is True and IconFileName refers to a valid file that contains icons. If an icon with the given index number doesn't exist in the file specified by IconFileName, the first icon in the file is used.

  • IconLabel
    Type: System.Object

    Optional Object. A string that specifies a label to display beneath the icon. This is used only if DisplayAsIcon is True. If this argument is omitted or is an empty string (""), no caption is displayed.

  • Left
    Type: System.Object

    Optional Object. The initial coordinates of the new object in points, relative to the upper-left corner of cell A1 on a worksheet, or to the upper-left corner of a chart.

  • Top
    Type: System.Object

    Optional Object. The initial coordinates of the new object in points, relative to the upper-left corner of cell A1 on a worksheet, or to the upper-left corner of a chart.

  • Width
    Type: System.Object

    Optional Object. The initial size of the new object in points.

  • Height
    Type: System.Object

    Optional Object. The initial size of the new object, in points.

Return Value

Type: Microsoft.Office.Interop.Excel.OLEObject

See Also

Reference

OLEObjects Interface

OLEObjects Members

Microsoft.Office.Interop.Excel Namespace