Edit

Share via


SharingItem Interface

Definition

Represents a sharing message in an Inbox folder.

public interface class SharingItem : Microsoft::Office::Interop::Outlook::_SharingItem, Microsoft::Office::Interop::Outlook::ItemEvents_10_Event
[System.Runtime.InteropServices.Guid("0006302F-0000-0000-C000-000000000046")]
public interface SharingItem : Microsoft.Office.Interop.Outlook._SharingItem, Microsoft.Office.Interop.Outlook.ItemEvents_10_Event
Public Interface SharingItem
Implements _SharingItem, ItemEvents_10_Event
Derived
Attributes
Implements

Remarks

This is a .NET interface derived from a COM coclass that is required by managed code for interoperability with the corresponding COM object. Use this derived interface to access all method, property, and event members of the COM object. However, if a method or event you want to use shares the same name under the same COM object, cast to the corresponding primary interface to call the method, and cast to the latest events interface to connect to the event. Refer to this topic for information about the COM object. For information about the method and property members of the COM object, see _SharingItem. For information about the event members of the COM object, see ItemEvents_10_Event.

Use the CreateSharingItem(Object, Object) method of the NameSpace object to create a SharingItem object that represents a new sharing request or sharing invitation.

Use Item[Object] (index), where index is the index number of a sharing message or a value used to match the default property of a message, to return a single SharingItem object from an Inbox folder.

Properties

Actions

Returns an Actions collection that represents all the available actions for the SharingItem. Read-only.

(Inherited from _SharingItem)
AllowWriteAccess

Returns or sets a Boolean (bool in C#) value that indicates whether a sharing invitation should include write access to the folder. Read/write.

(Inherited from _SharingItem)
AlternateRecipientAllowed

Returns or sets a Boolean (bool in C#) value that is True if the item can be forwarded. Read/write.

(Inherited from _SharingItem)
Application

Returns an Application object that represents the parent Outlook application for the SharingItem. Read-only.

(Inherited from _SharingItem)
Attachments

Returns an Attachments object that represents all the attachments for the specified SharingItem. Read-only.

(Inherited from _SharingItem)
AutoForwarded

Returns or sets a Boolean (bool in C#) value that is True if the item was automatically forwarded. Read/write.

(Inherited from _SharingItem)
BCC

Returns a String (string in C#) representing the display list of blind carbon copy (BCC) names for a SharingItem. Read/write.

(Inherited from _SharingItem)
BillingInformation

Returns or sets a String (string in C#) representing the billing information associated with the SharingItem. Read/write.

(Inherited from _SharingItem)
Body

Returns or sets a String (string in C#) representing the clear-text body of the SharingItem. Read/write.

(Inherited from _SharingItem)
BodyFormat

Returns or sets an OlBodyFormat constant indicating the format of the body text. Read/write.

(Inherited from _SharingItem)
Categories

Returns or sets a String (string in C#) representing the categories assigned to the SharingItem. Read/write.

(Inherited from _SharingItem)
CC

Returns a String (string in C#) representing the display list of carbon copy (CC) names for a SharingItem. Read/write.

(Inherited from _SharingItem)
Class

Returns an OlObjectClass constant indicating the object's class. Read-only.

(Inherited from _SharingItem)
Companies

Returns or sets a String (string in C#) representing the names of the companies associated with the SharingItem. Read/write.

(Inherited from _SharingItem)
Conflicts

Return the Conflicts object that represents the items that are in conflict with the SharingItem. Read-only.

(Inherited from _SharingItem)
ConversationID

Returns a String (string in C#) that uniquely identifies a Conversation object that the SharingItem object belongs to. Read-only.

(Inherited from _SharingItem)
ConversationIndex

Returns a String (string in C#) representing the index of the conversation thread of the SharingItem. Read-only.

(Inherited from _SharingItem)
ConversationTopic

Returns a String (string in C#) representing the topic of the conversation thread of the SharingItem. Read-only.

(Inherited from _SharingItem)
CreationTime

Returns a DateTime indicating the creation time for the SharingItem. Read-only.

(Inherited from _SharingItem)
DeferredDeliveryTime

Returns or sets a DateTime indicating the date and time the SharingItem is to be delivered. Read/write.

(Inherited from _SharingItem)
DeleteAfterSubmit

Returns or sets a Boolean (bool in C#) value that is True if a copy of the item is not saved upon being sent, and False if a copy is saved. Read/write.

(Inherited from _SharingItem)
DownloadState

Returns a constant that belongs to the OlDownloadState enumeration indicating the download state of the SharingItem. Read-only.

(Inherited from _SharingItem)
EnableSharedAttachments

This object, member, or enumeration is deprecated and is not intended to be used in your code.

(Inherited from _SharingItem)
EntryID

Returns a String (string in C#) representing the unique Entry ID of the SharingItem. Read-only.

(Inherited from _SharingItem)
ExpiryTime

Returns or sets a DateTime indicating the date and time at which the SharingItem becomes invalid and can be deleted. Read/write.

(Inherited from _SharingItem)
FlagDueBy

This object, member, or enumeration is deprecated and is not intended to be used in your code.

(Inherited from _SharingItem)
FlagIcon

This object, member, or enumeration is deprecated and is not intended to be used in your code.

(Inherited from _SharingItem)
FlagRequest

Returns or sets a String (string in C#) indicating the requested action for the SharingItem. Read/write.

(Inherited from _SharingItem)
FlagStatus

This object, member, or enumeration is deprecated and is not intended to be used in your code.

(Inherited from _SharingItem)
FormDescription

Returns the FormDescription object that represents the form description for the specified SharingItem. Read-only.

(Inherited from _SharingItem)
GetInspector

Returns an Inspector object that represents an inspector initialized to contain the specified SharingItem. Read-only.

(Inherited from _SharingItem)
HTMLBody

Returns or sets a String (string in C#) representing the HTML body of the specified SharingItem. Read/write.

(Inherited from _SharingItem)
Importance

Returns or sets an OlImportance constant indicating the relative importance level for the SharingItem. Read/write.

(Inherited from _SharingItem)
InternetCodepage

Returns or sets an Integer (int in C#) value that determines the Internet code page used by the SharingItem. Read/write.

(Inherited from _SharingItem)
IsConflict

Returns a Boolean (bool in C#) that determines if the SharingItem is in conflict. Read-only.

(Inherited from _SharingItem)
IsMarkedAsTask

Returns a Boolean (bool in C#) value that indicates whether the SharingItem is marked as a task. Read-only.

(Inherited from _SharingItem)
ItemProperties

Returns an ItemProperties collection that represents all standard and user-defined properties associated with the SharingItem. Read-only.

(Inherited from _SharingItem)
LastModificationTime

Returns a DateTime specifying the date and time that the SharingItem was last modified. Read-only.

(Inherited from _SharingItem)
MAPIOBJECT

This object, member, or enumeration is deprecated and is not intended to be used in your code.

(Inherited from _SharingItem)
MarkForDownload

Returns or sets an OlRemoteStatus constant that determines the status of an item once it is received by a remote user. Read/write.

(Inherited from _SharingItem)
MessageClass

Returns or sets a String (string in C#) representing the message class for the SharingItem. Read/write.

(Inherited from _SharingItem)
Mileage

Returns or sets a String (string in C#) representing the mileage for a SharingItem. Read/write.

(Inherited from _SharingItem)
NoAging

Returns or sets a Boolean (bool in C#) value that is True to not age the SharingItem. Read/write.

(Inherited from _SharingItem)
OriginatorDeliveryReportRequested

Returns or sets a Boolean (bool in C#) value that determines whether the originator of the SharingItem will receive a delivery report. Read/write.

(Inherited from _SharingItem)
OutlookInternalVersion

Returns an Integer (int in C#) value representing the build number of the Outlook application for a SharingItem. Read-only.

(Inherited from _SharingItem)
OutlookVersion

Returns a String (string in C#) indicating the major and minor version number of the Outlook application for a SharingItem. Read-only.

(Inherited from _SharingItem)
Parent

Returns the parent Object of the specified SharingItem. Read-only.

(Inherited from _SharingItem)
Permission

Returns or sets an OlPermission constant that determines the permissions the recipients will have on the SharingItem. Read/write.

(Inherited from _SharingItem)
PermissionService

Returns or sets an OlPermissionService constant that determines the permission service that will be used when sending a SharingItem protected by Information Rights Management (IRM). Read/write.

(Inherited from _SharingItem)
PermissionTemplateGuid

Returns or sets a String (string in C#) value that represents the GUID of the template file to apply to the SharingItem in order to specify Information Rights Management (IRM) permissions. Read/write.

(Inherited from _SharingItem)
PropertyAccessor

Returns a PropertyAccessor object that supports creating, getting, setting, and deleting properties of the parent SharingItem object. Read-only.

(Inherited from _SharingItem)
ReadReceiptRequested

Returns a Boolean (bool in C#) value that indicates True if a read receipt has been requested by the sender.

(Inherited from _SharingItem)
ReceivedByEntryID

Returns a String (string in C#) representing the EntryID for the true recipient as set by the transport provider delivering the SharingItem. Read-only.

(Inherited from _SharingItem)
ReceivedByName

Returns a String (string in C#) representing the display name of the true recipient for the SharingItem. Read-only.

(Inherited from _SharingItem)
ReceivedOnBehalfOfEntryID

Returns a String (string in C#) representing the EntryID of the user delegated to represent the recipient for the SharingItem. Read-only.

(Inherited from _SharingItem)
ReceivedOnBehalfOfName

Returns a String (string in C#) representing the display name of the user delegated to represent the recipient for the SharingItem. Read-only.

(Inherited from _SharingItem)
ReceivedTime

Returns a DateTime indicating the date and time at which the SharingItem was received. Read-only.

(Inherited from _SharingItem)
RecipientReassignmentProhibited

Returns a Boolean (bool in C#) that indicates True if the recipient cannot forward the specified SharingItem. Read/write.

(Inherited from _SharingItem)
Recipients

Returns a Recipients collection that represents all the recipients for the SharingItem. Read-only.

(Inherited from _SharingItem)
ReminderOverrideDefault

Returns or sets a Boolean (bool in C#) value that is True if the reminder overrides the default reminder behavior for the specified SharingItem. Read/write.

(Inherited from _SharingItem)
ReminderPlaySound

Returns or sets a Boolean (bool in C#) value that is True if the reminder should play a sound when it occurs for the specified SharingItem. Read/write.

(Inherited from _SharingItem)
ReminderSet

Returns or sets a Boolean (bool in C#) value that is True if a reminder has been set for the specified SharingItem. Read/write.

(Inherited from _SharingItem)
ReminderSoundFile

Returns or sets a String (string in C#) indicating the path and file name of the sound file to play when the reminder occurs for the Outlook item. Read/write.

(Inherited from _SharingItem)
ReminderTime

Returns or sets a DateTime indicating the date and time at which the reminder should occur for the specified SharingItem. Read/write.

(Inherited from _SharingItem)
RemoteID

Returns a String (string in C#) that represents the unique identifier of the sharing context for a SharingItem object. Read-only.

(Inherited from _SharingItem)
RemoteName

Returns a String (string in C#) that represents the name of the sharing context for a SharingItem object. Read-only.

(Inherited from _SharingItem)
RemotePath

Returns a String (string in C#) that represents the path of the sharing context for a SharingItem object. Read-only.

(Inherited from _SharingItem)
RemoteStatus

Returns or sets an OlRemoteStatus constant specifying the remote status of the SharingItem. Read/write.

(Inherited from _SharingItem)
ReplyRecipientNames

Returns a semicolon-delimited String (string in C#) list of reply recipients for the SharingItem. Read-only.

(Inherited from _SharingItem)
ReplyRecipients

Returns a Recipients collection that represents all the reply recipient objects for the SharingItem. Read-only.

(Inherited from _SharingItem)
RequestedFolder

Returns an OlDefaultFolders constant that represents the type of default folder to which access is requested by a sharing request. Read-only.

(Inherited from _SharingItem)
RetentionExpirationDate

Returns a DateTime value that specifies the date when the SharingItem object expires, after which the Messaging Records Management (MRM) Assistant will delete the item. Read-only.

(Inherited from _SharingItem)
RetentionPolicyName

Returns a String (string in C#) that specifies the name of the retention policy. Read-only.

(Inherited from _SharingItem)
RTFBody

Returns or sets a byte array that represents the body of the Microsoft Outlook item in Rich Text Format. Read/write.

(Inherited from _SharingItem)
Saved

Returns a Boolean (bool in C#) value that is True if the SharingItem has not been modified since the last save. Read-only.

(Inherited from _SharingItem)
SaveSentMessageFolder

Returns or sets a Folder object that represents the folder in which a copy of the SharingItem will be saved after being sent. Read/write.

(Inherited from _SharingItem)
SenderEmailAddress

Returns a String (string in C#) that represents the e-mail address of the sender of the SharingItem. Read-only.

(Inherited from _SharingItem)
SenderEmailType

Returns a String (string in C#) that represents the type of entry for the e-mail address of the sender of the SharingItem, such as 'SMTP' for Internet address, 'EX' for a Microsoft Exchange server address, and so on. Read-only.

(Inherited from _SharingItem)
SenderName

Returns a String (string in C#) indicating the display name of the sender for the SharingItem. Read-only.

(Inherited from _SharingItem)
SendUsingAccount

Returns or sets an Account object that represents the account under which the SharingItem is to be sent. Read/write.

(Inherited from _SharingItem)
Sensitivity

Returns or sets an OlSensitivity constant indicating the sensitivity for the SharingItem. Read/write.

(Inherited from _SharingItem)
Sent

Returns a Boolean (bool in C#) value that indicates if the SharingItem has been sent. Read-only.

(Inherited from _SharingItem)
SentOn

Returns a DateTime indicating the date and time on which the SharingItem was sent. Read-only.

(Inherited from _SharingItem)
SentOnBehalfOfName

Returns or sets a String (string in C#) indicating the display name for the intended sender of the SharingItem. Read/write.

(Inherited from _SharingItem)
Session

Returns the NameSpace object for the current session. Read-only.

(Inherited from _SharingItem)
SharingProvider

Returns an OlSharingProvider constant that indicates the sharing provider used by the SharingItem. Read-only.

(Inherited from _SharingItem)
SharingProviderGuid

Returns a String (string in C#) that represents the GUID of the sharing provider used by the SharingItem object. Read-only.

(Inherited from _SharingItem)
Size

Returns an Integer (int in C#) value indicating the size (in bytes) of the SharingItem. Read-only.

(Inherited from _SharingItem)
Subject

Returns or sets a String (string in C#) indicating the subject for the SharingItem. Read/write.

(Inherited from _SharingItem)
Submitted

Returns a Boolean (bool in C#) value that is True if the SharingItem has been submitted. Read-only.

(Inherited from _SharingItem)
TaskCompletedDate

Returns or sets a DateTime value that represents the completion date of the task for this SharingItem. Read/write.

(Inherited from _SharingItem)
TaskDueDate

Returns or sets a DateTime value that represents the due date of the task for this SharingItem. Read/write.

(Inherited from _SharingItem)
TaskStartDate

Returns or sets a DateTime value that represents the start date of the task for this SharingItem object. Read/write.

(Inherited from _SharingItem)
TaskSubject

Returns or sets a String (string in C#) value that represents the subject of the task for the SharingItem object. Read/write.

(Inherited from _SharingItem)
To

Returns or sets a semicolon-delimited String (string in C#) list of display names for the To recipients for the SharingItem. Read/write.

(Inherited from _SharingItem)
ToDoTaskOrdinal

Returns or sets a DateTime value that represents the ordinal value of the task for the SharingItem. Read/write.

(Inherited from _SharingItem)
Type

Returns or sets an OlSharingMsgType constant that indicates the type of sharing message represented by the SharingItem. Read/write.

(Inherited from _SharingItem)
UnRead

Returns or sets a Boolean (bool in C#) value that is True if the SharingItem has not been opened (read). Read/write.

(Inherited from _SharingItem)
UserProperties

Returns the UserProperties collection that represents all the user properties for the SharingItem. Read-only.

(Inherited from _SharingItem)

Methods

AddBusinessCard(ContactItem)

Appends contact information based on the Electronic Business Card (EBC) associated with the specified ContactItem object to the SharingItem object.

(Inherited from _SharingItem)
Allow()

Allows a sharing request and sends a sharing response to the sender of the SharingItem.

(Inherited from _SharingItem)
ClearConversationIndex()

Clears the index of the conversation thread for the SharingItem.

(Inherited from _SharingItem)
ClearTaskFlag()

Clears the SharingItem object as a task.

(Inherited from _SharingItem)
Close(OlInspectorClose)

Closes and optionally saves changes to the SharingItem.

(Inherited from _SharingItem)
Copy()

Creates another instance of a SharingItem.

(Inherited from _SharingItem)
Delete()

Removes the SharingItem item from the folder that contains the item.

(Inherited from _SharingItem)
Deny()

Denies a sharing request and sends a sharing response to the sender of the SharingItem.

(Inherited from _SharingItem)
Display(Object)

Displays a new Inspector object for the SharingItem.

(Inherited from _SharingItem)
GetConversation()

Obtains a Conversation object that represents the conversation to which this item belongs.

(Inherited from _SharingItem)
MarkAsTask(OlMarkInterval)

Marks a SharingItem object as a task and assigns a task interval for the object.

(Inherited from _SharingItem)
Move(MAPIFolder)

Moves a SharingItem to a new folder.

(Inherited from _SharingItem)
OpenSharedFolder()

Opens a shared folder offered by a sharing invitation.

(Inherited from _SharingItem)
PrintOut()

Prints the SharingItem using all default settings.

(Inherited from _SharingItem)
Save()

Saves the SharingItem to the current folder or, if this is a new item, to the Outlook default folder for the item type.

(Inherited from _SharingItem)
SaveAs(String, Object)

Saves the SharingItem to the specified path and in the format of the specified file type. If the file type is not specified, the MSG format (.msg) is used.

(Inherited from _SharingItem)
ShowCategoriesDialog()

Displays the Show Categories dialog box, which allows you to select categories that correspond to the subject of the item.

(Inherited from _SharingItem)

Events

AfterWrite

Occurs after Microsoft Outlook has saved the item.

(Inherited from ItemEvents_10_Event)
AttachmentAdd

Occurs when an attachment has been added to an instance of the parent object.

(Inherited from ItemEvents_10_Event)
AttachmentRead

Occurs when an attachment in an instance of the parent object has been opened for reading.

(Inherited from ItemEvents_10_Event)
AttachmentRemove

Occurs when an attachment has been removed from an instance of the parent object.

(Inherited from ItemEvents_10_Event)
BeforeAttachmentAdd

Occurs before an attachment is added to an instance of the parent object.

(Inherited from ItemEvents_10_Event)
BeforeAttachmentPreview

Occurs before an attachment associated with an instance of the parent object is previewed.

(Inherited from ItemEvents_10_Event)
BeforeAttachmentRead

Occurs before an attachment associated with an instance of the parent object is read from the file system, an attachment stream, or an Attachment object.

(Inherited from ItemEvents_10_Event)
BeforeAttachmentSave

Occurs just before an attachment is saved.

(Inherited from ItemEvents_10_Event)
BeforeAttachmentWriteToTempFile

Occurs before an attachment associated with an instance of the parent object is written to a temporary file.

(Inherited from ItemEvents_10_Event)
BeforeAutoSave

Occurs before the item is automatically saved by Outlook.

(Inherited from ItemEvents_10_Event)
BeforeCheckNames

Occurs just before Microsoft Outlook starts resolving names in the recipient collection for an item (which is an instance of the parent object).

(Inherited from ItemEvents_10_Event)
BeforeDelete

Occurs before an item (which is an instance of the parent object) is deleted.

(Inherited from ItemEvents_10_Event)
BeforeRead

Occurs before Microsoft Outlook begins to read the properties for the item.

(Inherited from ItemEvents_10_Event)
Close

Occurs when the inspector associated with an item (which is an instance of the parent object) is being closed.

(Inherited from ItemEvents_10_Event)
CustomAction

Occurs when a custom action of an item (which is an instance of the parent object) executes.

(Inherited from ItemEvents_10_Event)
CustomPropertyChange

Occurs when a custom property of an item (which is an instance of the parent object) is changed.

(Inherited from ItemEvents_10_Event)
Forward

Occurs when the user selects the Forward action for an item (which is an instance of the parent object).

(Inherited from ItemEvents_10_Event)
Open

Occurs when an instance of the parent object is being opened in an Inspector.

(Inherited from ItemEvents_10_Event)
PropertyChange

Occurs when an explicit built-in property of an instance of the parent object is changed.

(Inherited from ItemEvents_10_Event)
Read

Occurs when an instance of the parent object is opened for editing by the user.

(Inherited from ItemEvents_10_Event)
ReadComplete

Occurs when Outlook has completed reading the properties of the item.

(Inherited from ItemEvents_10_Event)
Reply

Occurs when the user selects the Reply action for an item (which is an instance of the parent object).

(Inherited from ItemEvents_10_Event)
ReplyAll

Occurs when the user selects the ReplyAll action for an item (which is an instance of the parent object).

(Inherited from ItemEvents_10_Event)
Send

Occurs when the user selects the Send action for an item (which is an instance of the parent object).

(Inherited from ItemEvents_10_Event)
Unload

Occurs before an Outlook item is unloaded from memory, either programmatically or by user action.

(Inherited from ItemEvents_10_Event)
Write

Occurs when an instance of the parent object is saved, either explicitly or implicitly (for example, in response to a prompt when closing the item's inspector).

(Inherited from ItemEvents_10_Event)

Applies to