IPortionFormat

IPortionFormat class

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

class IPortionFormat : public virtual Aspose::Slides::IBasePortionFormat,
                       public Aspose::Slides::IHyperlinkContainer

Methods

Method	Description
virtual bool Equals(ptr)	Compares objects using C# Object.Equals semantics.
static std::enable_if<IsSmartPtr<T1>::value&&IsSmartPtr<T2>::value, bool>::type Equals(T1 const&, T2 const&)	Compares reference type objects in C# style.
static std::enable_if<!IsSmartPtr<T1>::value&&!IsSmartPtr<T2>::value, bool>::type Equals(T1 const&, T2 const&)	Compares value type objects in C# style.
static bool Equals(float const&, float const&)	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.
static bool Equals(double const&, double const&)	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.
virtual bool FastCast(const Details::FastRttiBase&, void **) const	For internal purposes only.
virtual System::String get_AlternativeLanguageId()	Returns the Id of an alternative language. Read System::String.
virtual System::String get_BookmarkId()	Returns bookmark identifier. Read System::String.
virtual System::SharedPtr<IFontData> get_ComplexScriptFont()	Returns the complex script font info. Null means font is undefined and should be inherited from the Master. Read IFontData.
virtual System::SharedPtr<IFontData> get_EastAsianFont()	Returns the East Asian font info. Null means font is undefined and should be inherited from the Master. Read IFontData.
virtual System::SharedPtr<IEffectFormat> get_EffectFormat()	Returns the text EffectFormat properties. No inheritance applied. Read-only IEffectFormat.
virtual float get_Escapement()	Returns the superscript or subscript text. Value from -100% (subscript) to 100% (superscript). std::numeric_limits::quiet_NaN() means value is undefined and should be inherited from the Master. Read float.
virtual System::SharedPtr<IFillFormat> get_FillFormat()	Returns the text FillFormat properties. No inheritance applied. Read-only IFillFormat.
virtual NullableBool get_FontBold()	Determines whether the font is bold. No inheritance applied. Read NullableBool.
virtual float get_FontHeight()	Returns the font height of a portion. std::numeric_limits::quiet_NaN() means height is undefined and should be inherited from the Master. Read float.
virtual NullableBool get_FontItalic()	Determines whether the font is itallic. No inheritance applied. Read NullableBool.
virtual TextUnderlineType get_FontUnderline()	Returns the text underline type. No inheritance applied. Read TextUnderlineType.
virtual System::SharedPtr<IColorFormat> get_HighlightColor()	Returns the color used to highlight a text. No inheritance applied. Read-only IColorFormat.
virtual System::SharedPtr<IHyperlink> get_HyperlinkClick()	Returns the hyperlink defined for mouse click. Read IHyperlink.
virtual System::SharedPtr<IHyperlinkManager> get_HyperlinkManager()	Hyperlinks manager Read-only IHyperlinkManager.
virtual System::SharedPtr<IHyperlink> get_HyperlinkMouseOver()	Returns the hyperlink defined for mouse over. Read IHyperlink.
virtual NullableBool get_IsHardUnderlineFill()	Determines whether the underline style has own FillFormat properties or inherits it from the FillFormat properties of the text. Read NullableBool.
virtual NullableBool get_IsHardUnderlineLine()	Determines whether the underline style has own LineFormat properties or inherits it from the LineFormat properties of the text. Read NullableBool.
virtual float get_KerningMinimalSize()	Returns the minimal font size, for which kerning should be switched on. std::numeric_limits::quiet_NaN() means value is undefined and should be inherited from the Master. Read float.
virtual NullableBool get_Kumimoji()	Determines whether the numbers should ignore text eastern language-specific vertical text layout. No inheritance applied. Read NullableBool.
virtual System::String get_LanguageId()	Returns the Id of a proofing language. Used for checking spelling and grammar. Read System::String.
virtual System::SharedPtr<IFontData> get_LatinFont()	Returns the Latin font info. Null means font is undefined and should be inherited from the Master. Read IFontData.
virtual System::SharedPtr<ILineFormat> get_LineFormat()	Returns the LineFormat properties for text outlining. No inheritance applied. Read-only ILineFormat.
virtual NullableBool get_NormaliseHeight()	Determines whether the height of a text should be normalized. No inheritance applied. Read NullableBool.
virtual NullableBool get_ProofDisabled()	Determines whether the text shouldn’t be proofed. No inheritance applied. Read NullableBool.
virtual bool get_SmartTagClean()	Determines whether the smart tag should be cleaned. No inheritance applied. Read bool.
virtual float get_Spacing()	Returns the intercharacter spacing increment. std::numeric_limits::quiet_NaN() means value is undefined and should be inherited from the Master. Read float.
virtual TextStrikethroughType get_StrikethroughType()	Returns the strikethrough type of a text. No inheritance applied. Read TextStrikethroughType.
virtual System::SharedPtr<IFontData> get_SymbolFont()	Returns the symbolic font info. Null means font is undefined and should be inherited from the Master. Read IFontData.
virtual Aspose::Slides::TextCapType get_TextCapType()	Returns the type of text capitalization. No inheritance applied. Read Slides::TextCapType.
virtual System::SharedPtr<IFillFormat> get_UnderlineFillFormat()	Returns the underline line FillFormat properties. No inheritance applied. Read-only IFillFormat.
virtual System::SharedPtr<ILineFormat> get_UnderlineLineFormat()	Returns the LineFormat properties used to outline underline line. No inheritance applied. Read-only ILineFormat.
Detail::SmartPtrCounter * GetCounter()	Gets reference counter data structure associated with the object.
virtual System::SharedPtr<IPortionFormatEffectiveData> GetEffective()	Gets effective portion formatting data with the inheritance applied.
virtual int32_t GetHashCode() const	Analog of C# Object.GetHashCode() method. Enables hashing of custom objects.
virtual const TypeInfo& GetType() const	Gets actual type of object. Analog of C# System.Object.GetType() call.
virtual bool Is(const TypeInfo&) const	Check if object represents an instance of type described by targetType. Analog of C# ‘is’ operator.
void Lock()	Implements C# lock() statement locking. Call directly or use LockContext sentry object.
virtual ptr MemberwiseClone() const	Analog of C# Object.MemberwiseClone() method. Enables cloning custom types.
Object()	Creates object. Initializes all internal data structures.
Object(Object const&)	Copy constructor. Doesn’t copy anything, really, just initializes new object and enables copy constructing subclasses.
Object& operator=(Object const&)	Assignment operator. Doesn’t copy anything, really, just initializes new object and enables copy constructing subclasses.
static bool ReferenceEquals(ptr const&, ptr const&)	Compares objects by reference.
static std::enable_if<!IsSmartPtr<T>::value, bool>::type ReferenceEquals(T const&, T const&)	Compares objects by reference.
static std::enable_if<!IsSmartPtr<T>::value, bool>::type ReferenceEquals(T const&, std::nullptr_t)	Reference-compares value type object with nullptr.
bool ReferenceEquals(String const&, std::nullptr_t)	Specialization of Object::ReferenceEquals for case of string and nullptr.
bool ReferenceEquals(String const&, String const&)	Specialization of Object::ReferenceEquals for case of strings.
int RemovedSharedRefs(int)	Decreases shared reference count by specified value.
virtual void set_AlternativeLanguageId(System::String)	Sets the Id of an alternative language. Write System::String.
virtual void set_BookmarkId(System::String)	Sets bookmark identifier. Write System::String.
virtual void set_ComplexScriptFont(System::SharedPtr<IFontData>)	Sets the complex script font info. Null means font is undefined and should be inherited from the Master. Write IFontData.
virtual void set_EastAsianFont(System::SharedPtr<IFontData>)	Sets the East Asian font info. Null means font is undefined and should be inherited from the Master. Write IFontData.
virtual void set_Escapement(float)	Sets the superscript or subscript text. Value from -100% (subscript) to 100% (superscript). std::numeric_limits::quiet_NaN() means value is undefined and should be inherited from the Master. Write float.
virtual void set_FontBold(NullableBool)	Determines whether the font is bold. No inheritance applied. Write NullableBool.
virtual void set_FontHeight(float)	Sets the font height of a portion. std::numeric_limits::quiet_NaN() means height is undefined and should be inherited from the Master. Write float.
virtual void set_FontItalic(NullableBool)	Determines whether the font is itallic. No inheritance applied. Write NullableBool.
virtual void set_FontUnderline(TextUnderlineType)	Sets the text underline type. No inheritance applied. Write TextUnderlineType.
virtual void set_HyperlinkClick(System::SharedPtr<IHyperlink>)	Sets the hyperlink defined for mouse click. Write IHyperlink.
virtual void set_HyperlinkMouseOver(System::SharedPtr<IHyperlink>)	Sets the hyperlink defined for mouse over. Write IHyperlink.
virtual void set_IsHardUnderlineFill(NullableBool)	Determines whether the underline style has own FillFormat properties or inherits it from the FillFormat properties of the text. Write NullableBool.
virtual void set_IsHardUnderlineLine(NullableBool)	Determines whether the underline style has own LineFormat properties or inherits it from the LineFormat properties of the text. Write NullableBool.
virtual void set_KerningMinimalSize(float)	Sets the minimal font size, for which kerning should be switched on. std::numeric_limits::quiet_NaN() means value is undefined and should be inherited from the Master. Write float.
virtual void set_Kumimoji(NullableBool)	Determines whether the numbers should ignore text eastern language-specific vertical text layout. No inheritance applied. Write NullableBool.
virtual void set_LanguageId(System::String)	Sets the Id of a proofing language. Used for checking spelling and grammar. Write System::String.
virtual void set_LatinFont(System::SharedPtr<IFontData>)	Sets the Latin font info. Null means font is undefined and should be inherited from the Master. Write IFontData.
virtual void set_NormaliseHeight(NullableBool)	Determines whether the height of a text should be normalized. No inheritance applied. Write NullableBool.
virtual void set_ProofDisabled(NullableBool)	Determines whether the text shouldn’t be proofed. No inheritance applied. Write NullableBool.
virtual void set_SmartTagClean(bool)	Determines whether the smart tag should be cleaned. No inheritance applied. Write bool.
virtual void set_Spacing(float)	Sets the intercharacter spacing increment. std::numeric_limits::quiet_NaN() means value is undefined and should be inherited from the Master. Write float.
virtual void set_StrikethroughType(TextStrikethroughType)	Sets the strikethrough type of a text. No inheritance applied. Write TextStrikethroughType.
virtual void set_SymbolFont(System::SharedPtr<IFontData>)	Sets the symbolic font info. Null means font is undefined and should be inherited from the Master. Write IFontData.
virtual void set_TextCapType(Aspose::Slides::TextCapType)	Sets the type of text capitalization. No inheritance applied. Write Slides::TextCapType.
virtual void SetTemplateWeakPtr(uint32_t)	Set n’th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode.
int SharedCount() const	Gets current value of shared reference counter.
Object * SharedRefAdded()	Increments shared reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
int SharedRefRemovedSafe()	Decrements and returns shared reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
virtual String ToString() const	Analog of C# Object.ToString() method. Enables converting custom objects to string.
static const TypeInfo& Type()	Implements C# typeof(System.Object) construct.
void Unlock()	Implements C# lock() statement unlocking. Call directly or use LockContext sentry object.
Detail::SmartPtrCounter * WeakRefAdded()	Increments weak reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
void WeakRefRemoved()	Decrements weak reference count. Shouldn’t be called directly; instead, use smart pointers or ThisProtector.
virtual ~Object()	Destroys object. Frees all internal data structures.

Remarks

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 IPortionFormat::GetEffective method which returns a IPortionFormatEffectiveData instance.

See Also

• Class IBasePortionFormat
• Class IHyperlinkContainer
• Namespace Aspose::Slides
• Library Aspose.Slides