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

Inherited by Aspose::Slides::TextFrameFormat.

Public Member Functions
virtual System::SharedPtr< ITextStyle >	get_TextStyle ()=0
	Returns text's style. Read-only ITextStyle. More...

virtual double	get_MarginLeft ()=0
	Returns the left margin (points) in a TextFrame. Read double. More...

virtual void	set_MarginLeft (double value)=0
	Sets the left margin (points) in a TextFrame. Write double. More...

virtual double	get_MarginRight ()=0
	Returns the right margin (points) in a TextFrame. Read double. More...

virtual void	set_MarginRight (double value)=0
	Sets the right margin (points) in a TextFrame. Write double. More...

virtual double	get_MarginTop ()=0
	Returns the top margin (points) in a TextFrame. Read double. More...

virtual void	set_MarginTop (double value)=0
	Sets the top margin (points) in a TextFrame. Write double. More...

virtual double	get_MarginBottom ()=0
	Returns the bottom margin (points) in a TextFrame. Read double. More...

virtual void	set_MarginBottom (double value)=0
	Sets the bottom margin (points) in a TextFrame. Write double. More...

virtual NullableBool	get_WrapText ()=0
	True if text is wrapped at TextFrame's margins. Read NullableBool. More...

virtual void	set_WrapText (NullableBool value)=0
	True if text is wrapped at TextFrame's margins. Write NullableBool. More...

virtual TextAnchorType	get_AnchoringType ()=0
	Returns vertical anchor text in a TextFrame. Read TextAnchorType. More...

virtual void	set_AnchoringType (TextAnchorType value)=0
	Sets vertical anchor text in a TextFrame. Write TextAnchorType. More...

virtual NullableBool	get_CenterText ()=0
	If NullableBool::True then text should be centered in box horizontally. Read NullableBool. More...

virtual void	set_CenterText (NullableBool value)=0
	If NullableBool::True then text should be centered in box horizontally. Write NullableBool. More...

virtual Aspose::Slides::TextVerticalType	get_TextVerticalType ()=0
	Determines text orientation. The resulted value of visual text rotation summarized from this property and custom angle in property RotationAngle. Read Slides::TextVerticalType. More...

virtual void	set_TextVerticalType (Aspose::Slides::TextVerticalType value)=0
	Determines text orientation. The resulted value of visual text rotation summarized from this property and custom angle in property RotationAngle. Write Slides::TextVerticalType. More...

virtual TextAutofitType	get_AutofitType ()=0
	Returns text's autofit mode. Read TextAutofitType. More...

virtual void	set_AutofitType (TextAutofitType value)=0
	Sets text's autofit mode. Write TextAutofitType. More...

virtual int32_t	get_ColumnCount ()=0
	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...

virtual void	set_ColumnCount (int32_t value)=0
	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...

virtual double	get_ColumnSpacing ()=0
	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...

virtual void	set_ColumnSpacing (double value)=0
	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...

virtual System::SharedPtr< IThreeDFormat >	get_ThreeDFormat ()=0
	Returns the ThreeDFormat object that represents 3d effect properties for a text. Read-only IThreeDFormat. More...

virtual bool	get_KeepTextFlat ()=0
	Returns or set keeping text out of 3D scene entirely. Read bool. More...

virtual void	set_KeepTextFlat (bool value)=0
	Returns or set keeping text out of 3D scene entirely. Write bool. More...

virtual float	get_RotationAngle ()=0
	Specifies the custom 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...

virtual void	set_RotationAngle (float value)=0
	Specifies the custom 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...

virtual TextShapeType	get_Transform ()=0
	Gets text wrapping shape. Read TextShapeType. More...

virtual void	set_Transform (TextShapeType value)=0
	Sets text wrapping shape. Write TextShapeType. More...

virtual System::SharedPtr< ITextFrameFormatEffectiveData >	GetEffective ()=0
	Gets effective text frame formatting data with the inheritance applied. 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...

Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object *	SharedRefAdded ()
	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 TypeInfo &	GetType () 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< Object >	ptr
	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 TypeInfo &	Type ()
	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

Contains the TextFrame's formatting properties.

Member Function Documentation

◆ get_AnchoringType()

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

pure virtual

Returns vertical anchor text in a TextFrame. Read TextAnchorType.

Implemented in Aspose::Slides::TextFrameFormat.

◆ get_AutofitType()

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

pure virtual

Returns text's autofit mode. Read TextAutofitType.

Implemented in Aspose::Slides::TextFrameFormat.

◆ get_CenterText()

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

pure virtual

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

Implemented in Aspose::Slides::TextFrameFormat.

◆ get_ColumnCount()

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

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

Implemented in Aspose::Slides::TextFrameFormat.

◆ get_ColumnSpacing()

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

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

Implemented in Aspose::Slides::TextFrameFormat.

◆ get_KeepTextFlat()

virtual bool Aspose::Slides::ITextFrameFormat::get_KeepTextFlat ( )

pure virtual

Returns or set keeping text out of 3D scene entirely. Read bool.

Implemented in Aspose::Slides::TextFrameFormat.

◆ get_MarginBottom()

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

pure virtual

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

Implemented in Aspose::Slides::TextFrameFormat.

◆ get_MarginLeft()

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

pure virtual

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

Implemented in Aspose::Slides::TextFrameFormat.

◆ get_MarginRight()

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

pure virtual

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

Implemented in Aspose::Slides::TextFrameFormat.

◆ get_MarginTop()

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

pure virtual

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

Implemented in Aspose::Slides::TextFrameFormat.

◆ get_RotationAngle()

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

pure virtual

Specifies the custom 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.

Implemented in Aspose::Slides::TextFrameFormat.

◆ get_TextStyle()

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

pure virtual

Returns text's style. Read-only ITextStyle.

◆ get_TextVerticalType()

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

pure virtual

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

Implemented in Aspose::Slides::TextFrameFormat.

◆ get_ThreeDFormat()

virtual System::SharedPtr<IThreeDFormat> Aspose::Slides::ITextFrameFormat::get_ThreeDFormat ( )

pure virtual

Returns the ThreeDFormat object that represents 3d effect properties for a text. Read-only IThreeDFormat.

using namespace Aspose::Slides;
 
auto pres = System::MakeObject<Presentation>();
auto autoShape = pres->get_Slides()->idx_get(0)->get_Shapes()->AddAutoShape(ShapeType::Rectangle, 10.0f, 20.0f, 400.0f, 300.0f);
auto textFrame = autoShape->get_TextFrame();
 
textFrame->set_Text(u"Aspose.Slide Test Text");
 
// Set text transformation
textFrame->get_TextFrameFormat()->set_Transform(TextShapeType::ArchUpPour);
 
// Set Extrusion
textFrame->get_TextFrameFormat()->get_ThreeDFormat()->get_ExtrusionColor()->set_Color(System::Drawing::Color::get_Orange());
textFrame->get_TextFrameFormat()->get_ThreeDFormat()->set_ExtrusionHeight(6);
 
// Set Contour
textFrame->get_TextFrameFormat()->get_ThreeDFormat()->get_ContourColor()->set_Color(System::Drawing::Color::get_DarkRed());
textFrame->get_TextFrameFormat()->get_ThreeDFormat()->set_ContourWidth(1.5);
 
// Set Depth
textFrame->get_TextFrameFormat()->get_ThreeDFormat()->set_Depth(3);
 
// Set Material
textFrame->get_TextFrameFormat()->get_ThreeDFormat()->set_Material(MaterialPresetType::Plastic);
 
// Set Lighting
textFrame->get_TextFrameFormat()->get_ThreeDFormat()->get_LightRig()->set_Direction(LightingDirection::Top);
textFrame->get_TextFrameFormat()->get_ThreeDFormat()->get_LightRig()->set_LightType(LightRigPresetType::Balanced);
textFrame->get_TextFrameFormat()->get_ThreeDFormat()->get_LightRig()->SetRotation(0.0f, 0.0f, 40.0f);
 
// Set camera type
textFrame->get_TextFrameFormat()->get_ThreeDFormat()->get_Camera()->set_CameraType(CameraPresetType::PerspectiveContrastingRightFacing);

Implemented in Aspose::Slides::TextFrameFormat.

◆ get_Transform()

virtual TextShapeType Aspose::Slides::ITextFrameFormat::get_Transform ( )

pure virtual

Gets text wrapping shape. Read TextShapeType.

Implemented in Aspose::Slides::TextFrameFormat.

◆ get_WrapText()

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

pure virtual

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

Implemented in Aspose::Slides::TextFrameFormat.

◆ GetEffective()

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

pure virtual

Gets effective text frame formatting data with the inheritance applied.

Returns: A ITextFrameFormatEffectiveData.

Implemented in Aspose::Slides::TextFrameFormat.

◆ set_AnchoringType()

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

pure virtual

Sets vertical anchor text in a TextFrame. Write TextAnchorType.

Implemented in Aspose::Slides::TextFrameFormat.

◆ set_AutofitType()

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

pure virtual

Sets text's autofit mode. Write TextAutofitType.

Implemented in Aspose::Slides::TextFrameFormat.

◆ set_CenterText()

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

pure virtual

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

Implemented in Aspose::Slides::TextFrameFormat.

◆ set_ColumnCount()

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

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

Implemented in Aspose::Slides::TextFrameFormat.

◆ set_ColumnSpacing()

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

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

Implemented in Aspose::Slides::TextFrameFormat.

◆ set_KeepTextFlat()

virtual void Aspose::Slides::ITextFrameFormat::set_KeepTextFlat ( bool value )

pure virtual

Returns or set keeping text out of 3D scene entirely. Write bool.

Implemented in Aspose::Slides::TextFrameFormat.

◆ set_MarginBottom()

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

pure virtual

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

Implemented in Aspose::Slides::TextFrameFormat.

◆ set_MarginLeft()

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

pure virtual

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

Implemented in Aspose::Slides::TextFrameFormat.

◆ set_MarginRight()

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

pure virtual

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

Implemented in Aspose::Slides::TextFrameFormat.

◆ set_MarginTop()

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

pure virtual

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

Implemented in Aspose::Slides::TextFrameFormat.

◆ set_RotationAngle()

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

pure virtual

Specifies the custom 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.

Implemented in Aspose::Slides::TextFrameFormat.

◆ set_TextVerticalType()

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

pure virtual

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

Implemented in Aspose::Slides::TextFrameFormat.

◆ set_Transform()

virtual void Aspose::Slides::ITextFrameFormat::set_Transform ( TextShapeType value )

pure virtual

Sets text wrapping shape. Write TextShapeType.

Implemented in Aspose::Slides::TextFrameFormat.

◆ set_WrapText()

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

pure virtual

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

Implemented in Aspose::Slides::TextFrameFormat.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ get_AnchoringType()

◆ get_AutofitType()

◆ get_CenterText()

◆ get_ColumnCount()

◆ get_ColumnSpacing()

◆ get_KeepTextFlat()

◆ get_MarginBottom()

◆ get_MarginLeft()

◆ get_MarginRight()

◆ get_MarginTop()

◆ get_RotationAngle()

◆ get_TextStyle()

◆ get_TextVerticalType()

◆ get_ThreeDFormat()

◆ get_Transform()

◆ get_WrapText()

◆ GetEffective()

◆ set_AnchoringType()

◆ set_AutofitType()

◆ set_CenterText()

◆ set_ColumnCount()

◆ set_ColumnSpacing()

◆ set_KeepTextFlat()

◆ set_MarginBottom()

◆ set_MarginLeft()

◆ set_MarginRight()

◆ set_MarginTop()

◆ set_RotationAngle()

◆ set_TextVerticalType()

◆ set_Transform()

◆ set_WrapText()