This class contains the text portion formatting properties. Unlike IPortionFormatEffectiveData, all properties of this class are writeable. More...

Inherits Aspose::Slides::BasePortionFormat, and Aspose::Slides::IPortionFormat.

Public Member Functions
System::String	get_BookmarkId () override
	Returns bookmark identifier. Read System::String. More...

void	set_BookmarkId (System::String value) override
	Sets bookmark identifier. Write System::String. More...

bool	get_SmartTagClean () override
	Determines whether the smart tag should be cleaned. No inheritance applied. Read bool. More...

void	set_SmartTagClean (bool value) override
	Determines whether the smart tag should be cleaned. No inheritance applied. Write bool. More...

System::SharedPtr< IHyperlink >	get_HyperlinkClick () override
	Returns the hyperlink defined for mouse click. Read IHyperlink. More...

void	set_HyperlinkClick (System::SharedPtr< IHyperlink > value) override
	Sets the hyperlink defined for mouse click. Write IHyperlink. More...

System::SharedPtr< IHyperlink >	get_HyperlinkMouseOver () override
	Returns the hyperlink defined for mouse over. Read IHyperlink. More...

void	set_HyperlinkMouseOver (System::SharedPtr< IHyperlink > value) override
	Sets the hyperlink defined for mouse over. Write IHyperlink. More...

System::SharedPtr< IHyperlinkManager >	get_HyperlinkManager () override
	Hyperlinks manager. Read-only IHyperlinkManager. More...

	PortionFormat ()
	Initializes a new instance of PortionFormat class. More...

System::SharedPtr< IPortionFormatEffectiveData >	GetEffective () override
	Gets effective portion formatting data with the inheritance applied. More...

Public Member Functions inherited from Aspose::Slides::BasePortionFormat
System::SharedPtr< ILineFormat >	get_LineFormat () override
	Returns the LineFormat properties for text outlining. No inheritance applied. Read-only ILineFormat. More...

System::SharedPtr< IFillFormat >	get_FillFormat () override
	Returns the text FillFormat properties. No inheritance applied. Read-only IFillFormat. More...

System::SharedPtr< IEffectFormat >	get_EffectFormat () override
	Returns the text EffectFormat properties. No inheritance applied. Read-only IEffectFormat. More...

System::SharedPtr< IColorFormat >	get_HighlightColor () override
	Returns the color used to highlight a text. No inheritance applied. Read-only IColorFormat. More...

System::SharedPtr< ILineFormat >	get_UnderlineLineFormat () override
	Returns the LineFormat properties used to outline underline line. No inheritance applied. Read-only ILineFormat. More...

System::SharedPtr< IFillFormat >	get_UnderlineFillFormat () override
	Returns the underline line FillFormat properties. No inheritance applied. Read-only IFillFormat. More...

NullableBool	get_FontBold () override
	Determines whether the font is bold. No inheritance applied. Read NullableBool. More...

void	set_FontBold (NullableBool value) override
	Determines whether the font is bold. No inheritance applied. Write NullableBool. More...

NullableBool	get_FontItalic () override
	Determines whether the font is itallic. No inheritance applied. Read NullableBool. More...

void	set_FontItalic (NullableBool value) override
	Determines whether the font is itallic. No inheritance applied. Write NullableBool. More...

NullableBool	get_Kumimoji () override
	Determines whether the numbers should ignore text eastern language-specific vertical text layout. No inheritance applied. Read NullableBool. More...

void	set_Kumimoji (NullableBool value) override
	Determines whether the numbers should ignore text eastern language-specific vertical text layout. No inheritance applied. Write NullableBool. More...

NullableBool	get_NormaliseHeight () override
	Determines whether the height of a text should be normalized. No inheritance applied. Read NullableBool. More...

void	set_NormaliseHeight (NullableBool value) override
	Determines whether the height of a text should be normalized. No inheritance applied. Write NullableBool. More...

NullableBool	get_ProofDisabled () override
	Determines whether the text shouldn't be proofed. No inheritance applied. Read NullableBool. More...

void	set_ProofDisabled (NullableBool value) override
	Determines whether the text shouldn't be proofed. No inheritance applied. Write NullableBool. More...

TextUnderlineType	get_FontUnderline () override
	Returns the text underline type. No inheritance applied. Read TextUnderlineType. More...

void	set_FontUnderline (TextUnderlineType value) override
	Sets the text underline type. No inheritance applied. Write TextUnderlineType. More...

Aspose::Slides::TextCapType	get_TextCapType () override
	Returns the type of text capitalization. No inheritance applied. Read Slides::TextCapType. More...

void	set_TextCapType (Aspose::Slides::TextCapType value) override
	Sets the type of text capitalization. No inheritance applied. Write Slides::TextCapType. More...

TextStrikethroughType	get_StrikethroughType () override
	Returns the strikethrough type of a text. No inheritance applied. Read TextStrikethroughType. More...

void	set_StrikethroughType (TextStrikethroughType value) override
	Sets the strikethrough type of a text. No inheritance applied. Write TextStrikethroughType. More...

NullableBool	get_IsHardUnderlineLine () override
	Determines whether the underline style has own LineFormat properties or inherits it from the LineFormat properties of the text. Read NullableBool. More...

void	set_IsHardUnderlineLine (NullableBool value) override
	Determines whether the underline style has own LineFormat properties or inherits it from the LineFormat properties of the text. Write NullableBool. More...

NullableBool	get_IsHardUnderlineFill () override
	Determines whether the underline style has own FillFormat properties or inherits it from the FillFormat properties of the text. Read NullableBool. More...

void	set_IsHardUnderlineFill (NullableBool value) override
	Determines whether the underline style has own FillFormat properties or inherits it from the FillFormat properties of the text. Write NullableBool. More...

float	get_FontHeight () override
	Returns the font height of a portion. std::numeric_limits<float>::quiet_NaN() means height is undefined and should be inherited from the Master. Read float. More...

void	set_FontHeight (float value) override
	Sets the font height of a portion. std::numeric_limits<float>::quiet_NaN() means height is undefined and should be inherited from the Master. Write float. More...

System::SharedPtr< IFontData >	get_LatinFont () override
	Returns the Latin font info. Null means font is undefined and should be inherited from the Master. Read IFontData. More...

void	set_LatinFont (System::SharedPtr< IFontData > value) override
	Sets the Latin font info. Null means font is undefined and should be inherited from the Master. Write IFontData. More...

System::SharedPtr< IFontData >	get_EastAsianFont () override
	Returns the East Asian font info. Null means font is undefined and should be inherited from the Master. Read IFontData. More...

void	set_EastAsianFont (System::SharedPtr< IFontData > value) override
	Sets the East Asian font info. Null means font is undefined and should be inherited from the Master. Write IFontData. More...

System::SharedPtr< IFontData >	get_ComplexScriptFont () override
	Returns the complex script font info. Null means font is undefined and should be inherited from the Master. Read IFontData. More...

void	set_ComplexScriptFont (System::SharedPtr< IFontData > value) override
	Sets the complex script font info. Null means font is undefined and should be inherited from the Master. Write IFontData. More...

System::SharedPtr< IFontData >	get_SymbolFont () override
	Returns the symbolic font info. Null means font is undefined and should be inherited from the Master. Read IFontData. More...

void	set_SymbolFont (System::SharedPtr< IFontData > value) override
	Sets the symbolic font info. Null means font is undefined and should be inherited from the Master. Write IFontData. More...

float	get_Escapement () override
	Returns the superscript or subscript text. Value from -100% (subscript) to 100% (superscript). std::numeric_limits<float>::quiet_NaN() means value is undefined and should be inherited from the Master. Read float. More...

void	set_Escapement (float value) override
	Sets the superscript or subscript text. Value from -100% (subscript) to 100% (superscript). std::numeric_limits<float>::quiet_NaN() means value is undefined and should be inherited from the Master. Write float. More...

float	get_KerningMinimalSize () override
	Returns the minimal font size, for which kerning should be switched on. std::numeric_limits<float>::quiet_NaN() means value is undefined and should be inherited from the Master. Read float. More...

void	set_KerningMinimalSize (float value) override
	Sets the minimal font size, for which kerning should be switched on. std::numeric_limits<float>::quiet_NaN() means value is undefined and should be inherited from the Master. Write float. More...

System::String	get_LanguageId () override
	Returns the Id of a proofing language. Used for checking spelling and grammar. Read System::String. More...

void	set_LanguageId (System::String value) override
	Sets the Id of a proofing language. Used for checking spelling and grammar. Write System::String. More...

System::String	get_AlternativeLanguageId () override
	Returns the Id of an alternative language. Read System::String. More...

void	set_AlternativeLanguageId (System::String value) override
	Sets the Id of an alternative language. Write System::String. More...

float	get_Spacing () override
	Returns the intercharacter spacing increment. std::numeric_limits<float>::quiet_NaN() means value is undefined and should be inherited from the Master. Read float. More...

void	set_Spacing (float value) override
	Sets the intercharacter spacing increment. std::numeric_limits<float>::quiet_NaN() means value is undefined and should be inherited from the Master. Write float. More...

Public Member Functions inherited from Aspose::Slides::PVIObject
bool	Equals (System::SharedPtr< System::Object > obj) override
	Compares with specified object. More...

int32_t	GetHashCode () const override
	Returns hash code. More...

System::String	ToString () const override
	Returns string representation. More...

Public Member Functions inherited from Aspose::Slides::IPVIObject
virtual System::SharedPtr< IPresentationComponent >	get_Parent_IPresentationComponent ()=0
	Returns parent IPresentationComponent. Read-only IPresentationComponent. More...

virtual uint32_t	get_Version ()=0
	Version. Read-only uint32_t. More...

Public Member Functions inherited from Aspose::Slides::IDOMObject
virtual System::SharedPtr< IDOMObject >	get_Parent_Immediate ()=0
	Returns Parent_Immediate object. Read-only IDOMObject. More...

virtual System::String	get_DOMPath ()=0
	Returns DOM path. Read-only System::String. 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 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...

Protected Member Functions
void	CreateChildObjects () override

System::SharedPtr< System::Object >	CreateRealObject () override

virtual	~PortionFormat ()

Protected Member Functions inherited from Aspose::Slides::BasePortionFormat
void	CreateChildObjects () override

virtual	~BasePortionFormat ()

Protected Member Functions inherited from Aspose::Slides::PVIObject
virtual	~PVIObject ()

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

This class contains the text portion formatting properties. Unlike IPortionFormatEffectiveData, all properties of this class are writeable.

This class is used to return and manipulate text portion formatting properties defined for the particular portion. This means that no inheritance is applied when getting values so for the majority of cases you will get values meaning "undefined".

In order to get the effective formatting parameter values including inherited you need to use PortionFormat::GetEffective method which returns a IPortionFormatEffectiveData instance.

Constructor & Destructor Documentation

◆ PortionFormat()

Aspose::Slides::PortionFormat::PortionFormat ( )

Initializes a new instance of PortionFormat class.

◆ ~PortionFormat()

virtual Aspose::Slides::PortionFormat::~PortionFormat ( )

protectedvirtual

Member Function Documentation

◆ CreateChildObjects()

void Aspose::Slides::PortionFormat::CreateChildObjects ( )

overrideprotected

◆ CreateRealObject()

System::SharedPtr<System::Object> Aspose::Slides::PortionFormat::CreateRealObject ( )

overrideprotected

◆ get_BookmarkId()

System::String Aspose::Slides::PortionFormat::get_BookmarkId ( )

overridevirtual

Returns bookmark identifier. Read System::String.

Implements Aspose::Slides::IPortionFormat.

◆ get_HyperlinkClick()

System::SharedPtr<IHyperlink> Aspose::Slides::PortionFormat::get_HyperlinkClick ( )

overridevirtual

Returns the hyperlink defined for mouse click. Read IHyperlink.

Implements Aspose::Slides::IHyperlinkContainer.

◆ get_HyperlinkManager()

System::SharedPtr<IHyperlinkManager> Aspose::Slides::PortionFormat::get_HyperlinkManager ( )

overridevirtual

Hyperlinks manager. Read-only IHyperlinkManager.

Implements Aspose::Slides::IHyperlinkContainer.

◆ get_HyperlinkMouseOver()

System::SharedPtr<IHyperlink> Aspose::Slides::PortionFormat::get_HyperlinkMouseOver ( )

overridevirtual

Returns the hyperlink defined for mouse over. Read IHyperlink.

Implements Aspose::Slides::IHyperlinkContainer.

◆ get_SmartTagClean()

bool Aspose::Slides::PortionFormat::get_SmartTagClean ( )

overridevirtual

Determines whether the smart tag should be cleaned. No inheritance applied. Read bool.

Implements Aspose::Slides::IPortionFormat.

◆ GetEffective()

System::SharedPtr<IPortionFormatEffectiveData> Aspose::Slides::PortionFormat::GetEffective ( )

overridevirtual

Gets effective portion formatting data with the inheritance applied.

Returns: A IPortionFormatEffectiveData.

This example demonstrates getting some effective portion format 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 effectivePortionFormat = shape->get_TextFrame()->get_Paragraphs()->idx_get(0)->get_Portions()->idx_get(0)->get_PortionFormat()->GetEffective();
 
Console::WriteLine(String(u"Latin font: ") + effectivePortionFormat->get_LatinFont()->get_FontName());
Console::WriteLine(String(u"Font height: ") + effectivePortionFormat->get_FontHeight());
Console::WriteLine(String(u"Fill type: ") + ObjectExt::ToString(effectivePortionFormat->get_FillFormat()->get_FillType()));

Implements Aspose::Slides::IPortionFormat.

◆ set_BookmarkId()

void Aspose::Slides::PortionFormat::set_BookmarkId ( System::String value )

overridevirtual

Sets bookmark identifier. Write System::String.

Implements Aspose::Slides::IPortionFormat.

◆ set_HyperlinkClick()

void Aspose::Slides::PortionFormat::set_HyperlinkClick ( System::SharedPtr< IHyperlink > value )

overridevirtual

Sets the hyperlink defined for mouse click. Write IHyperlink.

Implements Aspose::Slides::IHyperlinkContainer.

◆ set_HyperlinkMouseOver()

void Aspose::Slides::PortionFormat::set_HyperlinkMouseOver ( System::SharedPtr< IHyperlink > value )

overridevirtual

Sets the hyperlink defined for mouse over. Write IHyperlink.

Implements Aspose::Slides::IHyperlinkContainer.

◆ set_SmartTagClean()

void Aspose::Slides::PortionFormat::set_SmartTagClean ( bool value )

overridevirtual

Determines whether the smart tag should be cleaned. No inheritance applied. Write bool.

Implements Aspose::Slides::IPortionFormat.

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PortionFormat()

◆ ~PortionFormat()

Member Function Documentation

◆ CreateChildObjects()

◆ CreateRealObject()

◆ get_BookmarkId()

◆ get_HyperlinkClick()

◆ get_HyperlinkManager()

◆ get_HyperlinkMouseOver()

◆ get_SmartTagClean()

◆ GetEffective()

◆ set_BookmarkId()

◆ set_HyperlinkClick()

◆ set_HyperlinkMouseOver()

◆ set_SmartTagClean()