Aspose::Email::Mapi::MapiObjectProperty Class Reference

Represents a Custom object included in Outlook Message documents. More...

Inherits Aspose::Email::Mapi::MapiProperty.

Public Member Functions

bool get_IsOutlookMessage ()
 Indicates whether the object property is an embedded outlook message. More...
 
System::SharedPtr< MapiPropertyContainerget_Container () const
 
System::SharedPtr< Aspose::Email::Mapi::OleDocumentFormatget_OleDocumentFormat ()
 Gets the Ole format type. More...
 
System::String get_DocumentName () const
 Gets the document name. More...
 
System::SharedPtr< MapiPropertyCollectionget_Properties ()
 Gets a collection of MAPI properties. More...
 
 MapiObjectProperty (System::SharedPtr< MapiMessage > msg)
 
 MapiObjectProperty (int64_t tag)
 
System::SharedPtr< MapiMessageToMapiMessage ()
 Creates the MapiMessage from object data. More...
 
void SetOleDocumentFormat (System::SharedPtr< Aspose::Email::Mapi::OleDocumentFormat > format)
 
void SetDocumentName (System::String fileName)
 
System::SharedPtr< MapiPropertyCollectionGetSubStorages ()
 Gets the sub storages from object properties. More...
 
System::SharedPtr< System::IO::MemoryStream > GetPropertyStreamContent (System::SharedPtr< MapiMessage > msg)
 Gets the content of the property stream. More...
 
System::SharedPtr< Nodes::IMapiNode > CreateMapiNode (System::String tag)
 
System::SharedPtr< MapiPropertyClone () override
 
- Public Member Functions inherited from Aspose::Email::Mapi::MapiProperty
virtual System::String get_PropertyTagName ()
 Gets the PropertyName. More...
 
virtual System::String get_Name ()
 Gets the name. More...
 
virtual int64_t get_Identifier ()
 Gets the indifier. More...
 
virtual int64_t get_Tag ()
 Gets the tag. More...
 
virtual int32_t get_DataType ()
 Gets the data type. More...
 
virtual System::ArrayPtr< uint8_t > get_Data ()
 Gets the binary data. More...
 
virtual void set_Data (System::ArrayPtr< uint8_t > value)
 Gets the binary data. More...
 
System::SharedPtr< System::Collections::Generic::IList< System::SharedPtr< System::Object > > > get_MVEntries ()
 Gets the MV entries list. More...
 
virtual bool get_IsSigned ()
 Indicates whether the binary data is signed. More...
 
virtual void set_IsSigned (bool value)
 Indicates whether the binary data is signed. More...
 
bool get_IsNamed ()
 Indicates whether the property is a named property. More...
 
System::SharedPtr< PropertyDescriptorget_Descriptor ()
 Gets descriptor of MAPI property More...
 
 MapiProperty (int64_t tag, System::ArrayPtr< uint8_t > data)
 Initializes a new instance of the MapiProperty class. More...
 
 MapiProperty (int64_t tag)
 Initializes a new instance of the MapiProperty class. More...
 
 MapiProperty (System::SharedPtr< PidTagPropertyDescriptor > pd, System::SharedPtr< System::Object > data)
 Initializes a new instance of the MapiProperty class. More...
 
 MapiProperty (System::SharedPtr< PidLidPropertyDescriptor > pd, System::SharedPtr< System::Object > data)
 Initializes a new instance of the MapiProperty class. More...
 
 MapiProperty (System::SharedPtr< PidTagPropertyDescriptor > pd, System::SharedPtr< System::Collections::Generic::IList< System::SharedPtr< System::Object >>> values)
 
 MapiProperty (int64_t tag, System::SharedPtr< System::Collections::Generic::IList< System::SharedPtr< System::Object >>> values)
 Initializes a new instance of the MapiProperty class. This overload is used to create a multiple valued property, PT_MV_*. More...
 
 MapiProperty (int64_t tag, int64_t signedParam, System::ArrayPtr< uint8_t > data)
 Initializes a new instance of the MapiProperty class. More...
 
 MapiProperty (System::String name, int64_t tag, int64_t signedParam, System::ArrayPtr< uint8_t > data)
 Initializes a new instance of the MapiProperty class. More...
 
virtual int64_t GetLong ()
 Gets the first 8 bytes of the binary data as long. More...
 
virtual int32_t GetInt32 ()
 Gets the first 4 bytes of the binary data as int32. More...
 
virtual int16_t GetShort ()
 Gets the first 2 bytes of the binary data as short. More...
 
virtual bool GetBoolean ()
 Gets the first bytes of the binary data as boolean. More...
 
virtual System::DateTime GetDateTime ()
 Gets the first bytes of the binary data as datetime. More...
 
virtual System::String GetString ()
 Gets the binary data as string. More...
 
System::SharedPtr< System::Object > GetValue ()
 Gets value as object More...
 
virtual System::Decimal GetCurrency ()
 Gets the Currency as string using the specified code page. More...
 
virtual System::String GetString (int32_t codepage)
 Gets the binary data as string using the specified code page. More...
 
virtual System::DateTime GetFloatingDate ()
 Gets the bytes of the binary data as DateTime. More...
 
virtual System::Guid GetGuid ()
 Gets the bytes of the binary data as Guid. More...
 
virtual double GetDouble ()
 Gets the bytes of the binary data as double. More...
 
virtual float GetFloat ()
 Gets the bytes of the binary data as float. More...
 
int32_t GetSizeByType ()
 
void SetData (System::ArrayPtr< uint8_t > data)
 Sets the data. More...
 
void SetValue (System::SharedPtr< System::Object > value)
 Sets the value. More...
 
void SetValue (System::SharedPtr< System::Object > value, System::SharedPtr< System::Globalization::DateTimeFormatInfo > dateTimeFormatInfo)
 Sets the value. More...
 
void SetDataLong (int64_t byteCount)
 Sets the data long. More...
 
void SetTag (int64_t tag)
 Sets the tag. More...
 
void SetDataLong (int64_t byteCount, int64_t delimiter)
 Sets the data long. More...
 
void SetDataFileTime (System::DateTime t)
 Sets the data file time. More...
 
void SetDataWithoutCopy (System::ArrayPtr< uint8_t > data)
 Sets the data without copy. More...
 
void SetName (System::String name)
 Sets the name. More...
 
bool IsComplex ()
 
void AddMVEntries (System::SharedPtr< System::Collections::Generic::IList< System::SharedPtr< System::Object >>> entries)
 Add entries to MVEntries More...
 
System::String ToString () const override
 Returns a T:System::String that represents the current T:System::Object. More...
 

Friends

class Aspose::Email::Mapi::MapiAttachment
 
class Aspose::Email::Mapi::MapiMessage
 
class Aspose::Email::Mapi::Nodes::CustomObjectNode
 
class Aspose::Email::Storage::Pst::Ltp::LtpDoer
 
class Aspose::Email::Storage::Pst::PstDoer
 
class Aspose::Email::Storage::Pst::PstUtil
 
class Aspose::Email::Tnef::TnefAttachment
 
class Aspose::Email::Tnef::TnefMessageProperty
 

Additional Inherited Members

- Static Public Member Functions inherited from Aspose::Email::Mapi::MapiProperty
static System::SharedPtr< MapiPropertyCreateMapiPropertyFromLong (int64_t tag, int64_t data)
 Creates the mapi property from long. More...
 
static System::SharedPtr< MapiPropertyCreateMapiPropertyFromLong (int64_t tag, int64_t data, int64_t delimiter)
 Creates the mapi property from long. More...
 
static System::SharedPtr< MapiPropertyCreateMapiPropertyFromBytes (int64_t tag, System::ArrayPtr< uint8_t > data)
 Creates the mapi property from bytes. More...
 
static System::SharedPtr< MapiPropertyFromString (int64_t tag, System::String str, System::SharedPtr< System::Text::Encoding > enc)
 Creates the mapi property from string. More...
 
static System::SharedPtr< MapiPropertyCreateMapiPropertyFromDateTime (int64_t tag, System::DateTime data)
 Creates the mapi property from date time. More...
 
static bool IsComplex (int64_t dataType)
 
static System::ArrayPtr< uint8_t > GetBytes (System::DateTime dateTime)
 
- Static Public Attributes inherited from Aspose::Email::Mapi::MapiProperty
static constexpr int32_t PT_SHORT = 0x0002
 
static constexpr int32_t PT_LONG = 0x0003
 
static constexpr int32_t PT_ERROR = 0x000A
 
static constexpr int32_t PT_BOOLEAN = 0x000B
 
static constexpr int32_t PT_OBJECT = 0x000D
 
static constexpr int32_t PT_LONGLONG = 0x0014
 
static constexpr int32_t PT_STRING8 = 0x001E
 
static constexpr int32_t PT_UNICODE = 0x001F
 
static constexpr int32_t PT_SYSTIME = 0x0040
 
static constexpr int32_t PT_CLSID = 0x0048
 
static constexpr int32_t PT_SRESTRICTION = 0x00FD
 
static constexpr int32_t PT_ACTIONS = 0x00FE
 
static constexpr int32_t PT_BINARY = 0x0102
 
static constexpr int32_t PT_MV_xxx = 0x1000
 
static constexpr int32_t PT_APPTIME = 0x0007
 
static constexpr int32_t PT_CURRENCY = 0x0006
 
static constexpr int32_t PT_DOUBLE = 0x0005
 
static constexpr int32_t PT_FLOAT = 0x0004
 
static constexpr int32_t PT_MV_CLSID = 0x1048
 
static constexpr int32_t PT_MV_SYSTIME = 0x1040
 
static constexpr int32_t PT_MV_LONGLONG = 0x1014
 
static constexpr int32_t PT_MV_APPTIME = 0x1007
 
static constexpr int32_t PT_MV_CURRENCY = 0x1006
 
static constexpr int32_t PT_MV_DOUBLE = 0x1005
 
static constexpr int32_t PT_MV_FLOAT = 0x1004
 
static constexpr int32_t PT_MV_LONG = 0x1003
 
static constexpr int32_t PT_MV_SHORT = 0x1002
 
static constexpr int32_t PT_MV_STRING8 = 0x101E
 
static constexpr int32_t PT_MV_UNICODE = 0x101F
 
static constexpr int32_t PT_MV_BOOLEAN = 0x100B
 
static constexpr int32_t PT_MV_BINARY = 0x1102
 
static constexpr int32_t PT_SVREID = 0x00FB
 
static constexpr int32_t PT_UNSPECIFIED = 0x0000
 
static constexpr int32_t PT_NULL = 0x0001
 
static constexpr int32_t CurrencyMultiplier = 10000
 
static constexpr int64_t Signed = 0x00000006
 
static constexpr int64_t Unsigned = 0x00000002
 
- Protected Member Functions inherited from Aspose::Email::Mapi::MapiProperty
 MapiProperty ()
 Initializes a new instance of the MapiProperty class. More...
 
 MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (MapiProperty, CODEPORTING_ARGS())
 
virtual ~MapiProperty ()
 
- Protected Attributes inherited from Aspose::Email::Mapi::MapiProperty
int64_t signedFlag
 
int64_t tag
 
System::ArrayPtr< uint8_t > data
 

Detailed Description

Represents a Custom object included in Outlook Message documents.

Constructor & Destructor Documentation

◆ MapiObjectProperty() [1/2]

Aspose::Email::Mapi::MapiObjectProperty::MapiObjectProperty ( System::SharedPtr< MapiMessage msg)

◆ MapiObjectProperty() [2/2]

Aspose::Email::Mapi::MapiObjectProperty::MapiObjectProperty ( int64_t  tag)

Member Function Documentation

◆ Clone()

System::SharedPtr<MapiProperty> Aspose::Email::Mapi::MapiObjectProperty::Clone ( )
overridevirtual

Reimplemented from Aspose::Email::Mapi::MapiProperty.

◆ CreateMapiNode()

System::SharedPtr<Nodes::IMapiNode> Aspose::Email::Mapi::MapiObjectProperty::CreateMapiNode ( System::String  tag)

◆ get_Container()

System::SharedPtr<MapiPropertyContainer> Aspose::Email::Mapi::MapiObjectProperty::get_Container ( ) const

◆ get_DocumentName()

System::String Aspose::Email::Mapi::MapiObjectProperty::get_DocumentName ( ) const

Gets the document name.

◆ get_IsOutlookMessage()

bool Aspose::Email::Mapi::MapiObjectProperty::get_IsOutlookMessage ( )

Indicates whether the object property is an embedded outlook message.

◆ get_OleDocumentFormat()

System::SharedPtr<Aspose::Email::Mapi::OleDocumentFormat> Aspose::Email::Mapi::MapiObjectProperty::get_OleDocumentFormat ( )

Gets the Ole format type.

◆ get_Properties()

System::SharedPtr<MapiPropertyCollection> Aspose::Email::Mapi::MapiObjectProperty::get_Properties ( )

Gets a collection of MAPI properties.

◆ GetPropertyStreamContent()

System::SharedPtr<System::IO::MemoryStream> Aspose::Email::Mapi::MapiObjectProperty::GetPropertyStreamContent ( System::SharedPtr< MapiMessage msg)

Gets the content of the property stream.

Parameters
msgThe parent message.
Returns
The MemoryStream that represents content of property stream.

◆ GetSubStorages()

System::SharedPtr<MapiPropertyCollection> Aspose::Email::Mapi::MapiObjectProperty::GetSubStorages ( )

Gets the sub storages from object properties.

Returns
The MapiProperty collection.

◆ SetDocumentName()

void Aspose::Email::Mapi::MapiObjectProperty::SetDocumentName ( System::String  fileName)

◆ SetOleDocumentFormat()

void Aspose::Email::Mapi::MapiObjectProperty::SetOleDocumentFormat ( System::SharedPtr< Aspose::Email::Mapi::OleDocumentFormat format)

◆ ToMapiMessage()

System::SharedPtr<MapiMessage> Aspose::Email::Mapi::MapiObjectProperty::ToMapiMessage ( )

Creates the MapiMessage from object data.

Returns
The resultant MapiMessage.
Exceptions
InvalidOperationExceptionIf current ObjectData is not a Outlook message.

Friends And Related Function Documentation

◆ Aspose::Email::Mapi::MapiAttachment

◆ Aspose::Email::Mapi::MapiMessage

friend class Aspose::Email::Mapi::MapiMessage
friend

◆ Aspose::Email::Mapi::Nodes::CustomObjectNode

friend class Aspose::Email::Mapi::Nodes::CustomObjectNode
friend

◆ Aspose::Email::Storage::Pst::Ltp::LtpDoer

friend class Aspose::Email::Storage::Pst::Ltp::LtpDoer
friend

◆ Aspose::Email::Storage::Pst::PstDoer

friend class Aspose::Email::Storage::Pst::PstDoer
friend

◆ Aspose::Email::Storage::Pst::PstUtil

friend class Aspose::Email::Storage::Pst::PstUtil
friend

◆ Aspose::Email::Tnef::TnefAttachment

friend class Aspose::Email::Tnef::TnefAttachment
friend

◆ Aspose::Email::Tnef::TnefMessageProperty

friend class Aspose::Email::Tnef::TnefMessageProperty
friend