PortionFormat

PortionFormat class

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

class PortionFormat : public Aspose::Slides::BasePortionFormat,
                      public Aspose::Slides::IPortionFormat

Methods

MethodDescription
bool Equals(System::SharedPtr<System::Object>) overrideCompares with specified object.
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 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 **) constFor internal purposes only.
System::String get_AlternativeLanguageId() overrideReturns the Id of an alternative language. Read System::String.
System::String get_BookmarkId() overrideReturns bookmark identifier. Read System::String.
System::SharedPtr<IFontData> get_ComplexScriptFont() overrideReturns the complex script font info. Null means font is undefined and should be inherited from the Master. Read IFontData.
System::SharedPtr<IFontData> get_EastAsianFont() overrideReturns the East Asian font info. Null means font is undefined and should be inherited from the Master. Read IFontData.
System::SharedPtr<IEffectFormat> get_EffectFormat() overrideReturns the text EffectFormat properties. No inheritance applied. Read-only IEffectFormat.
float get_Escapement() overrideReturns 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.
System::SharedPtr<IFillFormat> get_FillFormat() overrideReturns the text FillFormat properties. No inheritance applied. Read-only IFillFormat.
NullableBool get_FontBold() overrideDetermines whether the font is bold. No inheritance applied. Read NullableBool.
float get_FontHeight() overrideReturns the font height of a portion. std::numeric_limits::quiet_NaN() means height is undefined and should be inherited from the Master. Read float.
NullableBool get_FontItalic() overrideDetermines whether the font is itallic. No inheritance applied. Read NullableBool.
TextUnderlineType get_FontUnderline() overrideReturns the text underline type. No inheritance applied. Read TextUnderlineType.
System::SharedPtr<IColorFormat> get_HighlightColor() overrideReturns the color used to highlight a text. No inheritance applied. Read-only IColorFormat.
System::SharedPtr<IHyperlink> get_HyperlinkClick() overrideReturns the hyperlink defined for mouse click. Read IHyperlink.
System::SharedPtr<IHyperlinkManager> get_HyperlinkManager() overrideHyperlinks manager. Read-only IHyperlinkManager.
System::SharedPtr<IHyperlink> get_HyperlinkMouseOver() overrideReturns the hyperlink defined for mouse over. Read IHyperlink.
NullableBool get_IsHardUnderlineFill() overrideDetermines whether the underline style has own FillFormat properties or inherits it from the FillFormat properties of the text. Read NullableBool.
NullableBool get_IsHardUnderlineLine() overrideDetermines whether the underline style has own LineFormat properties or inherits it from the LineFormat properties of the text. Read NullableBool.
float get_KerningMinimalSize() overrideReturns 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.
NullableBool get_Kumimoji() overrideDetermines whether the numbers should ignore text eastern language-specific vertical text layout. No inheritance applied. Read NullableBool.
System::String get_LanguageId() overrideReturns the Id of a proofing language. Used for checking spelling and grammar. Read System::String.
System::SharedPtr<IFontData> get_LatinFont() overrideReturns the Latin font info. Null means font is undefined and should be inherited from the Master. Read IFontData.
System::SharedPtr<ILineFormat> get_LineFormat() overrideReturns the LineFormat properties for text outlining. No inheritance applied. Read-only ILineFormat.
NullableBool get_NormaliseHeight() overrideDetermines whether the height of a text should be normalized. No inheritance applied. Read NullableBool.
virtual ASPOSE_SLIDES_LOCAL_API System::SharedPtr<IDOMObject> get_Parent_Immediate()Returns Parent_Immediate object. Read-only IDOMObject.
virtual ASPOSE_SLIDES_LOCAL_API System::SharedPtr<IPresentationComponent> get_Parent_IPresentationComponent()Returns parent IPresentationComponent. Read-only IPresentationComponent.
NullableBool get_ProofDisabled() overrideDetermines whether the text shouldn’t be proofed. No inheritance applied. Read NullableBool.
bool get_SmartTagClean() overrideDetermines whether the smart tag should be cleaned. No inheritance applied. Read bool.
float get_Spacing() overrideReturns the intercharacter spacing increment. std::numeric_limits::quiet_NaN() means value is undefined and should be inherited from the Master. Read float.
TextStrikethroughType get_StrikethroughType() overrideReturns the strikethrough type of a text. No inheritance applied. Read TextStrikethroughType.
System::SharedPtr<IFontData> get_SymbolFont() overrideReturns the symbolic font info. Null means font is undefined and should be inherited from the Master. Read IFontData.
Aspose::Slides::TextCapType get_TextCapType() overrideReturns the type of text capitalization. No inheritance applied. Read Slides::TextCapType.
System::SharedPtr<IFillFormat> get_UnderlineFillFormat() overrideReturns the underline line FillFormat properties. No inheritance applied. Read-only IFillFormat.
System::SharedPtr<ILineFormat> get_UnderlineLineFormat() overrideReturns 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.
System::SharedPtr<IPortionFormatEffectiveData> GetEffective() overrideGets effective portion formatting data with the inheritance applied.
int32_t GetHashCode() const overrideReturns hash code.
virtual const TypeInfo& GetType() constGets actual type of object. Analog of C# System.Object.GetType() call.
virtual bool Is(const TypeInfo&) constCheck 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() constAnalog 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.
PortionFormat()Initializes a new instance of PortionFormat class.
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.
void set_AlternativeLanguageId(System::String) overrideSets the Id of an alternative language. Write System::String.
void set_BookmarkId(System::String) overrideSets bookmark identifier. Write System::String.
void set_ComplexScriptFont(System::SharedPtr<IFontData>) overrideSets the complex script font info. Null means font is undefined and should be inherited from the Master. Write IFontData.
void set_EastAsianFont(System::SharedPtr<IFontData>) overrideSets the East Asian font info. Null means font is undefined and should be inherited from the Master. Write IFontData.
void set_Escapement(float) overrideSets 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.
void set_FontBold(NullableBool) overrideDetermines whether the font is bold. No inheritance applied. Write NullableBool.
void set_FontHeight(float) overrideSets the font height of a portion. std::numeric_limits::quiet_NaN() means height is undefined and should be inherited from the Master. Write float.
void set_FontItalic(NullableBool) overrideDetermines whether the font is itallic. No inheritance applied. Write NullableBool.
void set_FontUnderline(TextUnderlineType) overrideSets the text underline type. No inheritance applied. Write TextUnderlineType.
void set_HyperlinkClick(System::SharedPtr<IHyperlink>) overrideSets the hyperlink defined for mouse click. Write IHyperlink.
void set_HyperlinkMouseOver(System::SharedPtr<IHyperlink>) overrideSets the hyperlink defined for mouse over. Write IHyperlink.
void set_IsHardUnderlineFill(NullableBool) overrideDetermines whether the underline style has own FillFormat properties or inherits it from the FillFormat properties of the text. Write NullableBool.
void set_IsHardUnderlineLine(NullableBool) overrideDetermines whether the underline style has own LineFormat properties or inherits it from the LineFormat properties of the text. Write NullableBool.
void set_KerningMinimalSize(float) overrideSets 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.
void set_Kumimoji(NullableBool) overrideDetermines whether the numbers should ignore text eastern language-specific vertical text layout. No inheritance applied. Write NullableBool.
void set_LanguageId(System::String) overrideSets the Id of a proofing language. Used for checking spelling and grammar. Write System::String.
void set_LatinFont(System::SharedPtr<IFontData>) overrideSets the Latin font info. Null means font is undefined and should be inherited from the Master. Write IFontData.
void set_NormaliseHeight(NullableBool) overrideDetermines whether the height of a text should be normalized. No inheritance applied. Write NullableBool.
void set_ProofDisabled(NullableBool) overrideDetermines whether the text shouldn’t be proofed. No inheritance applied. Write NullableBool.
void set_SmartTagClean(bool) overrideDetermines whether the smart tag should be cleaned. No inheritance applied. Write bool.
void set_Spacing(float) overrideSets the intercharacter spacing increment. std::numeric_limits::quiet_NaN() means value is undefined and should be inherited from the Master. Write float.
void set_StrikethroughType(TextStrikethroughType) overrideSets the strikethrough type of a text. No inheritance applied. Write TextStrikethroughType.
void set_SymbolFont(System::SharedPtr<IFontData>) overrideSets the symbolic font info. Null means font is undefined and should be inherited from the Master. Write IFontData.
void set_TextCapType(Aspose::Slides::TextCapType) overrideSets 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() constGets 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() constAnalog 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.
ASPOSE_SLIDES_LOCAL_API void WrapperLazyInitialization() const
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 PortionFormat::GetEffective method which returns a IPortionFormatEffectiveData instance.

The following examples shows you how to assign the Latin font to a Paragraph’s portion of PowerPoint Presentation.

auto pres = System::MakeObject<Presentation>(u"demo.pptx");
auto shape = pres->get_Slides()->idx_get(0)->get_Shapes()->AddAutoShape(ShapeType::Rectangle, 10.0f, 10.0f, 100.0f, 100.0f);

System::SharedPtr<Paragraph> paragraph = System::MakeObject<Paragraph>();
System::SharedPtr<Portion> portion = System::MakeObject<Portion>(u"Theme text format");
paragraph->get_Portions()->Add(portion);
shape->get_TextFrame()->get_Paragraphs()->Add(paragraph);
// Aspose.Slides uses these special identifiers (similar to those used in PowerPoint):
// +mn-lt - Body Font Latin (Minor Latin Font)
// +mj-lt -Heading Font Latin (Major Latin Font)
// +mn-ea - Body Font East Asian (Minor East Asian Font)
// +mj-ea - Body Font East Asian (Minor East Asian Font)
portion->get_PortionFormat()->set_LatinFont(System::MakeObject<FontData>(u"+mn-lt"));

See Also