Aspose::Words::Markup::CustomPart Class Reference

Represents a custom (arbitrary content) part, that is not defined by the ISO/IEC 29500 standard. More...

#include "Aspose.Words.Cpp/Model/Markup/CustomPart.h"

Inherits System::Object.

Public Member Functions

System::String get_Name () const
 Gets or sets this part's absolute name within the OOXML package or the target URL. More...
 
void set_Name (System::String value)
 Setter for Aspose::Words::Markup::CustomPart::get_Name. More...
 
System::String get_RelationshipType () const
 Gets or sets the relationship type from the parent part to this custom part. More...
 
void set_RelationshipType (System::String value)
 Setter for Aspose::Words::Markup::CustomPart::get_RelationshipType. More...
 
bool get_IsExternal () const
 False if this custom part is stored inside the OOXML package. True if this custom part is an external target. More...
 
void set_IsExternal (bool value)
 Setter for Aspose::Words::Markup::CustomPart::get_IsExternal. More...
 
System::String get_ContentType () const
 Specifies the content type of this custom part. More...
 
void set_ContentType (System::String value)
 Setter for Aspose::Words::Markup::CustomPart::get_ContentType. More...
 
System::ArrayPtr< uint8_t > get_Data () const
 Contains the data of this custom part. More...
 
void set_Data (System::ArrayPtr< uint8_t > value)
 Setter for Aspose::Words::Markup::CustomPart::get_Data. More...
 
System::SharedPtr< Aspose::Words::Markup::CustomPartClone ()
 Makes a "deep enough" copy of the object. Does not duplicate the bytes of the Aspose::Words::Markup::CustomPart::get_Data value. More...
 
 CustomPart ()
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared refernce counter. More...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () ASPOSE_CONST
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual void SetTemplateWeakPtr (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Impleemnts C# typeof(System.Object) construct. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Detailed Description

Represents a custom (arbitrary content) part, that is not defined by the ISO/IEC 29500 standard.

This class represents an OOXML part that is a target of an "unknown relationship". All relationships not defined within ISO/IEC 29500 are considered "unknown relationships". Unknown relationships are permitted within an Office Open XML document provided that they conform to relationship markup guidelines.

Microsoft Word preserves custom parts during open/save cycles. Some additional info can be found here http://blogs.msdn.com/dmahugh/archive/2006/11/25/arbitrary-content-in-an-opc-package.aspx

Aspose.Words also roundtrips custom parts and in addition, allows to programmatically access such parts via the Aspose::Words::Markup::CustomPart and Aspose::Words::Markup::CustomPartCollection objects.

Do not confuse custom parts with Custom XML Data. Use Aspose::Words::Markup::CustomXmlPart if you need to access Custom XML Data.

See also
Aspose::Words::Markup::CustomPartCollection, Aspose::Words::Document::get_PackageCustomParts

Constructor & Destructor Documentation

◆ CustomPart()

Aspose::Words::Markup::CustomPart::CustomPart ( )

Member Function Documentation

◆ Clone()

System::SharedPtr<Aspose::Words::Markup::CustomPart> Aspose::Words::Markup::CustomPart::Clone ( )

Makes a "deep enough" copy of the object. Does not duplicate the bytes of the Aspose::Words::Markup::CustomPart::get_Data value.

◆ get_ContentType()

System::String Aspose::Words::Markup::CustomPart::get_ContentType ( ) const

Specifies the content type of this custom part.

This property is applicable only when Aspose::Words::Markup::CustomPart::get_IsExternal is false.

The default value is an empty string. A valid value must be a non-empty string.

◆ get_Data()

System::ArrayPtr<uint8_t> Aspose::Words::Markup::CustomPart::get_Data ( ) const

Contains the data of this custom part.

This property is applicable only when Aspose::Words::Markup::CustomPart::get_IsExternal is false.

The default value is an empty byte array. The value cannot be null.

◆ get_IsExternal()

bool Aspose::Words::Markup::CustomPart::get_IsExternal ( ) const

False if this custom part is stored inside the OOXML package. True if this custom part is an external target.

The default value is false.

See also
Aspose::Words::Markup::CustomPart::get_Name

◆ get_Name()

System::String Aspose::Words::Markup::CustomPart::get_Name ( ) const

Gets or sets this part's absolute name within the OOXML package or the target URL.

If the relationship target is internal, then this property is the absolute part name within the package. If the relationship target is external, then this property is the target URL.

The default value is an empty string. A valid value must be a non-empty string.

See also
Aspose::Words::Markup::CustomPart::get_IsExternal

◆ get_RelationshipType()

System::String Aspose::Words::Markup::CustomPart::get_RelationshipType ( ) const

Gets or sets the relationship type from the parent part to this custom part.

The relationship type for a custom part must be "unknown" e.g. a custom relationship type, not one of the relationship types defined within ISO/IEC 29500.

The default value is an empty string. A valid value must be a non-empty string.

◆ set_ContentType()

void Aspose::Words::Markup::CustomPart::set_ContentType ( System::String  value)

◆ set_Data()

void Aspose::Words::Markup::CustomPart::set_Data ( System::ArrayPtr< uint8_t >  value)

◆ set_IsExternal()

void Aspose::Words::Markup::CustomPart::set_IsExternal ( bool  value)

◆ set_Name()

void Aspose::Words::Markup::CustomPart::set_Name ( System::String  value)

◆ set_RelationshipType()

void Aspose::Words::Markup::CustomPart::set_RelationshipType ( System::String  value)