PortionFormat Class

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

Inheritance Hierarchy

SystemObject
  Aspose.SlidesPVIObject
    Aspose.SlidesBasePortionFormat
      Aspose.SlidesPortionFormat

Namespace: Aspose.Slides
Assembly: Aspose.Slides (in Aspose.Slides.dll) Version: 20.3.0.0 (20.3)

Syntax

C++

public class PortionFormat : BasePortionFormat, 
	IPortionFormat, IBasePortionFormat, IHyperlinkContainer

Public Class PortionFormat
	Inherits BasePortionFormat
	Implements IPortionFormat, IBasePortionFormat, IHyperlinkContainer

public ref class PortionFormat : public BasePortionFormat, 
	IPortionFormat, IBasePortionFormat, IHyperlinkContainer

type PortionFormat =  
    class
        inherit BasePortionFormat
        interface IPortionFormat
        interface IBasePortionFormat
        interface IHyperlinkContainer
    end

The PortionFormat type exposes the following members.

Constructors

	Name	Description
	PortionFormat	Initializes a new instance of PortionFormat class.

Properties

	Name	Description
	AlternativeLanguageId	Returns or sets the Id of an alternative language. Read/write String. (Inherited from BasePortionFormat.)
	BookmarkId	Returns or sets bookmark identifier. Read/write String.
	ComplexScriptFont	Returns or sets the complex script font info. Null means font is undefined and should be inherited from the Master. Read/write IFontData. (Inherited from BasePortionFormat.)
	EastAsianFont	Returns or sets the East Asian font info. Null means font is undefined and should be inherited from the Master. Read/write IFontData. (Inherited from BasePortionFormat.)
	EffectFormat	Returns the text EffectFormat properties. No inheritance applied. Read-only IEffectFormat. (Inherited from BasePortionFormat.)
	Escapement	Returns or sets the superscript or subscript text. Value from -100% (subscript) to 100% (superscript). float.NaN means value is undefined and should be inherited from the Master. Read/write Single. (Inherited from BasePortionFormat.)
	FillFormat	Returns the text FillFormat properties. No inheritance applied. Read-only IFillFormat. (Inherited from BasePortionFormat.)
	FontBold	Determines whether the font is bold. No inheritance applied. Read/write NullableBool. (Inherited from BasePortionFormat.)
	FontHeight	Returns or sets the font height of a portion. float.NaN means height is undefined and should be inherited from the Master. Read/write Single. (Inherited from BasePortionFormat.)
	FontItalic	Determines whether the font is itallic. No inheritance applied. Read/write NullableBool. (Inherited from BasePortionFormat.)
	FontUnderline	Returns or sets the text underline type. No inheritance applied. Read/write TextUnderlineType. (Inherited from BasePortionFormat.)
	HighlightColor	Returns the color used to highlight a text. No inheritance applied. Read-only IColorFormat. (Inherited from BasePortionFormat.)
	HyperlinkClick	Returns or sets the hyperlink defined for mouse click. Read/write IHyperlink.
	HyperlinkManager	Hyperlinks manager. Read-only IHyperlinkManager.
	HyperlinkMouseOver	Returns or sets the hyperlink defined for mouse over. Read/write IHyperlink.
	IsHardUnderlineFill	Determines whether the underline style has own FillFormat properties or inherits it from the FillFormat properties of the text. Read/write NullableBool. (Inherited from BasePortionFormat.)
	IsHardUnderlineLine	Determines whether the underline style has own LineFormat properties or inherits it from the LineFormat properties of the text. Read/write NullableBool. (Inherited from BasePortionFormat.)
	KerningMinimalSize	Returns or sets the minimal font size, for which kerning should be switched on. float.NaN means value is undefined and should be inherited from the Master. Read/write Single. (Inherited from BasePortionFormat.)
	Kumimoji	Determines whether the numbers should ignore text eastern language-specific vertical text layout. No inheritance applied. Read/write NullableBool. (Inherited from BasePortionFormat.)
	LanguageId	Returns or sets the Id of a proofing language. Used for checking spelling and grammar. Read/write String. (Inherited from BasePortionFormat.)
	LatinFont	Returns or sets the Latin font info. Null means font is undefined and should be inherited from the Master. Read/write IFontData. (Inherited from BasePortionFormat.)
	LineFormat	Returns the LineFormat properties for text outlining. No inheritance applied. Read-only ILineFormat. (Inherited from BasePortionFormat.)
	NormaliseHeight	Determines whether the height of a text should be normalized. No inheritance applied. Read/write NullableBool. (Inherited from BasePortionFormat.)
	ProofDisabled	Determines whether the text shouldn't be proofed. No inheritance applied. Read/write NullableBool. (Inherited from BasePortionFormat.)
	SmartTagClean	Determines whether the smart tag should be cleaned. No inheritance applied. Read/write Boolean.
	Spacing	Returns or sets the intercharacter spacing increment. float.NaN means value is undefined and should be inherited from the Master. Read/write Single. (Inherited from BasePortionFormat.)
	StrikethroughType	Returns or sets the strikethrough type of a text. No inheritance applied. Read/write TextStrikethroughType. (Inherited from BasePortionFormat.)
	SymbolFont	Returns or sets the symbolic font info. Null means font is undefined and should be inherited from the Master. Read/write IFontData. (Inherited from BasePortionFormat.)
	TextCapType	Returns or sets the type of text capitalization. No inheritance applied. Read/write TextCapType. (Inherited from BasePortionFormat.)
	UnderlineFillFormat	Returns the underline line FillFormat properties. No inheritance applied. Read-only IFillFormat. (Inherited from BasePortionFormat.)
	UnderlineLineFormat	Returns the LineFormat properties used to outline underline line. No inheritance applied. Read-only ILineFormat. (Inherited from BasePortionFormat.)

Methods

	Name	Description
	Equals	Compares with specified object. (Inherited from PVIObject.)
	Finalize	(Inherited from Object.)
	GetEffective	Gets effective portion formatting data with the inheritance applied.
	GetHashCode	Returns hash code. (Inherited from PVIObject.)
	GetType	(Inherited from Object.)
	MemberwiseClone	(Inherited from Object.)
	ToString	(Inherited from Object.)

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 GetEffective method which returns a PortionFormatEffectiveData instance.

Reference

Aspose.Slides Namespace