Aspose::Slides::TextFrameFormat Class Reference

Contains the TextFrame's formatTextFrameFormatting properties. More...

Inherits Aspose::Slides::PVIObject, Aspose::Slides::ITextFrameFormat, and Aspose::Slides::Charts::IChartTextBlockFormat.

Public Member Functions

System::SharedPtr< ITextStyleget_TextStyle ()
 Returns text's style. Read-only ITextStyle. More...
 
double get_MarginLeft ()
 Returns the left margin (points) in a TextFrame. Read double. More...
 
void set_MarginLeft (double value)
 Sets the left margin (points) in a TextFrame. Write double. More...
 
double get_MarginRight ()
 Returns the right margin (points) in a TextFrame. Read double. More...
 
void set_MarginRight (double value)
 Sets the right margin (points) in a TextFrame. Write double. More...
 
double get_MarginTop ()
 Returns the top margin (points) in a TextFrame. Read double. More...
 
void set_MarginTop (double value)
 Sets the top margin (points) in a TextFrame. Write double. More...
 
double get_MarginBottom ()
 Returns the bottom margin (points) in a TextFrame. Read double. More...
 
void set_MarginBottom (double value)
 Sets the bottom margin (points) in a TextFrame. Write double. More...
 
NullableBool get_WrapText ()
 True if text is wrapped at TextFrame's margins. Read NullableBool. More...
 
void set_WrapText (NullableBool value)
 True if text is wrapped at TextFrame's margins. Write NullableBool. More...
 
TextAnchorType get_AnchoringType ()
 Returns vertical anchor text in a TextFrameEx. Read TextAnchorType. More...
 
void set_AnchoringType (TextAnchorType value)
 Sets vertical anchor text in a TextFrameEx. Write TextAnchorType. More...
 
NullableBool get_CenterText ()
 If NullableBool.True then text should be centered in box horizontally. Read NullableBool. More...
 
void set_CenterText (NullableBool value)
 If NullableBool.True then text should be centered in box horizontally. Write NullableBool. More...
 
Aspose::Slides::TextVerticalType get_TextVerticalType ()
 Determines text orientation. The resulted value of visual text rotation summarized from this property and custom angle in property RotationAngle. Read Slides::TextVerticalType. More...
 
void set_TextVerticalType (Aspose::Slides::TextVerticalType value)
 Determines text orientation. The resulted value of visual text rotation summarized from this property and custom angle in property RotationAngle. Write Slides::TextVerticalType. More...
 
TextAutofitType get_AutofitType ()
 Returns text's autofit mode. Read TextAutofitType. More...
 
void set_AutofitType (TextAutofitType value)
 Sets text's autofit mode. Write TextAutofitType. More...
 
int32_t get_ColumnCount ()
 Returns number of columns in the text area. This value must be a positive number. Otherwise, the value will be set to zero. Value 0 means undefined value. Read int32_t. More...
 
void set_ColumnCount (int32_t value)
 Sets number of columns in the text area. This value must be a positive number. Otherwise, the value will be set to zero. Value 0 means undefined value. Write int32_t. More...
 
double get_ColumnSpacing ()
 Returns the space between text columns in the text area (in points). This should only apply when there is more than 1 column present. This value must be a positive number. Otherwise, the value will be set to zero. Read double. More...
 
void set_ColumnSpacing (double value)
 Sets the space between text columns in the text area (in points). This should only apply when there is more than 1 column present. This value must be a positive number. Otherwise, the value will be set to zero. Write double. More...
 
float get_RotationAngle ()
 Specifies custom the rotation that is being applied to the text within the bounding box. If it not specified, the rotation of the accompanying shape is used. If it is specified, then this is applied independently from the shape. That is the shape can have a rotation applied in addition to the text itself having a rotation applied to it. The resulted value of visual text rotation summarized from this property and predefined vertical type in property TextVerticalType. Read float. More...
 
void set_RotationAngle (float value)
 Specifies custom the rotation that is being applied to the text within the bounding box. If it not specified, the rotation of the accompanying shape is used. If it is specified, then this is applied independently from the shape. That is the shape can have a rotation applied in addition to the text itself having a rotation applied to it. The resulted value of visual text rotation summarized from this property and predefined vertical type in property TextVerticalType. Write float. More...
 
 TextFrameFormat ()
 Initializes a new instance of TextFrameFormat class. More...
 
System::SharedPtr< ITextFrameFormatEffectiveDataGetEffective ()
 Gets effective text frame formatting data with the inheritance applied. More...
 
- Public Member Functions inherited from Aspose::Slides::PVIObject
virtual bool Equals (System::SharedPtr< System::Object > obj)
 Compares with specified object. More...
 
virtual int32_t GetHashCode () const
 Returns hash code. 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 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 Types

using ParameterlessSignal = System::MulticastDelegate< void()>
 

Protected Member Functions

System::SharedPtr< TextFrameFormatImpl > get_RealObject ()
 
System::SharedPtr< UnsupportedProps::PPTUnsupportedProps::TextFrameFormatPPTUnsupportedProps > get_PPTUnsupportedProps ()
 
System::SharedPtr< UnsupportedProps::PPTXUnsupportedProps::TextFrameFormatPPTXUnsupportedProps > get_PPTXUnsupportedProps ()
 
System::SharedPtr< Aspose::Slides::TextStyleget_TextStyleInternal ()
 
System::SharedPtr< UnsupportedProps::PPTXUnsupportedProps::PresetTextShape > get_TextShape ()
 Relates to attribute "CT_TextBodyProperties@prstTxWarp" defined in "dml-text.xsd" schema file. More...
 
TextAutofitType get_AutofitTypeInternal ()
 Gets text autofit mode without "changed" flag updating. This property must be used for deserialization when it is not necessary to call text relayouting. More...
 
void set_AutofitTypeInternal (TextAutofitType value)
 Sets text autofit mode without "changed" flag updating. This property must be used for deserialization when it is not necessary to call text relayouting. More...
 
NullableBool get_RightToLeftColumns ()
 Specifies whether columns are used in a right-to-left or left-to-right order. The usage of this attribute only sets the column order that is used to determine which column overflow text should go to next. This attribute in no way determines the direction of text but merely the direction in which multiple columns are used. More...
 
void set_RightToLeftColumns (NullableBool value)
 Specifies whether columns are used in a right-to-left or left-to-right order. The usage of this attribute only sets the column order that is used to determine which column overflow text should go to next. This attribute in no way determines the direction of text but merely the direction in which multiple columns are used. More...
 
Aspose::Slides::PptxSerialization::TextHorizontalOverflowType get_TextHorizontalOverflowType ()
 Relates to attribute "CT_TextBodyProperties@horzOverflow" defined in "dml-text.xsd" schema file. More...
 
void set_TextHorizontalOverflowType (Aspose::Slides::PptxSerialization::TextHorizontalOverflowType value)
 Relates to attribute "CT_TextBodyProperties@horzOverflow" defined in "dml-text.xsd" schema file. More...
 
float get_NormalAutofitFontScale ()
 Specifies the percentage of the original font size to which each run in the text body is scaled. In order to auto-fit text within a bounding box it is sometimes necessary to decrease the font size by a certain percentage. Using this prorerty the font within a text box can be scaled based on the value provided. A value of "1" scales the text to 100%, while a value of "0.01" scales the text to 1%. Minimal value is 0.01. Maximum value is 1. This prorerty make sense only when TextFrameEx.AutofitType property value equal to TextAutofitType.Normal. More...
 
void set_NormalAutofitFontScale (float value)
 Specifies the percentage of the original font size to which each run in the text body is scaled. In order to auto-fit text within a bounding box it is sometimes necessary to decrease the font size by a certain percentage. Using this prorerty the font within a text box can be scaled based on the value provided. A value of "1" scales the text to 100%, while a value of "0.01" scales the text to 1%. Minimal value is 0.01. Maximum value is 1. This prorerty make sense only when TextFrameEx.AutofitType property value equal to TextAutofitType.Normal. More...
 
float get_NormalAutofitLineSpaceReduction ()
 Specifies the percentage amount by which the line spacing of each paragraph in the text body is reduced. The reduction is applied by subtracting it from the original line spacing value. Using this prorerty the vertical spacing between the lines of text can be scaled by a percent amount. A value of "1" reduces the line spacing by 100%, while a value of "0.01" reduces the line spacing by one percent. This prorerty applies only to paragraphs with percentage line spacing. This prorerty make sense only when TextFrameEx.AutofitType property value equal to TextAutofitType.Normal. More...
 
void set_NormalAutofitLineSpaceReduction (float value)
 Specifies the percentage amount by which the line spacing of each paragraph in the text body is reduced. The reduction is applied by subtracting it from the original line spacing value. Using this prorerty the vertical spacing between the lines of text can be scaled by a percent amount. A value of "1" reduces the line spacing by 100%, while a value of "0.01" reduces the line spacing by one percent. This prorerty applies only to paragraphs with percentage line spacing. This prorerty make sense only when TextFrameEx.AutofitType property value equal to TextAutofitType.Normal. More...
 
NullableBool get_FirstLastParagraphSpacing ()
 Specifies whether the before and after paragraph spacing defined by the user is to be respected. While the spacing between paragraphs is helpful, it is additionally useful to be able to set a flag as to whether this spacing is to be followed at the edges of the text body, in other words the first and last paragraphs in the text body. More precisely since this is a text body level property it should only effect the before paragraph spacing of the first paragraph and the after paragraph spacing of the last paragraph for a given text body. More...
 
void set_FirstLastParagraphSpacing (NullableBool value)
 Specifies whether the before and after paragraph spacing defined by the user is to be respected. While the spacing between paragraphs is helpful, it is additionally useful to be able to set a flag as to whether this spacing is to be followed at the edges of the text body, in other words the first and last paragraphs in the text body. More precisely since this is a text body level property it should only effect the before paragraph spacing of the first paragraph and the after paragraph spacing of the last paragraph for a given text body. More...
 
Aspose::Slides::TextVerticalOverflowType get_TextVerticalOverflowType ()
 Determines whether the text can flow out of the bounding box vertically. This is used to determine what happens in the event that the text within a shape is too large for the bounding box it is contained within. More...
 
void set_TextVerticalOverflowType (Aspose::Slides::TextVerticalOverflowType value)
 Determines whether the text can flow out of the bounding box vertically. This is used to determine what happens in the event that the text within a shape is too large for the bounding box it is contained within. More...
 
NullableBool get_FromWordArt ()
 Specifies that text within this textbox is converted text from a WordArt object. This is more of a backwards compatibility attribute that is useful to the application from a tracking perspective. WordArt was the former way to apply text effects and therefore this attribute is useful in document conversion scenarios. More...
 
void set_FromWordArt (NullableBool value)
 Specifies that text within this textbox is converted text from a WordArt object. This is more of a backwards compatibility attribute that is useful to the application from a tracking perspective. WordArt was the former way to apply text effects and therefore this attribute is useful in document conversion scenarios. More...
 
NullableBool get_ForceAntiAliased ()
 Forces the text to be rendered anti-aliased regardless of the font size. Certain fonts can appear grainy around their edges unless they are anti-aliased. Therefore this attribute allows for the specifying of which bodies of text should always be anti-aliased and which ones should not. More...
 
void set_ForceAntiAliased (NullableBool value)
 Forces the text to be rendered anti-aliased regardless of the font size. Certain fonts can appear grainy around their edges unless they are anti-aliased. Therefore this attribute allows for the specifying of which bodies of text should always be anti-aliased and which ones should not. More...
 
bool get_RemainUpright ()
 Specifies whether text should remain upright, regardless of the transform applied to it and the accompanying shape transform. More...
 
void set_RemainUpright (bool value)
 Specifies whether text should remain upright, regardless of the transform applied to it and the accompanying shape transform. More...
 
NullableBool get_CompatibleLineSpacing ()
 Specifies that the line spacing for this text body is decided in a simplistic manner using the font scene. More...
 
void set_CompatibleLineSpacing (NullableBool value)
 Specifies that the line spacing for this text body is decided in a simplistic manner using the font scene. More...
 
bool get_MetroBlobRequired ()
 Shows if saving the shape containing this object to ppt requires GroupShapeMetroBlob record to save all shape's properties correctly More...
 
System::SharedPtr< Aspose::Slides::Paragraph::TextPropertiesVersionget_TextPropertiesVersion ()
 
Aspose::Slides::TextVerticalType get_InheritedTextVerticalType ()
 
uint32_t get_Version_OldMode ()
 
 TextFrameFormat (System::SharedPtr< IDOMObject > parentImmediate)
 
virtual void CreateChildObjects ()
 
virtual System::SharedPtr< System::ObjectCreateRealObject ()
 
void CopyDataFrom (System::SharedPtr< ITextFrameFormat > source)
 
void CopyDefinedDataFrom (System::SharedPtr< ITextFrameFormat > source)
 
bool EqualFormattingAsChartTextBlockFormat (System::SharedPtr< Charts::IChartTextBlockFormat > textBlockFormat)
 
void Changed ()
 
bool NeedToScaleSize (System::ArrayPtr< System::SharedPtr< ITextFrameFormat >> parentFormats)
 
void ScaleSizes (float dt)
 
void Reset ()
 Sets all properties to NotDefined state. More...
 
System::SharedPtr< TextFrameFormatEffectiveData > GetEffectiveInternal ()
 
void ClearEffective ()
 
void Changed_OldMode ()
 
- Protected Member Functions inherited from Aspose::Slides::PVIObject
System::SharedPtr< ObjectWrapper > get_Wrapper () const
 
System::SharedPtr< IDOMObjectget_Parent_Immediate ()
 Returns Parent_Immediate object. Read-only IDOMObject. More...
 
void set_Parent_Immediate (System::SharedPtr< IDOMObject > value)
 
virtual uint32_t get_Version ()
 Version. Read-only uint32_t. More...
 
System::SharedPtr< IPresentationComponentget_Parent_IPresentationComponent ()
 Returns parent IPresentationComponent. Read-only IPresentationComponent. More...
 
System::SharedPtr< ISlideComponentget_Parent_ISlideComponent ()
 
System::SharedPtr< BaseSlideget_Slide ()
 
System::SharedPtr< Aspose::Slides::Presentationget_Presentation ()
 
 PVIObject (System::SharedPtr< IDOMObject > parentImmediate)
 
void Reset_Parent_IPresentationComponent ()
 

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

Contains the TextFrame's formatTextFrameFormatting properties.

Member Typedef Documentation

◆ ParameterlessSignal

Constructor & Destructor Documentation

◆ TextFrameFormat() [1/2]

Aspose::Slides::TextFrameFormat::TextFrameFormat ( )

Initializes a new instance of TextFrameFormat class.

◆ TextFrameFormat() [2/2]

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

Member Function Documentation

◆ Changed()

void Aspose::Slides::TextFrameFormat::Changed ( )
protected

◆ Changed_OldMode()

void Aspose::Slides::TextFrameFormat::Changed_OldMode ( )
protected

◆ ClearEffective()

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

◆ CopyDataFrom()

void Aspose::Slides::TextFrameFormat::CopyDataFrom ( System::SharedPtr< ITextFrameFormat source)
protected

◆ CopyDefinedDataFrom()

void Aspose::Slides::TextFrameFormat::CopyDefinedDataFrom ( System::SharedPtr< ITextFrameFormat source)
protected

◆ CreateChildObjects()

virtual void Aspose::Slides::TextFrameFormat::CreateChildObjects ( )
protectedvirtual

◆ CreateRealObject()

virtual System::SharedPtr<System::Object> Aspose::Slides::TextFrameFormat::CreateRealObject ( )
protectedvirtual

◆ EqualFormattingAsChartTextBlockFormat()

bool Aspose::Slides::TextFrameFormat::EqualFormattingAsChartTextBlockFormat ( System::SharedPtr< Charts::IChartTextBlockFormat textBlockFormat)
protected

◆ get_AnchoringType()

TextAnchorType Aspose::Slides::TextFrameFormat::get_AnchoringType ( )
virtual

Returns vertical anchor text in a TextFrameEx. Read TextAnchorType.

Implements Aspose::Slides::Charts::IChartTextBlockFormat.

◆ get_AutofitType()

TextAutofitType Aspose::Slides::TextFrameFormat::get_AutofitType ( )
virtual

Returns text's autofit mode. Read TextAutofitType.

Implements Aspose::Slides::Charts::IChartTextBlockFormat.

◆ get_AutofitTypeInternal()

TextAutofitType Aspose::Slides::TextFrameFormat::get_AutofitTypeInternal ( )
protected

Gets text autofit mode without "changed" flag updating. This property must be used for deserialization when it is not necessary to call text relayouting.

◆ get_CenterText()

NullableBool Aspose::Slides::TextFrameFormat::get_CenterText ( )
virtual

If NullableBool.True then text should be centered in box horizontally. Read NullableBool.

Implements Aspose::Slides::Charts::IChartTextBlockFormat.

◆ get_ColumnCount()

int32_t Aspose::Slides::TextFrameFormat::get_ColumnCount ( )
virtual

Returns number of columns in the text area. This value must be a positive number. Otherwise, the value will be set to zero. Value 0 means undefined value. Read int32_t.

Implements Aspose::Slides::ITextFrameFormat.

◆ get_ColumnSpacing()

double Aspose::Slides::TextFrameFormat::get_ColumnSpacing ( )
virtual

Returns the space between text columns in the text area (in points). This should only apply when there is more than 1 column present. This value must be a positive number. Otherwise, the value will be set to zero. Read double.

Implements Aspose::Slides::ITextFrameFormat.

◆ get_CompatibleLineSpacing()

NullableBool Aspose::Slides::TextFrameFormat::get_CompatibleLineSpacing ( )
protected

Specifies that the line spacing for this text body is decided in a simplistic manner using the font scene.

◆ get_FirstLastParagraphSpacing()

NullableBool Aspose::Slides::TextFrameFormat::get_FirstLastParagraphSpacing ( )
protected

Specifies whether the before and after paragraph spacing defined by the user is to be respected. While the spacing between paragraphs is helpful, it is additionally useful to be able to set a flag as to whether this spacing is to be followed at the edges of the text body, in other words the first and last paragraphs in the text body. More precisely since this is a text body level property it should only effect the before paragraph spacing of the first paragraph and the after paragraph spacing of the last paragraph for a given text body.

◆ get_ForceAntiAliased()

NullableBool Aspose::Slides::TextFrameFormat::get_ForceAntiAliased ( )
protected

Forces the text to be rendered anti-aliased regardless of the font size. Certain fonts can appear grainy around their edges unless they are anti-aliased. Therefore this attribute allows for the specifying of which bodies of text should always be anti-aliased and which ones should not.

◆ get_FromWordArt()

NullableBool Aspose::Slides::TextFrameFormat::get_FromWordArt ( )
protected

Specifies that text within this textbox is converted text from a WordArt object. This is more of a backwards compatibility attribute that is useful to the application from a tracking perspective. WordArt was the former way to apply text effects and therefore this attribute is useful in document conversion scenarios.

◆ get_InheritedTextVerticalType()

Aspose::Slides::TextVerticalType Aspose::Slides::TextFrameFormat::get_InheritedTextVerticalType ( )
protected

◆ get_MarginBottom()

double Aspose::Slides::TextFrameFormat::get_MarginBottom ( )
virtual

Returns the bottom margin (points) in a TextFrame. Read double.

Implements Aspose::Slides::Charts::IChartTextBlockFormat.

◆ get_MarginLeft()

double Aspose::Slides::TextFrameFormat::get_MarginLeft ( )
virtual

Returns the left margin (points) in a TextFrame. Read double.

Implements Aspose::Slides::Charts::IChartTextBlockFormat.

◆ get_MarginRight()

double Aspose::Slides::TextFrameFormat::get_MarginRight ( )
virtual

Returns the right margin (points) in a TextFrame. Read double.

Implements Aspose::Slides::Charts::IChartTextBlockFormat.

◆ get_MarginTop()

double Aspose::Slides::TextFrameFormat::get_MarginTop ( )
virtual

Returns the top margin (points) in a TextFrame. Read double.

Implements Aspose::Slides::Charts::IChartTextBlockFormat.

◆ get_MetroBlobRequired()

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

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

◆ get_NormalAutofitFontScale()

float Aspose::Slides::TextFrameFormat::get_NormalAutofitFontScale ( )
protected

Specifies the percentage of the original font size to which each run in the text body is scaled. In order to auto-fit text within a bounding box it is sometimes necessary to decrease the font size by a certain percentage. Using this prorerty the font within a text box can be scaled based on the value provided. A value of "1" scales the text to 100%, while a value of "0.01" scales the text to 1%. Minimal value is 0.01. Maximum value is 1. This prorerty make sense only when TextFrameEx.AutofitType property value equal to TextAutofitType.Normal.

◆ get_NormalAutofitLineSpaceReduction()

float Aspose::Slides::TextFrameFormat::get_NormalAutofitLineSpaceReduction ( )
protected

Specifies the percentage amount by which the line spacing of each paragraph in the text body is reduced. The reduction is applied by subtracting it from the original line spacing value. Using this prorerty the vertical spacing between the lines of text can be scaled by a percent amount. A value of "1" reduces the line spacing by 100%, while a value of "0.01" reduces the line spacing by one percent. This prorerty applies only to paragraphs with percentage line spacing. This prorerty make sense only when TextFrameEx.AutofitType property value equal to TextAutofitType.Normal.

◆ get_PPTUnsupportedProps()

System::SharedPtr<UnsupportedProps::PPTUnsupportedProps::TextFrameFormatPPTUnsupportedProps> Aspose::Slides::TextFrameFormat::get_PPTUnsupportedProps ( )
protected

◆ get_PPTXUnsupportedProps()

System::SharedPtr<UnsupportedProps::PPTXUnsupportedProps::TextFrameFormatPPTXUnsupportedProps> Aspose::Slides::TextFrameFormat::get_PPTXUnsupportedProps ( )
protected

◆ get_RealObject()

System::SharedPtr<TextFrameFormatImpl> Aspose::Slides::TextFrameFormat::get_RealObject ( )
protected

◆ get_RemainUpright()

bool Aspose::Slides::TextFrameFormat::get_RemainUpright ( )
protected

Specifies whether text should remain upright, regardless of the transform applied to it and the accompanying shape transform.

◆ get_RightToLeftColumns()

NullableBool Aspose::Slides::TextFrameFormat::get_RightToLeftColumns ( )
protected

Specifies whether columns are used in a right-to-left or left-to-right order. The usage of this attribute only sets the column order that is used to determine which column overflow text should go to next. This attribute in no way determines the direction of text but merely the direction in which multiple columns are used.

◆ get_RotationAngle()

float Aspose::Slides::TextFrameFormat::get_RotationAngle ( )
virtual

Specifies custom the rotation that is being applied to the text within the bounding box. If it not specified, the rotation of the accompanying shape is used. If it is specified, then this is applied independently from the shape. That is the shape can have a rotation applied in addition to the text itself having a rotation applied to it. The resulted value of visual text rotation summarized from this property and predefined vertical type in property TextVerticalType. Read float.

Consider the case where a shape has a rotation of 90 degrees clockwise applied to it. In addition to this, the text body itself has a rotation of -90 degrees counter-clockwise applied to it. Then the resulting shape would appear to be rotated but the text within it would appear as though it had not been rotated at all.

Implements Aspose::Slides::Charts::IChartTextBlockFormat.

◆ get_TextHorizontalOverflowType()

Aspose::Slides::PptxSerialization::TextHorizontalOverflowType Aspose::Slides::TextFrameFormat::get_TextHorizontalOverflowType ( )
protected

Relates to attribute "CT_TextBodyProperties@horzOverflow" defined in "dml-text.xsd" schema file.

◆ get_TextPropertiesVersion()

System::SharedPtr<Aspose::Slides::Paragraph::TextPropertiesVersion> Aspose::Slides::TextFrameFormat::get_TextPropertiesVersion ( )
protected

◆ get_TextShape()

System::SharedPtr<UnsupportedProps::PPTXUnsupportedProps::PresetTextShape> Aspose::Slides::TextFrameFormat::get_TextShape ( )
protected

Relates to attribute "CT_TextBodyProperties@prstTxWarp" defined in "dml-text.xsd" schema file.

◆ get_TextStyle()

System::SharedPtr<ITextStyle> Aspose::Slides::TextFrameFormat::get_TextStyle ( )
virtual

Returns text's style. Read-only ITextStyle.

Implements Aspose::Slides::ITextFrameFormat.

◆ get_TextStyleInternal()

System::SharedPtr<Aspose::Slides::TextStyle> Aspose::Slides::TextFrameFormat::get_TextStyleInternal ( )
protected

◆ get_TextVerticalOverflowType()

Aspose::Slides::TextVerticalOverflowType Aspose::Slides::TextFrameFormat::get_TextVerticalOverflowType ( )
protected

Determines whether the text can flow out of the bounding box vertically. This is used to determine what happens in the event that the text within a shape is too large for the bounding box it is contained within.

◆ get_TextVerticalType()

Aspose::Slides::TextVerticalType Aspose::Slides::TextFrameFormat::get_TextVerticalType ( )
virtual

Determines text orientation. The resulted value of visual text rotation summarized from this property and custom angle in property RotationAngle. Read Slides::TextVerticalType.

Implements Aspose::Slides::Charts::IChartTextBlockFormat.

◆ get_Version_OldMode()

uint32_t Aspose::Slides::TextFrameFormat::get_Version_OldMode ( )
protected

◆ get_WrapText()

NullableBool Aspose::Slides::TextFrameFormat::get_WrapText ( )
virtual

True if text is wrapped at TextFrame's margins. Read NullableBool.

Implements Aspose::Slides::Charts::IChartTextBlockFormat.

◆ GetEffective()

System::SharedPtr<ITextFrameFormatEffectiveData> Aspose::Slides::TextFrameFormat::GetEffective ( )
virtual

Gets effective text frame formatting data with the inheritance applied.

Returns
A ITextFrameFormatEffectiveData.

This example demonstrates getting some of effective text frame formatting properties.

auto pres = MakeObject<Presentation>(u"MyPresentation.pptx");
auto shape = DynamicCast_noexcept<IAutoShape>(pres->get_Slides()->idx_get(0)->get_Shapes()->idx_get(0));
auto effectiveTextFrameFormat = shape->get_TextFrame()->get_TextFrameFormat()->GetEffective();
Console::WriteLine(String(u"Anchoring type: ") + ObjectExt::ToString(effectiveTextFrameFormat->get_AnchoringType()));
Console::WriteLine(String(u"Autofit type: ") + ObjectExt::ToString(effectiveTextFrameFormat->get_AutofitType()));
Console::WriteLine(String(u"Text vertical type: ") + ObjectExt::ToString(effectiveTextFrameFormat->get_TextVerticalType()));
Console::WriteLine(u"Margins");
Console::WriteLine(String(u" Left: ") + effectiveTextFrameFormat->get_MarginLeft());
Console::WriteLine(String(u" Top: ") + effectiveTextFrameFormat->get_MarginTop());
Console::WriteLine(String(u" Right: ") + effectiveTextFrameFormat->get_MarginRight());
Console::WriteLine(String(u" Bottom: ") + effectiveTextFrameFormat->get_MarginBottom());

Implements Aspose::Slides::ITextFrameFormat.

◆ GetEffectiveInternal()

System::SharedPtr<TextFrameFormatEffectiveData> Aspose::Slides::TextFrameFormat::GetEffectiveInternal ( )
protected

◆ NeedToScaleSize()

bool Aspose::Slides::TextFrameFormat::NeedToScaleSize ( System::ArrayPtr< System::SharedPtr< ITextFrameFormat >>  parentFormats)
protected

◆ Reset()

void Aspose::Slides::TextFrameFormat::Reset ( )
protected

Sets all properties to NotDefined state.

◆ ScaleSizes()

void Aspose::Slides::TextFrameFormat::ScaleSizes ( float  dt)
protected

◆ set_AnchoringType()

void Aspose::Slides::TextFrameFormat::set_AnchoringType ( TextAnchorType  value)
virtual

Sets vertical anchor text in a TextFrameEx. Write TextAnchorType.

Implements Aspose::Slides::Charts::IChartTextBlockFormat.

◆ set_AutofitType()

void Aspose::Slides::TextFrameFormat::set_AutofitType ( TextAutofitType  value)
virtual

Sets text's autofit mode. Write TextAutofitType.

Implements Aspose::Slides::Charts::IChartTextBlockFormat.

◆ set_AutofitTypeInternal()

void Aspose::Slides::TextFrameFormat::set_AutofitTypeInternal ( TextAutofitType  value)
protected

Sets text autofit mode without "changed" flag updating. This property must be used for deserialization when it is not necessary to call text relayouting.

◆ set_CenterText()

void Aspose::Slides::TextFrameFormat::set_CenterText ( NullableBool  value)
virtual

If NullableBool.True then text should be centered in box horizontally. Write NullableBool.

Implements Aspose::Slides::Charts::IChartTextBlockFormat.

◆ set_ColumnCount()

void Aspose::Slides::TextFrameFormat::set_ColumnCount ( int32_t  value)
virtual

Sets number of columns in the text area. This value must be a positive number. Otherwise, the value will be set to zero. Value 0 means undefined value. Write int32_t.

Implements Aspose::Slides::ITextFrameFormat.

◆ set_ColumnSpacing()

void Aspose::Slides::TextFrameFormat::set_ColumnSpacing ( double  value)
virtual

Sets the space between text columns in the text area (in points). This should only apply when there is more than 1 column present. This value must be a positive number. Otherwise, the value will be set to zero. Write double.

Implements Aspose::Slides::ITextFrameFormat.

◆ set_CompatibleLineSpacing()

void Aspose::Slides::TextFrameFormat::set_CompatibleLineSpacing ( NullableBool  value)
protected

Specifies that the line spacing for this text body is decided in a simplistic manner using the font scene.

◆ set_FirstLastParagraphSpacing()

void Aspose::Slides::TextFrameFormat::set_FirstLastParagraphSpacing ( NullableBool  value)
protected

Specifies whether the before and after paragraph spacing defined by the user is to be respected. While the spacing between paragraphs is helpful, it is additionally useful to be able to set a flag as to whether this spacing is to be followed at the edges of the text body, in other words the first and last paragraphs in the text body. More precisely since this is a text body level property it should only effect the before paragraph spacing of the first paragraph and the after paragraph spacing of the last paragraph for a given text body.

◆ set_ForceAntiAliased()

void Aspose::Slides::TextFrameFormat::set_ForceAntiAliased ( NullableBool  value)
protected

Forces the text to be rendered anti-aliased regardless of the font size. Certain fonts can appear grainy around their edges unless they are anti-aliased. Therefore this attribute allows for the specifying of which bodies of text should always be anti-aliased and which ones should not.

◆ set_FromWordArt()

void Aspose::Slides::TextFrameFormat::set_FromWordArt ( NullableBool  value)
protected

Specifies that text within this textbox is converted text from a WordArt object. This is more of a backwards compatibility attribute that is useful to the application from a tracking perspective. WordArt was the former way to apply text effects and therefore this attribute is useful in document conversion scenarios.

◆ set_MarginBottom()

void Aspose::Slides::TextFrameFormat::set_MarginBottom ( double  value)
virtual

Sets the bottom margin (points) in a TextFrame. Write double.

Implements Aspose::Slides::Charts::IChartTextBlockFormat.

◆ set_MarginLeft()

void Aspose::Slides::TextFrameFormat::set_MarginLeft ( double  value)
virtual

Sets the left margin (points) in a TextFrame. Write double.

Implements Aspose::Slides::Charts::IChartTextBlockFormat.

◆ set_MarginRight()

void Aspose::Slides::TextFrameFormat::set_MarginRight ( double  value)
virtual

Sets the right margin (points) in a TextFrame. Write double.

Implements Aspose::Slides::Charts::IChartTextBlockFormat.

◆ set_MarginTop()

void Aspose::Slides::TextFrameFormat::set_MarginTop ( double  value)
virtual

Sets the top margin (points) in a TextFrame. Write double.

Implements Aspose::Slides::Charts::IChartTextBlockFormat.

◆ set_NormalAutofitFontScale()

void Aspose::Slides::TextFrameFormat::set_NormalAutofitFontScale ( float  value)
protected

Specifies the percentage of the original font size to which each run in the text body is scaled. In order to auto-fit text within a bounding box it is sometimes necessary to decrease the font size by a certain percentage. Using this prorerty the font within a text box can be scaled based on the value provided. A value of "1" scales the text to 100%, while a value of "0.01" scales the text to 1%. Minimal value is 0.01. Maximum value is 1. This prorerty make sense only when TextFrameEx.AutofitType property value equal to TextAutofitType.Normal.

◆ set_NormalAutofitLineSpaceReduction()

void Aspose::Slides::TextFrameFormat::set_NormalAutofitLineSpaceReduction ( float  value)
protected

Specifies the percentage amount by which the line spacing of each paragraph in the text body is reduced. The reduction is applied by subtracting it from the original line spacing value. Using this prorerty the vertical spacing between the lines of text can be scaled by a percent amount. A value of "1" reduces the line spacing by 100%, while a value of "0.01" reduces the line spacing by one percent. This prorerty applies only to paragraphs with percentage line spacing. This prorerty make sense only when TextFrameEx.AutofitType property value equal to TextAutofitType.Normal.

◆ set_RemainUpright()

void Aspose::Slides::TextFrameFormat::set_RemainUpright ( bool  value)
protected

Specifies whether text should remain upright, regardless of the transform applied to it and the accompanying shape transform.

◆ set_RightToLeftColumns()

void Aspose::Slides::TextFrameFormat::set_RightToLeftColumns ( NullableBool  value)
protected

Specifies whether columns are used in a right-to-left or left-to-right order. The usage of this attribute only sets the column order that is used to determine which column overflow text should go to next. This attribute in no way determines the direction of text but merely the direction in which multiple columns are used.

◆ set_RotationAngle()

void Aspose::Slides::TextFrameFormat::set_RotationAngle ( float  value)
virtual

Specifies custom the rotation that is being applied to the text within the bounding box. If it not specified, the rotation of the accompanying shape is used. If it is specified, then this is applied independently from the shape. That is the shape can have a rotation applied in addition to the text itself having a rotation applied to it. The resulted value of visual text rotation summarized from this property and predefined vertical type in property TextVerticalType. Write float.

Consider the case where a shape has a rotation of 90 degrees clockwise applied to it. In addition to this, the text body itself has a rotation of -90 degrees counter-clockwise applied to it. Then the resulting shape would appear to be rotated but the text within it would appear as though it had not been rotated at all.

Implements Aspose::Slides::Charts::IChartTextBlockFormat.

◆ set_TextHorizontalOverflowType()

void Aspose::Slides::TextFrameFormat::set_TextHorizontalOverflowType ( Aspose::Slides::PptxSerialization::TextHorizontalOverflowType  value)
protected

Relates to attribute "CT_TextBodyProperties@horzOverflow" defined in "dml-text.xsd" schema file.

◆ set_TextVerticalOverflowType()

void Aspose::Slides::TextFrameFormat::set_TextVerticalOverflowType ( Aspose::Slides::TextVerticalOverflowType  value)
protected

Determines whether the text can flow out of the bounding box vertically. This is used to determine what happens in the event that the text within a shape is too large for the bounding box it is contained within.

◆ set_TextVerticalType()

void Aspose::Slides::TextFrameFormat::set_TextVerticalType ( Aspose::Slides::TextVerticalType  value)
virtual

Determines text orientation. The resulted value of visual text rotation summarized from this property and custom angle in property RotationAngle. Write Slides::TextVerticalType.

Implements Aspose::Slides::Charts::IChartTextBlockFormat.

◆ set_WrapText()

void Aspose::Slides::TextFrameFormat::set_WrapText ( NullableBool  value)
virtual

True if text is wrapped at TextFrame's margins. Write NullableBool.

Implements Aspose::Slides::Charts::IChartTextBlockFormat.