Aspose::Slides::Portion Class Reference

Represents a portion of text inside a text paragraph. More...

#include <Portion.h>

Inherits Aspose::Slides::IPortion, and Aspose::Slides::IDOMObject.

Inherited by Aspose::Slides::MathText::MathPortion.

Public Member Functions

System::SharedPtr< IPortionFormatget_PortionFormat () override
 Returns oformatting bject which contains explicitly set formatting properties of the text portion with no inheritance applied. Read-only IPortionFormat. More...
 
System::String get_Text () override
 Gets the plain text of a portion. Read System::String. More...
 
void set_Text (System::String value) override
 Sets the plain text of a portion. Write System::String. More...
 
System::SharedPtr< IFieldget_Field () override
 Returns a field of this portion. Read-only IField. More...
 
 Portion ()
 Initializes a new instance of the Portion class. More...
 
 Portion (System::String str)
 Initializes a new instance of the Portion class. More...
 
 Portion (System::SharedPtr< Portion > portion)
 Initializes a new instance of the Portion class. More...
 
void AddField (System::SharedPtr< IFieldType > fieldType) override
 Converts this portion to the automaticaly updated field. More...
 
void AddField (System::String internalString) override
 Converts this portion to the automaticaly updated field. More...
 
void RemoveField () override
 Converts this field portion to the simple portion. More...
 
System::Drawing::RectangleF GetRect () override
 Get coordinates of rect that bounds portion. The rect includes all the lines of text in portion, including empty ones. More...
 
System::Drawing::PointF GetCoordinates () override
 Get coordinates of the beginning of the portion. The X coordinate of point represents the portion beginning from the first character including left side bearing. The Y coordinate includes top side bearing. More...
 
virtual System::SharedPtr< IPortionFormatget_PortionFormat ()=0
 Returns formatting object which contains explicitly set formatting properties of the text portion with no inheritance applied. Read-only IPortionFormat. More...
 
virtual System::String get_Text ()=0
 Gets the plain text of a portion. Read System::String. More...
 
virtual void set_Text (System::String value)=0
 Sets the plain text of a portion. Write System::String. More...
 
virtual System::SharedPtr< IFieldget_Field ()=0
 Returns a field of this portion. Read-only IField. More...
 
virtual void AddField (System::SharedPtr< IFieldType > fieldType)=0
 Converts this portion to the automaticaly updated field. More...
 
virtual void AddField (System::String internalString)=0
 Converts this portion to the automaticaly updated field. More...
 
virtual void RemoveField ()=0
 Converts this field portion to the simple portion. More...
 
virtual System::Drawing::RectangleF GetRect ()=0
 Get coordinates of rect that bounds portion. The rect includes all the lines of text in portion, including empty ones. More...
 
virtual System::Drawing::PointF GetCoordinates ()=0
 Get coordinates of the beginning of the portion. The X coordinate of point represents the portion beginning from the first character including left side bearing. The Y coordinate includes top side bearing. More...
 
virtual System::SharedPtr< IBaseSlideget_Slide ()=0
 Returns the base slide. Read-only IBaseSlide. More...
 
virtual System::SharedPtr< IPresentationget_Presentation ()=0
 Returns the presentation. Read-only IPresentation. More...
 
- 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 reference 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 int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () 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 (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 
virtual System::SharedPtr< IDOMObjectget_Parent_Immediate ()=0
 Returns Parent_Immediate object. Read-only IDOMObject. More...
 

Protected Member Functions

virtual ~Portion ()
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. 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 ()
 Implements C# typeof(System.Object) construct. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 

Detailed Description

Represents a portion of text inside a text paragraph.

Constructor & Destructor Documentation

◆ Portion() [1/3]

Aspose::Slides::Portion::Portion ( )

Initializes a new instance of the Portion class.

◆ Portion() [2/3]

Aspose::Slides::Portion::Portion ( System::String  str)

Initializes a new instance of the Portion class.

◆ Portion() [3/3]

Aspose::Slides::Portion::Portion ( System::SharedPtr< Portion portion)

Initializes a new instance of the Portion class.

◆ ~Portion()

virtual Aspose::Slides::Portion::~Portion ( )
protectedvirtual

Member Function Documentation

◆ AddField() [1/2]

void Aspose::Slides::Portion::AddField ( System::SharedPtr< IFieldType fieldType)
overridevirtual

Converts this portion to the automaticaly updated field.

Implements Aspose::Slides::IPortion.

◆ AddField() [2/2]

void Aspose::Slides::Portion::AddField ( System::String  internalString)
overridevirtual

Converts this portion to the automaticaly updated field.

Parameters
internalStringInternal name of FieldType.

Implements Aspose::Slides::IPortion.

◆ get_Field()

System::SharedPtr< IField > Aspose::Slides::Portion::get_Field ( )
overridevirtual

Returns a field of this portion. Read-only IField.

Implements Aspose::Slides::IPortion.

◆ get_PortionFormat()

System::SharedPtr< IPortionFormat > Aspose::Slides::Portion::get_PortionFormat ( )
overridevirtual

Returns oformatting bject which contains explicitly set formatting properties of the text portion with no inheritance applied. Read-only IPortionFormat.

The formatting object contains the formatting parameters defined for the current portion only, inherited data is not applied.

In order to get the effective values including inherited ones use the PortionFormat::GetEffective method.

Implements Aspose::Slides::IPortion.

◆ get_Text()

System::String Aspose::Slides::Portion::get_Text ( )
overridevirtual

Gets the plain text of a portion. Read System::String.

The text.

Implements Aspose::Slides::IPortion.

◆ GetCoordinates()

System::Drawing::PointF Aspose::Slides::Portion::GetCoordinates ( )
overridevirtual

Get coordinates of the beginning of the portion. The X coordinate of point represents the portion beginning from the first character including left side bearing. The Y coordinate includes top side bearing.

Implements Aspose::Slides::IPortion.

◆ GetRect()

System::Drawing::RectangleF Aspose::Slides::Portion::GetRect ( )
overridevirtual

Get coordinates of rect that bounds portion. The rect includes all the lines of text in portion, including empty ones.

Example:

auto pres = System::MakeObject<Presentation>();
auto slide = pres->get_Slides()->idx_get(0);
auto shape = slide->get_Shapes()->AddAutoShape(Aspose::Slides::ShapeType::Rectangle, 50.0f, 50.0f, 200.0f, 50.0f);
shape->get_TextFrame()->get_Paragraphs()->idx_get(0)->get_Portions()->Clear();
auto portion0 = System::MakeObject<Portion>(u"Some text");
auto portion1 = System::MakeObject<Portion>(u"GetRect text");
shape->get_TextFrame()->get_Paragraphs()->idx_get(0)->get_Portions()->Add(portion0);
shape->get_TextFrame()->get_Paragraphs()->idx_get(0)->get_Portions()->Add(portion1);
auto rect = shape->get_TextFrame()->get_Paragraphs()->idx_get(0)->get_Portions()->idx_get(1)->GetRect();
// ...
@ Rectangle
Rectangle Shape.

Implements Aspose::Slides::IPortion.

◆ RemoveField()

void Aspose::Slides::Portion::RemoveField ( )
overridevirtual

Converts this field portion to the simple portion.

Implements Aspose::Slides::IPortion.

◆ set_Text()

void Aspose::Slides::Portion::set_Text ( System::String  value)
overridevirtual

Sets the plain text of a portion. Write System::String.

The text.

Implements Aspose::Slides::IPortion.