Aspose::Slides::ITextFrame Class Referenceabstract

Represents a TextFrame. More...

Inherits Aspose::Slides::ISlideComponent.

Inherited by Aspose::Slides::TextFrame.

Public Member Functions

virtual System::SharedPtr< IParagraphCollectionget_Paragraphs ()=0
 Returns the list of all paragraphs in a frame. Read-only IParagraphCollection. More...
 
virtual System::String get_Text ()=0
 Gets the plain text for a TextFrame. Read System::String. More...
 
virtual void set_Text (System::String value)=0
 Sets the plain text for a TextFrame. Write System::String. More...
 
virtual System::SharedPtr< ITextFrameFormatget_TextFrameFormat ()=0
 Returns the formatting object for this TextFrame object. Read-only ITextFrameFormat. More...
 
virtual System::SharedPtr< IHyperlinkQueriesget_HyperlinkQueries ()=0
 Provides easy access to contained hyperlinks. Read-only IHyperlinkQueries. More...
 
virtual void JoinPortionsWithSameFormatting ()=0
 Joins runs with same formatting in all paragraphs. More...
 
virtual System::SharedPtr< ITextFrameFormatEffectiveDataCreateTextFrameFormatEffective ()=0
 Creates and returns ITextFrameFormatEffectiveData object which contains current text frame formatting properties, including inherited. Read-only ITextFrameFormatEffectiveData. More...
 
virtual void HighlightText (System::String text, System::Drawing::Color highlightColor)=0
 Highlight all matches of sample in text frame text using specified color. More...
 
virtual 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 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...
 
- Public Member Functions inherited from Aspose::Slides::ISlideComponent
virtual System::SharedPtr< IBaseSlideget_Slide ()=0
 Returns the base slide. Read-only IBaseSlide. More...
 
- Public Member Functions inherited from Aspose::Slides::IPresentationComponent
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 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...
 
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)
 

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

Detailed Description

Represents a TextFrame.

Member Function Documentation

◆ CreateTextFrameFormatEffective()

virtual System::SharedPtr<ITextFrameFormatEffectiveData> Aspose::Slides::ITextFrame::CreateTextFrameFormatEffective ( )
pure virtual

Creates and returns ITextFrameFormatEffectiveData object which contains current text frame formatting properties, including inherited. Read-only ITextFrameFormatEffectiveData.

Deprecated:
Use ITextFrame.TextFrameFormat.GetEffective() instead. The method will be removed after release of version 20.8.
Returns
A ITextFrameFormatEffectiveData instance.

Implemented in Aspose::Slides::TextFrame.

◆ get_HyperlinkQueries()

virtual 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_Paragraphs()

virtual 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 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 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 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 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 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 void Aspose::Slides::ITextFrame::JoinPortionsWithSameFormatting ( )
pure virtual

Joins runs with same formatting in all paragraphs.

Implemented in Aspose::Slides::TextFrame.

◆ set_Text()

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