Class MapiNote

MapiNote class

Represents a MAPI note (“sticky note”) item.

public sealed class MapiNote : MapiMessageItemBase

Constructors

Name	Description
MapiNote()	Initializes a new instance of the `MapiNote` class.
MapiNote(string, string)	Initializes a new instance of the `MapiNote` class.

Properties

Name	Description
Attachments { get; }	Gets the attachments in the message.
Billing { get; set; }	Contains the billing information associated with an item.
Body { get; set; }	Gets the message text.
BodyHtml { get; }	Gets the `BodyRtf` of the message converted to HTML, if present, otherwise an empty string.
BodyRtf { get; set; }	Gets or sets the RTF formatted message text.
BodyType { get; }	Gets the type of the body.
Categories { get; set; }	Contains keywords or categories for the message object.
virtual CodePage { get; }	Gets the code page.
Color { get; set; }	Gets or sets the suggested background color of the Note object
Companies { get; set; }	Contains the names of the companies that are associated with an item.
CreationDate { get; set; }	Gets or sets the creation date of note
Height { get; set; }	Gets or sets height of the visible message window in pixels
virtual ItemId { get; }	The item id, uses with a server
MessageClass { get; set; }	Gets a case-sensitive string that identifies the sender-defined message class, such as IPM.Note. The message class specifies the type, purpose, or content of the message.
Mileage { get; set; }	Contains the mileage information that is associated with an item.
NamedProperties { get; }	Gets the named properties of message.
NamedPropertyMapping { get; }	Gets the named property mapping.
virtual Properties { get; }	Gets the collection of properties.
PropertyStream { get; }	Gets the property stream.
Recipients { get; set; }	Gets the recipients of the message.
Sensitivity { get; set; }	Gets the Sensitivity.
Subject { get; set; }	Gets or sets the subject of the message.
SubjectPrefix { get; }	Gets a subject prefix that typically indicates some action on a message, such as “FW: " for forwarding.
SubStorages { get; }	Gets the sub storages.
SupportedType { get; }	Gets the supported item type.
Width { get; set; }	Gets or sets width of the visible message window in pixels
XPosition { get; set; }	Gets or sets the distance, in pixels, from the left edge of the screen that a user interface displays a Note object
YPosition { get; set; }	Gets or sets the distance, in pixels, from the top edge of the screen that a user interface displays a Note object

Methods

Name	Description
virtual Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
override GetProperty(PropertyDescriptor)	Gets MAPI property by property descriptor.
GetPropertyBoolean(long)	Gets the value of the property specified by tag as Boolean type.
GetPropertyBytes(long)	Gets the string value of the property specified by tag.
GetPropertyDateTime(long)	Gets the value of the property specified by tag as DateTime type.
GetPropertyInt32(long)	Gets the int32 value of the property specified by tag.
GetPropertyLong(long)	Gets the value of the property specified by tag as Long (int64) type.
GetPropertyShort(long)	Gets the value of the property specified by tag as Short type.
GetPropertyString(long)	Gets the string value of the property specified by tag.
GetPropertyString(long, int)	Gets the string value of the property specified by tag.
GetUnderlyingMessage()	Retrieves the underlying MapiMessage object.
IsStoreUnicodeOk()	Determines if string properties are Unicode encoded or not.
RemoveProperty(long)	Provides correctly removing property from all collections.
Save(Stream, NoteSaveFormat)	Saves this `MapiNote` to the given stream using specified format.
Save(string, NoteSaveFormat)	Saves this `MapiNote` into file using specified format.
virtual SetBodyContent(string, BodyContentType)	Sets the content of the body.
virtual SetBodyContent(string, BodyContentType, bool)	Sets the content of the body.
SetBodyRtf(string, bool)	Gets or sets the RTF formatted message text.
SetMessageFlags(MapiMessageFlags)	Sets the message flags.
virtual SetProperty(MapiProperty)	Sets the property.
override SetProperty(PropertyDescriptor, object)	Sets MAPI property.
TryGetPropertyData(long)	Try to get the property data with specified tag key.
TryGetPropertyDateTime(long, ref DateTime)	Gets the value of the specified property as DateTime type. A return value indicates whether the operation succeeded.
TryGetPropertyInt32(long, ref int)	Gets the value of the specified property as Int32 type. A return value indicates whether the operation succeeded.
TryGetPropertyLong(long, ref long)	Gets the value of the specified property as Long type. A return value indicates whether the operation succeeded.
TryGetPropertyString(long)	Try to get a property data as string with specified tag.
TryGetPropertyString(long, int)	Try to get a property data as string with specified tag and code page.
TryGetPropertyString(long, ref string)	Gets the value of the specified property as String type. A return value indicates whether the operation succeeded.
TryGetPropertyString(long, ref string, int)	Gets the value of the specified property as String type. A return value indicates whether the operation succeeded.

Remarks

This class serves as a wrapper for MapiMessage to simplify the process of handling note information from MAPI properties. It provides a more intuitive interface for accessing and manipulating note data within the MAPI message.

Examples

The following example demonstrates how to get a MapiNote object from a MapiMessage.

[C#]

var msg = MapiMessage.Load("note.msg");

// Check if the loaded message is a supported note type
if (msg.SupportedType == MapiItemType.Note)
{
    // Convert the MAPI message to a MapiNote object
    var mapiNote = (MapiNote)msg.ToMapiMessageItem();
    
    // Display some note info
    Console.WriteLine(mapiNote.Color);
    Console.WriteLine(mapiNote.Body);
}

[Visual Basic]

Dim msg = MapiMessage.Load("note.msg")

' Check if the loaded message is a supported note type
If msg.SupportedType = MapiItemType.Note Then
    ' Convert the MAPI message to a MapiNote object
    Dim mapiNote = DirectCast(msg.ToMapiMessageItem(), MapiNote)
    
    ' Display some note info
    Console.WriteLine(mapiNote.Color)
    Console.WriteLine(mapiNote.Body)
End If