InsertEmbeddedObjectFromFile Method (ISketchManager)

InsertEmbeddedObjectFromFile Method (ISketchManager) | Send Feedback
See Also Example

EmbeddedObject[out]
  IEmbeddedObject

FilePath
  Path and file name of the embedded object to insert

Link
  True to insert a picture of the original file into the drawing, false to insert the contents of the file into the drawing (see Remarks)

DisplayAsIcon
  True to display the application icon in the drawing, false to display it in the data

Adds an embedded object to the document based on the specified file.

# Syntax

Visual Basic |
--- | ---
    Function InsertEmbeddedObjectFromFile( _
       ByVal FilePath As System.String, _
       ByVal Link As System.Boolean, _
       ByVal DisplayAsIcon As System.Boolean _
    ) As EmbeddedObject

C# |
--- | ---
    EmbeddedObject InsertEmbeddedObjectFromFile(
       System.string FilePath,
       System.bool Link,
       System.bool DisplayAsIcon
    )

JavaScript |
--- | ---
    InsertEmbeddedObjectFromFile(
       FilePath : String,
       Link : Boolean,
       DisplayAsIcon : Boolean
    ) : dsObject

COM native C++ |
--- | ---
    HRESULT InsertEmbeddedObjectFromFile(
       BSTR FilePath,
       VARIANT_BOOL Link,
       VARIANT_BOOL DisplayAsIcon,
       IEmbeddedObject** EmbeddedObject
    )

C++ |
--- | ---
    DSRESULT InsertEmbeddedObjectFromFile(
       const dsString& FilePath,
       bool Link,
       bool DisplayAsIcon,
       dsEmbeddedObject** EmbeddedObject
    )

#### Parameters

FilePath
  Path and file name of the embedded object to insert
Link
  True to insert a picture of the original file into the drawing, false to insert the contents of the file into the drawing (see Remarks)
DisplayAsIcon
  True to display the application icon in the drawing, false to display it in the data
EmbeddedObject[out] or Return Value
  IEmbeddedObject

# Example

Insert Embedded Object (JavaScript)
Insert Embedded Object (VB.NET)
Insert Embedded Object (C#)
Insert Embedded Object (VBA)

# Remarks

There are two ways to insert data from files:

- Linked object. Specify Link = true to insert a picture of the file into the drawing. When you edit a linked object, the source file changes. When you edit the source file, the linked object changes.
- Embedded object. Specify Link = false to insert the contents of the file into the drawing so that you may activate it using the source application that created it. Changes you make to the data in the embedded object do not appear in the original file, and changes you make to the original file do not appear in the drawing.

# See Also

####

ISketchManager Interface
ISketchManager Members

# Availability

DraftSight V1R1.4