EmbedTypeLibrary Class

  • Article

Defines an MSBuild task that extracts a type library from an Office customization assembly into a DLL to enable interop with Visual Basic for Applications (VBA).

Inheritance Hierarchy

System.Object
  Microsoft.Build.Utilities.Task
    Microsoft.VisualStudio.Tools.Office.BuildTasks.BuildTask
      Microsoft.VisualStudio.Tools.Office.BuildTasks.EmbedTypeLibrary

Namespace:  Microsoft.VisualStudio.Tools.Office.BuildTasks
Assembly:  Microsoft.VisualStudio.Tools.Office.BuildTasks (in Microsoft.VisualStudio.Tools.Office.BuildTasks.dll)

Syntax

'Declaration
Public NotInheritable Class EmbedTypeLibrary _
    Inherits BuildTask

public sealed class EmbedTypeLibrary : BuildTask

The EmbedTypeLibrary type exposes the following members.

Constructors

  Name Description
Public method EmbedTypeLibrary Initializes a new instance of the EmbedTypeLibrary class.

Top

Properties

  Name Description
Public property Assembly Gets or sets the assembly from which to extract the type library.
Public property BuildEngine Gets or sets the instance of the IBuildEngine object used by the task. (Inherited from Task.)
Public property BuildEngine2 Gets the instance of the IBuildEngine2 object used by the task. (Inherited from Task.)
Public property BuildEngine3 Gets the instance of the IBuildEngine3 object used by the task. (Inherited from Task.)
Protected property HelpKeywordPrefix Gets or sets the prefix used to compose Help keywords from resource names. (Inherited from Task.)
Public property HostObject Gets or sets the host object associated with the task. (Inherited from Task.)
Public property KeyContainer Gets or sets the path to the cryptographic key container.
Public property KeyFile Gets or sets the path to the cryptographic key file.
Public property Log Gets an instance of a TaskLoggingHelper class containing task logging methods. (Inherited from Task.)
Public property ReferencePaths
Protected property TaskResources Gets or sets the culture-specific resources associated with the task. (Inherited from Task.)
Public property TypeLibFile Gets or sets the type library name that is extracted from the Assembly.

Top

Methods

  Name Description
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Public method Execute Extracts a type library from an Office customization assembly into a file, and embeds that file as an unmanaged resource into an assembly. (Overrides Task.Execute().)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

Set all of the EmbedTypeLibrary properties and then call Execute to run this task.

The Microsoft Build Engine uses Microsoft.VisualStudio.Tools.Office.BuildTasks to build and deploy Office solutions. However, you can create your own build system by using these classes and the MSBuild XML-based project files. For more information, see MSBuild Reference.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.VisualStudio.Tools.Office.BuildTasks Namespace