Represents a TextFrame. More...

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

Public Member Functions

System::SharedPtr< IDOMObjectget_Parent_Immediate ()
 Returns Parent_Immediate object. Read-only IDOMObject. More...
 
System::SharedPtr< IParagraphCollectionget_Paragraphs ()
 Returns the list of all paragraphs in a frame. Read-only IParagraphCollection. More...
 
System::String get_Text ()
 Gets the plain text for a TextFrame. Read System::String. More...
 
void set_Text (System::String value)
 Sets the plain text for a TextFrame. Write System::String. More...
 
System::SharedPtr< ITextFrameFormatget_TextFrameFormat ()
 Returns the formatting object for this TextFrame object. Read-only ITextFrameFormat. More...
 
System::SharedPtr< IHyperlinkQueriesget_HyperlinkQueries ()
 Provides easy access to contained hyperlinks. Read-only IHyperlinkQueries. More...
 
System::SharedPtr< IBaseSlideget_Slide ()
 Returns the parent slide of a TextFrame. Read-only IBaseSlide. More...
 
System::SharedPtr< IPresentationget_Presentation ()
 Returns the parent presentation of a TextFrame. Read-only IPresentation. More...
 
void JoinPortionsWithSameFormatting ()
 Joins runs with same formatting in all paragraphs. More...
 
System::SharedPtr< ITextFrameFormatEffectiveDataCreateTextFrameFormatEffective ()
 Creates and returns ITextFrameFormatEffectiveData object which contains current text frame formatting properties, including inherited. Read-only ITextFrameFormatEffectiveData. More...
 
void HighlightText (System::String text, System::Drawing::Color highlightColor)
 Highlight all matches of sample in text frame text using specified color. More...
 
void HighlightText (System::String text, System::Drawing::Color highlightColor, System::SharedPtr< ITextHighlightingOptions > options)
 Highlight all matches of sample in text frame text using specified color. More...
 
void HighlightRegex (System::String regex, System::Drawing::Color highlightColor, System::SharedPtr< ITextHighlightingOptions > options)
 Highlight all matches of regular expression in text frame text using specified color. 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)
 

Protected Member Functions

System::SharedPtr< IPresentationComponentget_Parent_IPresentationComponent ()
 
System::SharedPtr< ISlideComponentget_Parent_ISlideComponent ()
 
System::SharedPtr< Aspose::Slides::TextLayout > get_TextLayout ()
 
void set_TextLayout (System::SharedPtr< Aspose::Slides::TextLayout > value)
 
System::Drawing::SizeF get_WantedSize ()
 Returns the minimal size for a TextFrame, enough to fit the text. Note: you can't simply resize the shape or its TextFrame to that size, text area of most shapes is not equal to shape's area. Read-only SizeF More...
 
System::Drawing::SizeF get_WantedSizeWithoutEmptyLines ()
 
System::ArrayPtr< System::SharedPtr< IParagraphFormat > > get_TextStyleCache ()
 
bool get_HasTextWarp ()
 
System::String get_TextInternal ()
 This property is same as Text property but without evaluation period limitations More...
 
void set_TextInternal (System::String value)
 This property is same as Text property but without evaluation period limitations More...
 
System::SharedPtr< Aspose::Slides::TextFrameFormatget_TextFrameFormatInternal ()
 
bool get_MetroBlobRequired ()
 Shows if saving the shape containing this object to ppt requires GroupShapeMetroBlob record to save all shape's properties correctly More...
 
 TextFrame (System::SharedPtr< IDOMObject > parentImmediate)
 
void CopyDataFrom (System::SharedPtr< ITextFrame > source)
 
void CopyPropertiesFrom (System::SharedPtr< TextFrame > source)
 
void CopyContentFrom (System::SharedPtr< TextFrame > source)
 
System::ArrayPtr< System::SharedPtr< IParagraphFormat > > GetAutoShapeParagraphProperties (System::SharedPtr< FloatColor > &styleColor)
 
void CreateTextLayout (float width, float height, System::SharedPtr< IShapeStyle > shapeStyle, System::SharedPtr< Drawing::RenderContext > rc)
 
void UpdateTextFrameWithEffectivesTemp (System::ArrayPtr< System::SharedPtr< TextFrame >> parentFrames, System::SharedPtr< TextFrame > textFrameToUpdate)
 Set effective settings of TextFrameInternal as local settings of textFrameToUpdate. More...
 
void CreateCellTextLayout (float width, float height, System::SharedPtr< TableCellTextStyle > cellTextStyle, System::SharedPtr< Drawing::RenderContext > rc)
 
void Draw (System::SharedPtr< Drawing::Canvas > canvas, System::SharedPtr< Drawing::RenderContext > rc)
 
void ValidateTextLayout ()
 Validate and recreate text layout for textboxes in AutoShape or in SmartArtShape. More...
 
bool ValidateTextLayout (System::SharedPtr< ShapeFrame > &frame, System::SharedPtr< Drawing::RenderContext > rc)
 Validate and recreate text layout for textboxes in AutoShape or in SmartArtShape. More...
 
System::SharedPtr< Aspose::Foundation::Drawing::DrMatrix > GetTextTransformMatrix (System::SharedPtr< Drawing::RenderContext > rc)
 Validate and get transform matrix for textboxes in AutoShape or in SmartArtShape. More...
 
bool ValidateTextLayout (System::SharedPtr< ShapeFrame > &frame, System::Drawing::RectangleF &textRect, float &lm, float &tm, float &rm, float &bm, System::SharedPtr< Drawing::RenderContext > rc)
 Validates layout. More...
 
System::Drawing::RectangleF GetTextRect (System::SharedPtr< ShapeFrame > frame, System::ArrayPtr< System::SharedPtr< Shape >> prototypes, float &lm, float &tm, float &rm, float &bm, System::ArrayPtr< System::SharedPtr< TextFrame >> &protoFrames)
 
System::Drawing::RectangleF GetTextRect (float x, float y, float width, float height, System::ArrayPtr< System::SharedPtr< Shape >> prototypes, float &lm, float &tm, float &rm, float &bm, System::ArrayPtr< System::SharedPtr< TextFrame >> &protoFrames)
 
System::SharedPtr< Aspose::Foundation::Drawing::DrMatrix > GenerateTextTransformMatrix (System::SharedPtr< ShapeFrame > frame, System::Drawing::RectangleF textRect, float leftMargin, float topMargin, float rightMargin, float bottomMargin)
 
System::SharedPtr< Aspose::Foundation::Drawing::DrMatrix > GenerateTextTransformMatrix (System::SharedPtr< ShapeFrame > frame, System::Drawing::RectangleF textRect, float leftMargin, float topMargin, float rightMargin, float bottomMargin, TextVerticalType vertType, float textFrameAngle, NullableBool wrap, NullableBool fromWordArt)
 
void ClearEffective ()
 

Static Protected Attributes

static System::SharedPtr< Util::ValueMap< PlaceholderType, TextStyleSource > > PlaceholderTypeToTextStyleSource
 

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.

Constructor & Destructor Documentation

◆ TextFrame()

Aspose::Slides::TextFrame::TextFrame ( System::SharedPtr< IDOMObject parentImmediate)
protected

Member Function Documentation

◆ ClearEffective()

void Aspose::Slides::TextFrame::ClearEffective ( )
protected

◆ CopyContentFrom()

void Aspose::Slides::TextFrame::CopyContentFrom ( System::SharedPtr< TextFrame source)
protected

◆ CopyDataFrom()

void Aspose::Slides::TextFrame::CopyDataFrom ( System::SharedPtr< ITextFrame source)
protected

◆ CopyPropertiesFrom()

void Aspose::Slides::TextFrame::CopyPropertiesFrom ( System::SharedPtr< TextFrame source)
protected

◆ CreateCellTextLayout()

void Aspose::Slides::TextFrame::CreateCellTextLayout ( float  width,
float  height,
System::SharedPtr< TableCellTextStyle >  cellTextStyle,
System::SharedPtr< Drawing::RenderContext >  rc 
)
protected

◆ CreateTextFrameFormatEffective()

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

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

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

Implements Aspose::Slides::ITextFrame.

◆ CreateTextLayout()

void Aspose::Slides::TextFrame::CreateTextLayout ( float  width,
float  height,
System::SharedPtr< IShapeStyle shapeStyle,
System::SharedPtr< Drawing::RenderContext >  rc 
)
protected

◆ Draw()

void Aspose::Slides::TextFrame::Draw ( System::SharedPtr< Drawing::Canvas >  canvas,
System::SharedPtr< Drawing::RenderContext >  rc 
)
protected

◆ GenerateTextTransformMatrix() [1/2]

System::SharedPtr<Aspose::Foundation::Drawing::DrMatrix> Aspose::Slides::TextFrame::GenerateTextTransformMatrix ( System::SharedPtr< ShapeFrame frame,
System::Drawing::RectangleF  textRect,
float  leftMargin,
float  topMargin,
float  rightMargin,
float  bottomMargin 
)
protected

◆ GenerateTextTransformMatrix() [2/2]

System::SharedPtr<Aspose::Foundation::Drawing::DrMatrix> Aspose::Slides::TextFrame::GenerateTextTransformMatrix ( System::SharedPtr< ShapeFrame frame,
System::Drawing::RectangleF  textRect,
float  leftMargin,
float  topMargin,
float  rightMargin,
float  bottomMargin,
TextVerticalType  vertType,
float  textFrameAngle,
NullableBool  wrap,
NullableBool  fromWordArt 
)
protected

◆ get_HasTextWarp()

bool Aspose::Slides::TextFrame::get_HasTextWarp ( )
protected

◆ get_HyperlinkQueries()

System::SharedPtr<IHyperlinkQueries> Aspose::Slides::TextFrame::get_HyperlinkQueries ( )
virtual

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

Implements Aspose::Slides::ITextFrame.

◆ get_MetroBlobRequired()

bool Aspose::Slides::TextFrame::get_MetroBlobRequired ( )
protected

Shows if saving the shape containing this object to ppt requires GroupShapeMetroBlob record to save all shape's properties correctly

◆ get_Paragraphs()

System::SharedPtr<IParagraphCollection> Aspose::Slides::TextFrame::get_Paragraphs ( )
virtual

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

Implements Aspose::Slides::ITextFrame.

◆ get_Parent_Immediate()

System::SharedPtr<IDOMObject> Aspose::Slides::TextFrame::get_Parent_Immediate ( )
virtual

Returns Parent_Immediate object. Read-only IDOMObject.

Implements Aspose::Slides::IDOMObject.

◆ get_Parent_IPresentationComponent()

System::SharedPtr<IPresentationComponent> Aspose::Slides::TextFrame::get_Parent_IPresentationComponent ( )
protected

◆ get_Parent_ISlideComponent()

System::SharedPtr<ISlideComponent> Aspose::Slides::TextFrame::get_Parent_ISlideComponent ( )
protected

◆ get_Presentation()

System::SharedPtr<IPresentation> Aspose::Slides::TextFrame::get_Presentation ( )
virtual

Returns the parent presentation of a TextFrame. Read-only IPresentation.

Implements Aspose::Slides::IPresentationComponent.

◆ get_Slide()

System::SharedPtr<IBaseSlide> Aspose::Slides::TextFrame::get_Slide ( )
virtual

Returns the parent slide of a TextFrame. Read-only IBaseSlide.

Implements Aspose::Slides::ISlideComponent.

◆ get_Text()

System::String Aspose::Slides::TextFrame::get_Text ( )
virtual

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

The text.

Implements Aspose::Slides::ITextFrame.

◆ get_TextFrameFormat()

System::SharedPtr<ITextFrameFormat> Aspose::Slides::TextFrame::get_TextFrameFormat ( )
virtual

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

Implements Aspose::Slides::ITextFrame.

◆ get_TextFrameFormatInternal()

System::SharedPtr<Aspose::Slides::TextFrameFormat> Aspose::Slides::TextFrame::get_TextFrameFormatInternal ( )
protected

◆ get_TextInternal()

System::String Aspose::Slides::TextFrame::get_TextInternal ( )
protected

This property is same as Text property but without evaluation period limitations

◆ get_TextLayout()

System::SharedPtr<Aspose::Slides::TextLayout> Aspose::Slides::TextFrame::get_TextLayout ( )
protected

◆ get_TextStyleCache()

System::ArrayPtr<System::SharedPtr<IParagraphFormat> > Aspose::Slides::TextFrame::get_TextStyleCache ( )
protected

◆ get_WantedSize()

System::Drawing::SizeF Aspose::Slides::TextFrame::get_WantedSize ( )
protected

Returns the minimal size for a TextFrame, enough to fit the text. Note: you can't simply resize the shape or its TextFrame to that size, text area of most shapes is not equal to shape's area. Read-only SizeF

◆ get_WantedSizeWithoutEmptyLines()

System::Drawing::SizeF Aspose::Slides::TextFrame::get_WantedSizeWithoutEmptyLines ( )
protected

◆ GetAutoShapeParagraphProperties()

System::ArrayPtr<System::SharedPtr<IParagraphFormat> > Aspose::Slides::TextFrame::GetAutoShapeParagraphProperties ( System::SharedPtr< FloatColor > &  styleColor)
protected

◆ GetTextRect() [1/2]

System::Drawing::RectangleF Aspose::Slides::TextFrame::GetTextRect ( System::SharedPtr< ShapeFrame frame,
System::ArrayPtr< System::SharedPtr< Shape >>  prototypes,
float &  lm,
float &  tm,
float &  rm,
float &  bm,
System::ArrayPtr< System::SharedPtr< TextFrame >> &  protoFrames 
)
protected

◆ GetTextRect() [2/2]

System::Drawing::RectangleF Aspose::Slides::TextFrame::GetTextRect ( float  x,
float  y,
float  width,
float  height,
System::ArrayPtr< System::SharedPtr< Shape >>  prototypes,
float &  lm,
float &  tm,
float &  rm,
float &  bm,
System::ArrayPtr< System::SharedPtr< TextFrame >> &  protoFrames 
)
protected

◆ GetTextTransformMatrix()

System::SharedPtr<Aspose::Foundation::Drawing::DrMatrix> Aspose::Slides::TextFrame::GetTextTransformMatrix ( System::SharedPtr< Drawing::RenderContext >  rc)
protected

Validate and get transform matrix for textboxes in AutoShape or in SmartArtShape.

Parameters
rcThe rendering context
Returns
The transform matrix for text box

◆ HighlightRegex()

void Aspose::Slides::TextFrame::HighlightRegex ( System::String  regex,
System::Drawing::Color  highlightColor,
System::SharedPtr< ITextHighlightingOptions options 
)
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.

Implements Aspose::Slides::ITextFrame.

◆ HighlightText() [1/2]

void Aspose::Slides::TextFrame::HighlightText ( System::String  text,
System::Drawing::Color  highlightColor 
)
virtual

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

Parameters
textText sample to highlight.
highlightColorHighlighting color.

Implements Aspose::Slides::ITextFrame.

◆ HighlightText() [2/2]

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

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

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

Implements Aspose::Slides::ITextFrame.

◆ JoinPortionsWithSameFormatting()

void Aspose::Slides::TextFrame::JoinPortionsWithSameFormatting ( )
virtual

Joins runs with same formatting in all paragraphs.

Implements Aspose::Slides::ITextFrame.

◆ set_Text()

void Aspose::Slides::TextFrame::set_Text ( System::String  value)
virtual

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

The text.

Implements Aspose::Slides::ITextFrame.

◆ set_TextInternal()

void Aspose::Slides::TextFrame::set_TextInternal ( System::String  value)
protected

This property is same as Text property but without evaluation period limitations

◆ set_TextLayout()

void Aspose::Slides::TextFrame::set_TextLayout ( System::SharedPtr< Aspose::Slides::TextLayout >  value)
protected

◆ UpdateTextFrameWithEffectivesTemp()

void Aspose::Slides::TextFrame::UpdateTextFrameWithEffectivesTemp ( System::ArrayPtr< System::SharedPtr< TextFrame >>  parentFrames,
System::SharedPtr< TextFrame textFrameToUpdate 
)
protected

Set effective settings of TextFrameInternal as local settings of textFrameToUpdate.

◆ ValidateTextLayout() [1/3]

void Aspose::Slides::TextFrame::ValidateTextLayout ( )
protected

Validate and recreate text layout for textboxes in AutoShape or in SmartArtShape.

◆ ValidateTextLayout() [2/3]

bool Aspose::Slides::TextFrame::ValidateTextLayout ( System::SharedPtr< ShapeFrame > &  frame,
System::SharedPtr< Drawing::RenderContext >  rc 
)
protected

Validate and recreate text layout for textboxes in AutoShape or in SmartArtShape.

◆ ValidateTextLayout() [3/3]

bool Aspose::Slides::TextFrame::ValidateTextLayout ( System::SharedPtr< ShapeFrame > &  frame,
System::Drawing::RectangleF textRect,
float &  lm,
float &  tm,
float &  rm,
float &  bm,
System::SharedPtr< Drawing::RenderContext >  rc 
)
protected

Validates layout.

Returns
Returns true if everything went fine, returns false if height of TextLayout is significantly different than TextFrame size.

Member Data Documentation

◆ PlaceholderTypeToTextStyleSource

System::SharedPtr<Util::ValueMap<PlaceholderType, TextStyleSource> > Aspose::Slides::TextFrame::PlaceholderTypeToTextStyleSource
staticprotected