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)

[GuidAttribute("e0f1e721-d4f3-4abf-9e4e-938fa7cd98c3")]
public interface FormRegionCustomAction

The FormRegionCustomAction type exposes the following members.

  NameDescription
Public propertyAddressLikeGets or sets a value that specifies how to address the form that appears when the user executes the custom action.
Public propertyBodyGets 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 propertyEnabledGets or sets a value that indicates whether the FormRegionCustomAction is enabled for the form region.
Public propertyMethodGets or sets a value that specifies how to respond when the user executes the custom action.
Public propertyNameGets or sets the name of the custom action.
Public propertyShowOnRibbonGets 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 propertySubjectPrefixGets or sets the text that appears at the beginning of the subject line of the reply.
Public propertyTargetFormGets or sets the message class of the form that appears when the user executes the custom action.
Public propertyTitleGets or sets the name that is used to identify the custom action in the Custom Actions group of the Ribbon.
Top

  NameDescription
Public methodToXml()Returns a string that represents the FormRegionCustomAction as XML.
Public methodToXml(XmlWriter)Saves the XML representation of the custom action in a string to an XmlTextWriter object.
Top

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.

NoteNote

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: http://go.microsoft.com/fwlink/?LinkId=160658.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft