Aspose::Slides::IPortionFormat Class Referenceabstract

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

Inherits Aspose::Slides::IBasePortionFormat, and Aspose::Slides::IHyperlinkContainer.

Inherited by Aspose::Slides::PortionFormat.

Public Member Functions

virtual System::String get_BookmarkId ()=0
 Returns bookmark identifier. Read System::String. More...
 
virtual void set_BookmarkId (System::String value)=0
 Sets bookmark identifier. Write System::String. More...
 
virtual bool get_SmartTagClean ()=0
 Determines whether the smart tag should be cleaned. No inheritance applied. Read bool. More...
 
virtual void set_SmartTagClean (bool value)=0
 Determines whether the smart tag should be cleaned. No inheritance applied. Write bool. More...
 
virtual System::SharedPtr< IPortionFormatEffectiveDataGetEffective ()=0
 Gets effective portion formatting data with the inheritance applied. More...
 
- Public Member Functions inherited from Aspose::Slides::IBasePortionFormat
virtual System::SharedPtr< ILineFormatget_LineFormat ()=0
 Returns the LineFormat properties for text outlining. No inheritance applied. Read-only ILineFormat. More...
 
virtual System::SharedPtr< IFillFormatget_FillFormat ()=0
 Returns the text FillFormat properties. No inheritance applied. Read-only IFillFormat. More...
 
virtual System::SharedPtr< IEffectFormatget_EffectFormat ()=0
 Returns the text EffectFormat properties. No inheritance applied. Read-only IEffectFormat. More...
 
virtual System::SharedPtr< IColorFormatget_HighlightColor ()=0
 Returns the color used to highlight a text. No inheritance applied. Read-only IColorFormat. More...
 
virtual System::SharedPtr< ILineFormatget_UnderlineLineFormat ()=0
 Returns the LineFormat properties used to outline underline line. No inheritance applied. Read-only ILineFormat. More...
 
virtual System::SharedPtr< IFillFormatget_UnderlineFillFormat ()=0
 Returns the underline line FillFormat properties. No inheritance applied. Read-only IFillFormat. More...
 
virtual NullableBool get_FontBold ()=0
 Determines whether the font is bold. No inheritance applied. Read NullableBool. More...
 
virtual void set_FontBold (NullableBool value)=0
 Determines whether the font is bold. No inheritance applied. Write NullableBool. More...
 
virtual NullableBool get_FontItalic ()=0
 Determines whether the font is itallic. No inheritance applied. Read NullableBool. More...
 
virtual void set_FontItalic (NullableBool value)=0
 Determines whether the font is itallic. No inheritance applied. Write NullableBool. More...
 
virtual NullableBool get_Kumimoji ()=0
 Determines whether the numbers should ignore text eastern language-specific vertical text layout. No inheritance applied. Read NullableBool. More...
 
virtual void set_Kumimoji (NullableBool value)=0
 Determines whether the numbers should ignore text eastern language-specific vertical text layout. No inheritance applied. Write NullableBool. More...
 
virtual NullableBool get_NormaliseHeight ()=0
 Determines whether the height of a text should be normalized. No inheritance applied. Read NullableBool. More...
 
virtual void set_NormaliseHeight (NullableBool value)=0
 Determines whether the height of a text should be normalized. No inheritance applied. Write NullableBool. More...
 
virtual NullableBool get_ProofDisabled ()=0
 Determines whether the text shouldn't be proofed. No inheritance applied. Read NullableBool. More...
 
virtual void set_ProofDisabled (NullableBool value)=0
 Determines whether the text shouldn't be proofed. No inheritance applied. Write NullableBool. More...
 
virtual TextUnderlineType get_FontUnderline ()=0
 Returns the text underline type. No inheritance applied. Read TextUnderlineType. More...
 
virtual void set_FontUnderline (TextUnderlineType value)=0
 Sets the text underline type. No inheritance applied. Write TextUnderlineType. More...
 
virtual Aspose::Slides::TextCapType get_TextCapType ()=0
 Returns the type of text capitalization. No inheritance applied. Read Slides::TextCapType. More...
 
virtual void set_TextCapType (Aspose::Slides::TextCapType value)=0
 Sets the type of text capitalization. No inheritance applied. Write Slides::TextCapType. More...
 
virtual TextStrikethroughType get_StrikethroughType ()=0
 Returns the strikethrough type of a text. No inheritance applied. Read TextStrikethroughType. More...
 
virtual void set_StrikethroughType (TextStrikethroughType value)=0
 Sets the strikethrough type of a text. No inheritance applied. Write TextStrikethroughType. More...
 
virtual NullableBool get_IsHardUnderlineLine ()=0
 Determines whether the underline style has own LineFormat properties or inherits it from the LineFormat properties of the text. Read NullableBool. More...
 
virtual void set_IsHardUnderlineLine (NullableBool value)=0
 Determines whether the underline style has own LineFormat properties or inherits it from the LineFormat properties of the text. Write NullableBool. More...
 
virtual NullableBool get_IsHardUnderlineFill ()=0
 Determines whether the underline style has own FillFormat properties or inherits it from the FillFormat properties of the text. Read NullableBool. More...
 
virtual void set_IsHardUnderlineFill (NullableBool value)=0
 Determines whether the underline style has own FillFormat properties or inherits it from the FillFormat properties of the text. Write NullableBool. More...
 
virtual float get_FontHeight ()=0
 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...
 
virtual void set_FontHeight (float value)=0
 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...
 
virtual System::SharedPtr< IFontDataget_LatinFont ()=0
 Returns the Latin font info. Null means font is undefined and should be inherited from the Master. Read IFontData. More...
 
virtual void set_LatinFont (System::SharedPtr< IFontData > value)=0
 Sets the Latin font info. Null means font is undefined and should be inherited from the Master. Write IFontData. More...
 
virtual System::SharedPtr< IFontDataget_EastAsianFont ()=0
 Returns the East Asian font info. Null means font is undefined and should be inherited from the Master. Read IFontData. More...
 
virtual void set_EastAsianFont (System::SharedPtr< IFontData > value)=0
 Sets the East Asian font info. Null means font is undefined and should be inherited from the Master. Write IFontData. More...
 
virtual System::SharedPtr< IFontDataget_ComplexScriptFont ()=0
 Returns the complex script font info. Null means font is undefined and should be inherited from the Master. Read IFontData. More...
 
virtual void set_ComplexScriptFont (System::SharedPtr< IFontData > value)=0
 Sets the complex script font info. Null means font is undefined and should be inherited from the Master. Write IFontData. More...
 
virtual System::SharedPtr< IFontDataget_SymbolFont ()=0
 Returns the symbolic font info. Null means font is undefined and should be inherited from the Master. Read IFontData. More...
 
virtual void set_SymbolFont (System::SharedPtr< IFontData > value)=0
 Sets the symbolic font info. Null means font is undefined and should be inherited from the Master. Write IFontData. More...
 
virtual float get_Escapement ()=0
 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...
 
virtual void set_Escapement (float value)=0
 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...
 
virtual float get_KerningMinimalSize ()=0
 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...
 
virtual void set_KerningMinimalSize (float value)=0
 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...
 
virtual System::String get_LanguageId ()=0
 Returns the Id of a proofing language. Used for checking spelling and grammar. Read System::String. More...
 
virtual void set_LanguageId (System::String value)=0
 Sets the Id of a proofing language. Used for checking spelling and grammar. Write System::String. More...
 
virtual System::String get_AlternativeLanguageId ()=0
 Returns the Id of an alternative language. Read System::String. More...
 
virtual void set_AlternativeLanguageId (System::String value)=0
 Sets the Id of an alternative language. Write System::String. More...
 
virtual float get_Spacing ()=0
 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...
 
virtual void set_Spacing (float value)=0
 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 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 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 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 (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< Objectptr
 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 TypeInfoType ()
 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 IPortionFormat::GetEffective method which returns a IPortionFormatEffectiveData instance.

Member Function Documentation

◆ get_BookmarkId()

virtual System::String Aspose::Slides::IPortionFormat::get_BookmarkId ( )
pure virtual

Returns bookmark identifier. Read System::String.

Implemented in Aspose::Slides::PortionFormat.

◆ get_SmartTagClean()

virtual bool Aspose::Slides::IPortionFormat::get_SmartTagClean ( )
pure virtual

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

Implemented in Aspose::Slides::PortionFormat.

◆ GetEffective()

virtual System::SharedPtr<IPortionFormatEffectiveData> Aspose::Slides::IPortionFormat::GetEffective ( )
pure virtual

Gets effective portion formatting data with the inheritance applied.

Returns
A IPortionFormatEffectiveData.

Implemented in Aspose::Slides::PortionFormat.

◆ set_BookmarkId()

virtual void Aspose::Slides::IPortionFormat::set_BookmarkId ( System::String  value)
pure virtual

Sets bookmark identifier. Write System::String.

Implemented in Aspose::Slides::PortionFormat.

◆ set_SmartTagClean()

virtual void Aspose::Slides::IPortionFormat::set_SmartTagClean ( bool  value)
pure virtual

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

Implemented in Aspose::Slides::PortionFormat.