SetInclusionListEntry Class

Article
07/25/2011

SetInclusionListEntry creates or removes a user inclusion list entry at build time for application-level add-ins and document-level customizations in the 2007 Microsoft Office system. This class cannot be inherited.

Inheritance Hierarchy

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

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

Syntax

'Declaration
<ComVisibleAttribute(False)> _
<PermissionSetAttribute(SecurityAction.Demand, Name := "FullTrust")> _
Public NotInheritable Class SetInclusionListEntry _
    Inherits BuildTask

[ComVisibleAttribute(false)]
[PermissionSetAttribute(SecurityAction.Demand, Name = "FullTrust")]
public sealed class SetInclusionListEntry : BuildTask

The SetInclusionListEntry type exposes the following members.

Constructors

	Name	Description
	SetInclusionListEntry	Initializes a new instance of the SetInclusionListEntry class.

Top

Properties

	Name	Description
	BuildEngine	Gets or sets the instance of the IBuildEngine object used by the task. (Inherited from Task.)
	BuildEngine2	Gets the instance of the IBuildEngine2 object used by the task. (Inherited from Task.)
	BuildEngine3	Gets the instance of the IBuildEngine3 object used by the task. (Inherited from Task.)
	CertificateThumbprint	Gets or sets the certificate thumbprint.
	DeploymentManifestFullPath	Gets or sets the fully qualified path of the deployment manifest.
	HelpKeywordPrefix	Gets or sets the prefix used to compose Help keywords from resource names. (Inherited from Task.)
	HostObject	Gets or sets the host object associated with the task. (Inherited from Task.)
	Log	Gets an instance of a TaskLoggingHelper class containing task logging methods. (Inherited from Task.)
	TaskResources	Gets or sets the culture-specific resources associated with the task. (Inherited from Task.)
	Unregister	Gets or sets a value that indicates whether to remove the inclusion list entry.

Top

Methods

	Name	Description
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Execute	Creates or removes a record in a user inclusion list at build time for application-level add-ins and document-level customizations. (Overrides Task.Execute().)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

Set all of the SetInclusionListEntry properties, and then call Execute to run this build 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.

Share via