Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Office.RecipientsChangedEventArgs interface
- Package:
- outlook
Provides change status of recipients fields when the Office.EventType.RecipientsChanged event is raised.
Remarks
Examples
// Handles the OnMessageRecipientsChanged event.
function onMessageRecipientsChangedHandler(event) {
console.log(`Event: ${event.type}`);
const recipientFields = event.changedRecipientFields;
console.log(getChangedRecipientFields(recipientFields));
}
// Gets the recipient fields that have changed.
function getChangedRecipientFields(recipientFields) {
return Object.keys(recipientFields).filter((key) => recipientFields[key] === true);
}
Properties
| changedRecipientFields | Gets an object that indicates change state of recipients fields. |
| type | Gets the type of the event. For details, refer to Office.EventType. |
Property Details
changedRecipientFields
Gets an object that indicates change state of recipients fields.
changedRecipientFields: RecipientsChangedFields;Property Value
Remarks
type
Gets the type of the event. For details, refer to Office.EventType.
type: "olkRecipientsChanged";Property Value
"olkRecipientsChanged"
Remarks
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
Office Add-ins
Feedback
Was this page helpful?