Aspose::Slides::ITextFrame Class Referenceabstract

Represents a TextFrame. More...

#include <ITextFrame.h>

Inherits Aspose::Slides::ISlideComponent.

Inherited by Aspose::Slides::TextFrame.

Public Member Functions

virtual ASPOSE_SLIDES_API_LOCAL_API System::SharedPtr< IParagraphCollectionget_Paragraphs ()=0
 Returns the list of all paragraphs in a frame. Read-only IParagraphCollection. More...
 
virtual ASPOSE_SLIDES_API_LOCAL_API System::String get_Text ()=0
 Gets the plain text for a TextFrame. Read System::String. More...
 
virtual ASPOSE_SLIDES_API_LOCAL_API void set_Text (System::String value)=0
 Sets the plain text for a TextFrame. Write System::String. More...
 
virtual ASPOSE_SLIDES_API_LOCAL_API System::SharedPtr< ITextFrameFormatget_TextFrameFormat ()=0
 Returns the formatting object for this TextFrame object. Read-only ITextFrameFormat. More...
 
virtual ASPOSE_SLIDES_API_LOCAL_API System::SharedPtr< IHyperlinkQueriesget_HyperlinkQueries ()=0
 Provides easy access to contained hyperlinks. Read-only IHyperlinkQueries. More...
 
virtual ASPOSE_SLIDES_API_LOCAL_API void JoinPortionsWithSameFormatting ()=0
 Joins runs with same formatting in all paragraphs. More...
 
virtual ASPOSE_SLIDES_API_LOCAL_API void HighlightText (System::String text, System::Drawing::Color highlightColor)=0
 Highlight all matches of sample in text frame text using specified color. More...
 
virtual ASPOSE_SLIDES_API_LOCAL_API void HighlightText (System::String text, System::Drawing::Color highlightColor, System::SharedPtr< ITextHighlightingOptions > options)=0
 Highlight all matches of sample in text frame text using specified color. More...
 
virtual ASPOSE_SLIDES_API_LOCAL_API void HighlightRegex (System::String regex, System::Drawing::Color highlightColor, System::SharedPtr< ITextHighlightingOptions > options)=0
 Highlight all matches of regular expression in text frame text using specified color. More...
 
virtual ASPOSE_SLIDES_API_LOCAL_API System::SharedPtr< IParagraphget_Paragraph (int32_t index)=0
 Returns a paragraph in a frame at the specified index. More...
 
- Public Member Functions inherited from Aspose::Slides::ISlideComponent
virtual ASPOSE_SLIDES_API_LOCAL_API System::SharedPtr< IBaseSlideget_Slide ()=0
 Returns the base slide. Read-only IBaseSlide. More...
 
- Public Member Functions inherited from Aspose::Slides::IPresentationComponent
virtual ASPOSE_SLIDES_API_LOCAL_API 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...
 

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 TextFrame.

Member Function Documentation

◆ get_HyperlinkQueries()

virtual ASPOSE_SLIDES_API_LOCAL_API System::SharedPtr< IHyperlinkQueries > Aspose::Slides::ITextFrame::get_HyperlinkQueries ( )
pure virtual

Provides easy access to contained hyperlinks. Read-only IHyperlinkQueries.

Implemented in Aspose::Slides::TextFrame.

◆ get_Paragraph()

virtual ASPOSE_SLIDES_API_LOCAL_API System::SharedPtr< IParagraph > Aspose::Slides::ITextFrame::get_Paragraph ( int32_t  index)
pure virtual

Returns a paragraph in a frame at the specified index.

Implemented in Aspose::Slides::TextFrame.

◆ get_Paragraphs()

virtual ASPOSE_SLIDES_API_LOCAL_API System::SharedPtr< IParagraphCollection > Aspose::Slides::ITextFrame::get_Paragraphs ( )
pure virtual

Returns the list of all paragraphs in a frame. Read-only IParagraphCollection.

Implemented in Aspose::Slides::TextFrame.

◆ get_Text()

virtual ASPOSE_SLIDES_API_LOCAL_API System::String Aspose::Slides::ITextFrame::get_Text ( )
pure virtual

Gets the plain text for a TextFrame. Read System::String.

The text.

Implemented in Aspose::Slides::TextFrame.

◆ get_TextFrameFormat()

virtual ASPOSE_SLIDES_API_LOCAL_API System::SharedPtr< ITextFrameFormat > Aspose::Slides::ITextFrame::get_TextFrameFormat ( )
pure virtual

Returns the formatting object for this TextFrame object. Read-only ITextFrameFormat.

Implemented in Aspose::Slides::TextFrame.

◆ HighlightRegex()

virtual ASPOSE_SLIDES_API_LOCAL_API void Aspose::Slides::ITextFrame::HighlightRegex ( System::String  regex,
System::Drawing::Color  highlightColor,
System::SharedPtr< ITextHighlightingOptions options 
)
pure virtual

Highlight all matches of regular expression in text frame text using specified color.

Parameters
regexText of regular expression to get text to highlight.
highlightColorHighlighting color.
optionsHighlighting options.

Implemented in Aspose::Slides::TextFrame.

◆ HighlightText() [1/2]

virtual ASPOSE_SLIDES_API_LOCAL_API void Aspose::Slides::ITextFrame::HighlightText ( System::String  text,
System::Drawing::Color  highlightColor 
)
pure virtual

Highlight all matches of sample in text frame text using specified color.

Parameters
textText sample to highlight.
highlightColorHighlighting color.

Implemented in Aspose::Slides::TextFrame.

◆ HighlightText() [2/2]

virtual ASPOSE_SLIDES_API_LOCAL_API void Aspose::Slides::ITextFrame::HighlightText ( System::String  text,
System::Drawing::Color  highlightColor,
System::SharedPtr< ITextHighlightingOptions options 
)
pure virtual

Highlight all matches of sample in text frame text using specified color.

Parameters
textText sample to highlight.
highlightColorHighlighting color.
optionsHighlighting options.

Implemented in Aspose::Slides::TextFrame.

◆ JoinPortionsWithSameFormatting()

virtual ASPOSE_SLIDES_API_LOCAL_API void Aspose::Slides::ITextFrame::JoinPortionsWithSameFormatting ( )
pure virtual

Joins runs with same formatting in all paragraphs.

Implemented in Aspose::Slides::TextFrame.

◆ set_Text()

virtual ASPOSE_SLIDES_API_LOCAL_API void Aspose::Slides::ITextFrame::set_Text ( System::String  value)
pure virtual

Sets the plain text for a TextFrame. Write System::String.

The text.

Implemented in Aspose::Slides::TextFrame.