FormRegionCustomAction Interface

Represents a custom action that appears in the Custom Actions group on the Ribbon of an Outlook item.

Namespace:  Microsoft.Office.Tools.Outlook
Assemblies:   Microsoft.Office.Tools.Outlook (in Microsoft.Office.Tools.Outlook.dll)
  Microsoft.Office.Tools.Outlook.v4.0.Utilities (in Microsoft.Office.Tools.Outlook.v4.0.Utilities.dll)

Syntax

'Declaration
<GuidAttribute("e0f1e721-d4f3-4abf-9e4e-938fa7cd98c3")> _
Public Interface FormRegionCustomAction
[GuidAttribute("e0f1e721-d4f3-4abf-9e4e-938fa7cd98c3")]
public interface FormRegionCustomAction

The FormRegionCustomAction type exposes the following members.

Properties

  Name Description
Public property AddressLike Gets or sets a value that specifies how to address the form that appears when the user executes the custom action.
Public property Body Gets or sets a value that specifies how the Message or Notes field of an Outlook item is included in the reply that appears when the user executes the custom action.
Public property Enabled Gets or sets a value that indicates whether the FormRegionCustomAction is enabled for the form region.
Public property Method Gets or sets a value that specifies how to respond when the user executes the custom action.
Public property Name Gets or sets the name of the custom action.
Public property ShowOnRibbon Gets or sets a value that indicates whether to show the FormRegionCustomAction in the Custom Actions group of the Ribbon that displays the form region.
Public property SubjectPrefix Gets or sets the text that appears at the beginning of the subject line of the reply.
Public property TargetForm Gets or sets the message class of the form that appears when the user executes the custom action.
Public property Title Gets or sets the name that is used to identify the custom action in the Custom Actions group of the Ribbon.

Top

Methods

  Name Description
Public method ToXml() Returns a string that represents the FormRegionCustomAction as XML.
Public method ToXml(XmlWriter) Saves the XML representation of the custom action in a string to an XmlTextWriter object.

Top

Remarks

Actions display buttons that enable users to respond to a Microsoft Office Outlook item. You can create a custom action that opens any kind of Outlook item. These actions appear in the Custom Actions group on the Ribbon of an Outlook item.

For more information about custom actions, see Custom Actions in Outlook Form Regions.

Note

This interface is implemented by the Visual Studio Tools for Office runtime. It is not intended to be implemented in your code. For more information, see Visual Studio Tools for Office Runtime Overview.

Usage

This documentation describes the version of this type that is used in Office projects that target the .NET Framework 4 and the .NET Framework 4.5. In projects that target the .NET Framework 3.5, this type might have different members and the code examples provided for this type might not work. For documentation about this type in projects that target the .NET Framework 3.5, see the following reference section in the Visual Studio 2008 documentation: https://go.microsoft.com/fwlink/?LinkId=160658.

See Also

Reference

Microsoft.Office.Tools.Outlook Namespace