FormRegionNameAttribute Class

Article
07/25/2011

Represents the name that uniquely identifies a form region across all Outlook add-ins.

Inheritance Hierarchy

System.Object
System.Attribute
Microsoft.Office.Tools.Outlook.FormRegionNameAttribute

Namespace: Microsoft.Office.Tools.Outlook
Assembly: Microsoft.Office.Tools.v4.0.Framework (in Microsoft.Office.Tools.v4.0.Framework.dll)

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple := False, Inherited := False)> _
Public NotInheritable Class FormRegionNameAttribute _
    Inherits Attribute

[AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple = false, Inherited = false)]
public sealed class FormRegionNameAttribute : Attribute

The FormRegionNameAttribute type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	Name	Gets a name that uniquely identifies the form region across all add-ins.
	TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)

Top

Methods

	Name	Description
	Equals	Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.)
	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	Returns the hash code for this instance. (Inherited from Attribute.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsDefaultAttribute	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.)
	Match	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.)
	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

Explicit Interface Implementations

	Name	Description
	_Attribute.GetIDsOfNames	Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.)
	_Attribute.GetTypeInfo	Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.)
	_Attribute.GetTypeInfoCount	Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.)
	_Attribute.Invoke	Provides access to properties and methods exposed by an object. (Inherited from Attribute.)

Top

Remarks

Because Outlook can load more than one add-in and each add-in can contain multiple form regions, you should ensure that the Name property of the FormRegionNameAttribute class is set to a unique name to avoid a name collision.

When you add an Outlook Form Region item to the project, Visual Studio automatically adds this attribute to the form region factory class in the form region code file. It sets the name of the attribute to the add-in name plus the form region item, separated by a dot—for example, "OutlookAddIn1.FormRegion1".

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