Share via


RegisterFormRegions Class

Defines an MSBuild task that gathers form region information to register or unregister the form regions for Microsoft Office Outlook 2007. This class cannot be inherited.

Inheritance Hierarchy

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

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 RegisterFormRegions _
    Inherits BuildTask
[ComVisibleAttribute(false)]
[PermissionSetAttribute(SecurityAction.Demand, Name = "FullTrust")]
public sealed class RegisterFormRegions : BuildTask

The RegisterFormRegions type exposes the following members.

Constructors

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

Top

Properties

  Name Description
Public property AddInName Gets or sets the name of the add-in.
Public property AssemblyName Gets or sets the name of the assembly.
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.)
Public property BuildEngine4 Gets the instance of the IBuildEngine4 object used by the task. (Inherited from Task.)
Public property FormRegionNamesAndMessageClasses Gets or sets an array of ITaskItem objects that represent the form region names and message classes.
Public property HostObject Gets or sets the host object associated with the task. (Inherited from Task.)
Public property Log Gets an instance of a TaskLoggingHelper class containing task logging methods. (Inherited from Task.)
Public property OfficeApplication Gets or sets the name of the Microsoft Office application for which the form regions are being registered.
Public property Unregister Gets or sets a value that indicates whether Execute will uninstall the form regions.

Top

Methods

  Name Description
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method Execute Gathers form region information to register the form regions for application loading, or unregister them to uninstall the form regions. (Overrides Task.Execute().)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

Set all of the RegisterFormRegions 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.

See Also

Reference

Microsoft.VisualStudio.Tools.Office.BuildTasks Namespace