Microsoft.Office.Tools.Outlook

Provides methods you can use to perform miscellaneous tasks in an Outlook add-in, such as creating form region controls, form region manifest objects, and custom actions.

Creates an of objects.

An of objects.

Creates a an instance of a class that implements the interface.

A that is based on a user control. A that represents the native form region. An instance of a class that implements the interface.

Creates an instance of a class that implements the interface with a default name.

A that represents a custom action.

Creates an instance of a class that implements the class by using the specified name.

A that represents a custom action. A string that represents the name of the custom action.

Creates a object that provides data for the FormRegionInitializing event of the form region factory class.

A that provides data for the FormRegionInitializing event of the form region factory class. The Outlook item that caused the form region to load. The mode of the Outlook item that caused the form region to load. This mode is represented by the enumeration. The type of form region that loads. This mode is represented by the enumeration. A that indicates whether the form region should appear for .

Creates a form region manifest that describes how the form region appears in Outlook.

A that describes how the form region appears in Outlook.

Creates a Microsoft Office Outlook form region that is based on an Outlook Form Storage (*.ofs) file.

A that represents a form region that is based on an Outlook Form Storage (*.ofs) file. A that represents the native form region. An instance of a class that implements the interface.

Represents an Outlook form region that is based on a user control.

Gets or sets the form region factory that is associated with this .

An object that implements the interface.

Occurs before the form region is closed.

Occurs after an instance of the form region is created but before the form region appears.

Gets the that describes how the form region appears in Outlook.

The that describes how the form region appears in Outlook.

Gets or sets the native form region object.

A that represents the form region.

Gets the Outlook item in which the form region appears.

An that represents the Outlook item in which the form region appears.

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

Gets or sets a value that specifies how to address the form that appears when the user executes the custom action.

One of the values that specify how to address the target form that appears when the user executes the custom action. The default is .

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.

One of the values that specify how the Message or Notes field of an Outlook item is appended to the form that appears when the user executes the custom action. The default is .

Gets or sets a value that indicates whether the is enabled for the form region.

true if the is enabled; otherwise, false. The default is true.

Gets or sets a value that specifies how to respond when the user executes the custom action.

One of the values that specify how to respond when the user executes the custom action. The default is .

Gets or sets the name of the custom action.

A string that represents the name of the custom action. The value is null, or is empty. The value is greater than 256 characters in length.

Gets or sets a value that indicates whether to show the in the Custom Actions group of the Ribbon that displays the form region.

true if the appears on the Ribbon; otherwise, false. The default is true.

Gets or sets the text that appears at the beginning of the subject line of the reply.

A string that represents text that appears at the beginning of the subject line of the original form. The value is greater than 256 characters in length.

Gets or sets the message class of the form that appears when the user executes the custom action.

A string that represents the message class of the form that appears when a user executes the custom action. The value is greater than 256 characters in length. The value of the string is empty or contains the name of a message class that is not valid.

Gets or sets the name that is used to identify the custom action in the Custom Actions group of the Ribbon.

A string that represents the name that is used to identify the custom action in the Custom Actions group of the Ribbon. The value is greater than 256 characters in length.

Returns a string that represents the as XML.

A string that represents the as XML.

Saves the XML representation of the custom action in a string to an object.

An to which to write the string.

Specifies how to address the target item that appears when the user executes the custom action.

Makes the new item a reply to the original item. If you create a new mail message, this option copies the address that appears in the From field of the message into the To field of the new message. The text that appears in the Subject field of the new message contains the text that appeared in the original Subject field.

Makes the new item a reply to all of the senders and recipients of the original item. If you create a new mail item, this option copies the addresses that appear in the From and To fields of the message into the To field of the target form. This option also copies the addresses that appear in the CC field of the message into the CC field of the target form. The text that appears in the Subject field of the new message contains the text that appeared in the original Subject field.

Makes the new item a forward of the original item. If you create a new mail message, this option clears the To and CC fields of the new message. The text that appears in the Subject field of the new message contains the text that appeared in the original Subject field. The attachments on the original item are copied to the new item.

If you create a new Post item, this option posts the item to the active folder. This item also copies the text that appears in the Subject field into the Conversation field of the new item. It then clears the Subject field of the new item.

Causes the custom action button to appear when you click the Vote button in the Respond group of the Ribbon.

Specifies how the Message or Notes field of an Outlook item is included to the reply that appears when the user executes the custom action.

The reply contains no references to the original item or the text of the original item.

The reply includes the original item as an attachment.

The reply includes the text of the original item. This text appears in the body of the reply.

The reply includes the text of the original item. The text is indented in the body of the reply.

The reply includes the text of the original item. The text appears in the body of the reply. Each line of text is preceded by the prefix that you specify for the property of the .

The reply includes the text of the original item. The text appears in the body of the reply. The text in the Subject field uses the default prefix. For example, if you set the property of the to , the text in the Subject field is preceded by "RE:".

Represents a collection of objects.

Returns a value that indicates whether the contains the that has the specified name.

true if the string matches the property of a in the collection; otherwise, false. A string that identifies a in the .

Gets or sets the object associated with this .

A that represents the properties of the form region to which this custom action is associated.

Specifies how to respond when the user executes the custom action.

Opens a new form. 

Prompts the user to open or send the new form. 

Sends the form immediately. 

Provides data for the event of an .

Gets or sets the form region factory class that defines the form region.

An instance of a class that implements the interface.

Gets the name of the form region that Outlook is attempting to resolve.

The name of a form region.

Represents the method that will handle the event of an .

The source of the event. The data for the event.

Provides data for the FormRegionInitializing event of the form region factory class.

Gets or sets a value that indicates whether the form region should appear for the current Outlook item.

A that indicates whether the form region should appear for the current Outlook item.

Gets the mode of the Microsoft Office Outlook item that caused the form region to load.

A that represents the mode of the Outlook item that caused the form region to load.

Gets the type of form region that loads.

A that represents the type of form region that loads.

Gets the Microsoft Office Outlook item that caused the form region to load.

An that represents the Outlook item that caused the form region to load.

Represents the method that will handle the FormRegionInitializing event of the form region.

The source of the event. The data for the event.

Contains constants that specify whether the form region that a form region factory creates is based on a user control or an Outlook Form Storage (.ofs) file.

Specifies that the form region is based on a user control.

Specifies that the form region is imported from Outlook.

Represents a form region manifest that describes how the form region appears in Outlook.

Gets or sets the name that appears in the Choose Form dialog box in Outlook for replacement and replace-all form regions.

A string that represents the name that appears in the Choose Form dialog box in Outlook for replacement and replace-all form regions. is true. The value is greater than 256 characters in length.

Gets a collection that contains all of the custom actions that appear in the Custom Actions group on the Ribbon of the Outlook item that displays the form region.

A that contains all of the custom actions that appear in the Custom Actions group on the Ribbon of the Outlook item that displays the form region.

Gets or sets the text that appears in the Choose Form dialog box in Outlook for replacement and replace-all form regions.

A string that represents the text that appears in the Choose Form dialog box in Outlook for replacement and replace-all form regions. is true. The value is greater than 256 characters in length.

Gets or sets the name of the form region to display before this form region.

A string that represents the name of the form region to display before this form region. is true. The value is greater than 256 characters in length.

Gets or sets a value that indicates whether the form region is displayed by derived message classes.

true if the form region is not displayed by derived message classes; otherwise, false. The default is false. is true.

Gets or sets the text that appears on the Ribbon of an Outlook item or in the header text of an adjoining form region.

A string that contains the text that appears on the Ribbon of an Outlook item or in the header text of an adjoining form region. is true. The value is greater than 256 characters in length.

Gets or sets a that determines how the form region appears in an Outlook form.

A that determines how the form region appears in an Outlook form. is true. The value is greater than 256 characters in length.

Gets or sets a value that indicates whether replacement and replace-all form regions appear in the Choose Form dialog box in Outlook.

true if replacement and replace-all form regions do not appear in the Choose Form dialog box in Outlook; otherwise, false. The default is false. is true.

Gets or sets a that specifies the icons that appear for separate, replacement, or replace-all form regions.

A that specifies the icons that appear for separate, replacement, or replace-all form regions. is true.

Gets or sets a value that indicates whether Outlook loads legacy forms before loading this form region.

true if Outlook loads legacy forms before loading this form region; otherwise, false. The default is false. is true.

Gets or sets a value that indicates whether the properties of the can be modified.

true if the properties of the cannot be modified; otherwise, false.

Gets or sets the keyboard shortcut of separate, replacement, and replace-all form regions.

A string that represents the keyboard shortcut of separate, replacement, and replace-all form regions. is true. The value is greater than 2 characters in length or contains characters that are not alpha numeric.

Gets or sets a value that indicates whether to display the form region when an Outlook Inspector is in compose mode.

true to display the form region when an Outlook Inspector is in compose mode; otherwise, false. The default is true. is true.

Gets or sets a value that indicates whether to display the form region when an Outlook Inspector is in read mode.

true to display the form region when an Outlook Inspector is in read mode; otherwise, false. The default is true. is true.

Gets or sets a value that indicates whether to display the form region in the Reading Pane.

true to display the form region in the Reading Pane; otherwise, false. The default is false. is true.

Gets or sets the name that appears in the Actions menu and Choose Form dialog box in Outlook for replacement and replace-all form regions.

A string that represents the text that appears in the Actions menu and Choose Form dialog box in Outlook for replacement and replace-all form regions. is true. The value is greater than 256 characters in length.

Creates a string that represents the as XML.

A string that represents the as XML.

Creates a string that represents the as XML and saves it to an instance.

An to which to write the string.

Gets or sets the version number of the form region.

A string that represents the version number of the form region. is true. The value is greater than 256 characters in length.

Represents a collection of icons that appear for separate, replace, and replace-all form regions.

Gets or sets the default icon that appears for replacement and replace-all form regions.

An that appears by default in Explorers that display replacement and replace-all form regions. The property of the object associated with this object is true.

Gets or sets the icon that appears for encrypted items that have replacement or replace-all form regions.

An that appears for encrypted items that have replacement or replace-all form regions. The property of the object associated with this object is true.

Gets or sets the icon that appears for forwarded items that have replacement or replace-all form regions.

An that appears for forwarded items that have replacement or replace-all form regions. The property of the object associated with this object is true.

Returns an image that will be displayed for a particular type of icon for the form region.

An that represents the icon. An Microsoft.Office.Interop.Outlook.OlFormRegionIcon that represents the type of icon that you want to return.

The instance that is associated with this .

Gets or sets the icon that appears on the Ribbon of an Inspector for items that have separate, replacement, or replace-all form regions.

An that appears on the Ribbon of an Inspector for items that have separate, replacement, or replace-all form regions. The property of the object associated with this object is true.

Gets or sets the icon that appears for items marked as read that have replacement or replace-all form regions.

An that appears for items marked as read that have replacement or replace-all form regions. The property of the object associated with this object is true.

Gets or sets the icon that appears for recurring items that have replacement or replace-all form regions.

An that appears for recurring items that have replacement or replace-all form regions. The property of the object associated with this object is true.

Gets or sets the icon that appears for replied-to items that have replacement or replace-all form regions.

An that appears for replied-to items that have replacement or replace-all form regions. The property of the object associated with this object is true.

Gets or sets the icon that appears for digitally signed items that have replacement or replace-all form regions.

An that appears for digitally signed items that have replacement or replace-all form regions. The property of the object associated with this object is true.

Gets or sets the icon that appears for submitted items that have replacement or replace-all form regions.

An that appears for submitted items that have replacement or replace-all form regions. The property of the object associated with this object is true.

Creates a string that represents the as XML.

A string that represents the as XML.

Creates an XML representation of as a string and saves it to an instance.

An to which to write the string.

Gets or sets the icon that appears for items marked as unread that have replacement or replace-all form regions.

An that appears for items marked as unread that have replacement or replace-all form regions. The property of the object associated with this object is true.

Gets or sets the icon that appears for unsent items that have replacement or replace-all form regions.

An that appears for unsent items that have replacement or replace-all form regions. The property of the object associated with this object is true.

Gets or sets the icon that appears in the notification area and in the ALT+TAB dialog box for open items that display replacement and replace-all form regions.

An that appears in the notification area and in the ALT+TAB dialog box for open items that display replacement and replace-all form regions. The property of the object associated with this object is true.

Specifies the way the form region appears in Microsoft Office Outlook.

Appends the form region to the bottom of an Outlook form's default page.

Adds the form region as a new page that replaces the default page of an Outlook form.

Replaces the whole Outlook form with the form region.

Adds the form region as a new page in an Outlook form.

Defines an interface that exposes methods that are used by the events of the form region.

Occurs before the form region is closed.

Occurs after an instance of the form region is created but before the form region appears.

Defines an interface that creates instances of classes that implement .

Returns an instance of a class that implements the interface.

An instance of a class that implements the interface. A that represents the native form region.

Returns an Outlook Form Storage (.ofs) file.

A array that contains the contents of the .ofs file. The Outlook item that caused the form region to load. The mode of the Outlook item that caused the form region to load. This mode is represented by the enumeration. The type of form region being loaded. This mode is represented by the enumeration.

Returns a value that indicates whether the form region should appear for the specified Microsoft Office Outlook item.

A that indicates whether the form region should appear for the specified Outlook item. The Outlook item that caused the form region to load. The mode of the Outlook item that caused the form region to load. This mode is represented by the enumeration. The type of form region being loaded. This mode is represented by the enumeration.

Gets the type of form region that the factory creates.

A string that represents the type of form region that the factory creates.

Gets a collection of properties that describe how the form region appears in Microsoft Office Outlook.

A that represents a collection of properties that describe how the form region appears in Outlook.

Represents an extension of a object.

Initializes the controls on the form region.

Represents a Microsoft Office Outlofok form region that is based on an Outlook Form Storage (*.ofs) file.

Gets the default extension for this object.

The default extension for this object.

Gets a custom extension for this object.

A custom extension for this object.

Gets or sets the form region factory that is associated with this .

An object that implements the interface.

Occurs before the form region is closed.

Occurs after an instance of the form region is created but before the form region appears.

Returns the specified control from the Microsoft.Vbe.Interop.Forms.UserForm of the form region.

The control that is specified by . The name of the control that you would like to locate in the Microsoft.Vbe.Interop.Forms.UserForm of the form region. The form region specified by the property is null. Identifier does not match a control in the .ofs file.

Gets or sets the native form region object.

A that represents the form region.

Gets the Microsoft Office Outlook item for which the form region appears.

An that represents the Outlook item for which the form region appears.

Defines the core functionality of Outlook add-ins that you create by using the Office development tools in Visual Studio.

Occurs when the add-in loads, and when a form region name that is specified in the registry does not match the name of any form regions defined in the add-in.