Aspose::Slides::PortionFormat Class Reference

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

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

Public Member Functions

System::String get_BookmarkId ()
 Returns bookmark identifier. Read System::String. More...
 
void set_BookmarkId (System::String value)
 Sets bookmark identifier. Write System::String. More...
 
bool get_SmartTagClean ()
 Determines whether the smart tag should be cleaned. No inheritance applied. Read bool. More...
 
void set_SmartTagClean (bool value)
 Determines whether the smart tag should be cleaned. No inheritance applied. Write bool. More...
 
System::SharedPtr< IHyperlinkget_HyperlinkClick ()
 Returns the hyperlink defined for mouse click. Read IHyperlink. More...
 
void set_HyperlinkClick (System::SharedPtr< IHyperlink > value)
 Sets the hyperlink defined for mouse click. Write IHyperlink. More...
 
System::SharedPtr< IHyperlinkget_HyperlinkMouseOver ()
 Returns the hyperlink defined for mouse over. Read IHyperlink. More...
 
void set_HyperlinkMouseOver (System::SharedPtr< IHyperlink > value)
 Sets the hyperlink defined for mouse over. Write IHyperlink. More...
 
System::SharedPtr< IHyperlinkManagerget_HyperlinkManager ()
 Hyperlinks manager. Read-only IHyperlinkManager. More...
 
 PortionFormat ()
 Initializes a new instance of PortionFormat class. More...
 
System::SharedPtr< IPortionFormatEffectiveDataGetEffective ()
 Gets effective portion formatting data with the inheritance applied. More...
 
- Public Member Functions inherited from Aspose::Slides::BasePortionFormat
System::SharedPtr< ILineFormatget_LineFormat ()
 Returns the LineFormat properties for text outlining. No inheritance applied. Read-only ILineFormat. More...
 
System::SharedPtr< IFillFormatget_FillFormat ()
 Returns the text FillFormat properties. No inheritance applied. Read-only IFillFormat. More...
 
System::SharedPtr< IEffectFormatget_EffectFormat ()
 Returns the text EffectFormat properties. No inheritance applied. Read-only IEffectFormat. More...
 
System::SharedPtr< IColorFormatget_HighlightColor ()
 Returns the color used to highlight a text. No inheritance applied. Read-only IColorFormat. More...
 
System::SharedPtr< ILineFormatget_UnderlineLineFormat ()
 Returns the LineFormat properties used to outline underline line. No inheritance applied. Read-only ILineFormat. More...
 
System::SharedPtr< IFillFormatget_UnderlineFillFormat ()
 Returns the underline line FillFormat properties. No inheritance applied. Read-only IFillFormat. More...
 
NullableBool get_FontBold ()
 Determines whether the font is bold. No inheritance applied. Read NullableBool. More...
 
void set_FontBold (NullableBool value)
 Determines whether the font is bold. No inheritance applied. Write NullableBool. More...
 
NullableBool get_FontItalic ()
 Determines whether the font is itallic. No inheritance applied. Read NullableBool. More...
 
void set_FontItalic (NullableBool value)
 Determines whether the font is itallic. No inheritance applied. Write NullableBool. More...
 
NullableBool get_Kumimoji ()
 Determines whether the numbers should ignore text eastern language-specific vertical text layout. No inheritance applied. Read NullableBool. More...
 
void set_Kumimoji (NullableBool value)
 Determines whether the numbers should ignore text eastern language-specific vertical text layout. No inheritance applied. Write NullableBool. More...
 
NullableBool get_NormaliseHeight ()
 Determines whether the height of a text should be normalized. No inheritance applied. Read NullableBool. More...
 
void set_NormaliseHeight (NullableBool value)
 Determines whether the height of a text should be normalized. No inheritance applied. Write NullableBool. More...
 
NullableBool get_ProofDisabled ()
 Determines whether the text shouldn't be proofed. No inheritance applied. Read NullableBool. More...
 
void set_ProofDisabled (NullableBool value)
 Determines whether the text shouldn't be proofed. No inheritance applied. Write NullableBool. More...
 
TextUnderlineType get_FontUnderline ()
 Returns the text underline type. No inheritance applied. Read TextUnderlineType. More...
 
void set_FontUnderline (TextUnderlineType value)
 Sets the text underline type. No inheritance applied. Write TextUnderlineType. More...
 
Aspose::Slides::TextCapType get_TextCapType ()
 Returns the type of text capitalization. No inheritance applied. Read Slides::TextCapType. More...
 
void set_TextCapType (Aspose::Slides::TextCapType value)
 Sets the type of text capitalization. No inheritance applied. Write Slides::TextCapType. More...
 
TextStrikethroughType get_StrikethroughType ()
 Returns the strikethrough type of a text. No inheritance applied. Read TextStrikethroughType. More...
 
void set_StrikethroughType (TextStrikethroughType value)
 Sets the strikethrough type of a text. No inheritance applied. Write TextStrikethroughType. More...
 
NullableBool get_IsHardUnderlineLine ()
 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)
 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 ()
 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)
 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 ()
 Returns the font height of a portion. float.NaN means height is undefined and should be inherited from the Master. Read float. More...
 
void set_FontHeight (float value)
 Sets the font height of a portion. float.NaN means height is undefined and should be inherited from the Master. Write float. More...
 
System::SharedPtr< IFontDataget_LatinFont ()
 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)
 Sets the Latin font info. Null means font is undefined and should be inherited from the Master. Write IFontData. More...
 
System::SharedPtr< IFontDataget_EastAsianFont ()
 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)
 Sets the East Asian font info. Null means font is undefined and should be inherited from the Master. Write IFontData. More...
 
System::SharedPtr< IFontDataget_ComplexScriptFont ()
 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)
 Sets the complex script font info. Null means font is undefined and should be inherited from the Master. Write IFontData. More...
 
System::SharedPtr< IFontDataget_SymbolFont ()
 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)
 Sets the symbolic font info. Null means font is undefined and should be inherited from the Master. Write IFontData. More...
 
float get_Escapement ()
 Returns 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 float. More...
 
void set_Escapement (float value)
 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. Write float. More...
 
float get_KerningMinimalSize ()
 Returns 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 float. More...
 
void set_KerningMinimalSize (float value)
 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. Write float. More...
 
System::String get_LanguageId ()
 Returns the Id of a proofing language. Used for checking spelling and grammar. Read System::String. More...
 
void set_LanguageId (System::String value)
 Sets the Id of a proofing language. Used for checking spelling and grammar. Write System::String. More...
 
System::String get_AlternativeLanguageId ()
 Returns the Id of an alternative language. Read System::String. More...
 
void set_AlternativeLanguageId (System::String value)
 Sets the Id of an alternative language. Write System::String. More...
 
float get_Spacing ()
 Returns the intercharacter spacing increment. float.NaN means value is undefined and should be inherited from the Master. Read float. More...
 
void set_Spacing (float value)
 Sets the intercharacter spacing increment. float.NaN means value is undefined and should be inherited from the Master. Write float. More...
 
- Public Member Functions inherited from Aspose::Slides::PVIObject
virtual bool Equals (System::SharedPtr< System::Object > obj)
 Compares with specified object. More...
 
virtual int32_t GetHashCode () const
 Returns hash code. 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 refernce 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 String ToString () ASPOSE_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 (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Protected Member Functions

System::SharedPtr< PortionFormatImpl > get_RealObject ()
 
bool get_ManualStretch ()
 
void set_ManualStretch (bool value)
 
System::SharedPtr< ParagraphFormatget_ParentParagraphFormat ()
 
System::SharedPtr< UnsupportedProps::PPTUnsupportedProps::PortionFormatPPTUnsupportedProps > get_PPTUnsupportedProps ()
 
 PortionFormat (System::SharedPtr< IDOMObject > parentImmediate)
 
virtual void CreateChildObjects ()
 
virtual System::SharedPtr< System::ObjectCreateRealObject ()
 
void CopyDataFrom (System::SharedPtr< PortionFormatEffectiveData > source)
 
void CopyTextDataFrom (System::SharedPtr< PortionFormatEffectiveData > source)
 
void ScaleSizes (float scalingCoef)
 
System::SharedPtr< PortionFormatClone ()
 
void Reset ()
 Sets all properties to NotDefined state. More...
 
System::SharedPtr< PortionFormatEffectiveData > GetEffectiveInternal ()
 
void ClearEffective ()
 
void SetParent (System::SharedPtr< Portion > parentImmediate)
 
- Protected Member Functions inherited from Aspose::Slides::BasePortionFormat
System::SharedPtr< BasePortionFormatImpl > get_RealObject ()
 
System::SharedPtr< Aspose::Slides::LineFormatget_LineFormatInternal ()
 
System::SharedPtr< Aspose::Slides::FillFormatget_FillFormatInternal ()
 
System::SharedPtr< Aspose::Slides::EffectFormatget_EffectFormatInternal ()
 
System::SharedPtr< ColorFormatget_HighlightColorInternal ()
 
System::SharedPtr< Aspose::Slides::LineFormatget_UnderlineLineFormatInternal ()
 
System::SharedPtr< Aspose::Slides::FillFormatget_UnderlineFillFormatInternal ()
 
int32_t get_Attributes ()
 
void set_Attributes (int32_t value)
 
bool get_Err ()
 
void set_Err (bool value)
 
bool get_MetroBlobRequired ()
 Shows if saving the shape containing this object to ppt requires GroupShapeMetroBlob record to save all shape's properties correctly More...
 
System::SharedPtr< UnsupportedProps::PPTXUnsupportedProps::PortionFormatPPTXUnsupportedProps > get_PPTXUnsupportedProps ()
 
 BasePortionFormat (System::SharedPtr< IDOMObject > parent)
 
void CopyDataFrom (System::SharedPtr< IBasePortionFormat > source)
 
void CopyDefinedDataFrom (System::SharedPtr< IBasePortionFormat > source)
 
void CombineTo (System::SharedPtr< IBasePortionFormat > source)
 
void CombineFrom (System::SharedPtr< IBasePortionFormat > source)
 
void CombineFrom (System::SharedPtr< IPortionFormatEffectiveData > source)
 
void AddOverride (System::SharedPtr< IBasePortionFormat > oldDefault, System::SharedPtr< IBasePortionFormat > newDefault)
 
- Protected Member Functions inherited from Aspose::Slides::PVIObject
System::SharedPtr< ObjectWrapper > get_Wrapper () const
 
System::SharedPtr< IDOMObjectget_Parent_Immediate ()
 Returns Parent_Immediate object. Read-only IDOMObject. More...
 
void set_Parent_Immediate (System::SharedPtr< IDOMObject > value)
 
virtual uint32_t get_Version ()
 Version. Read-only uint32_t. More...
 
System::SharedPtr< IPresentationComponentget_Parent_IPresentationComponent ()
 Returns parent IPresentationComponent. Read-only IPresentationComponent. More...
 
System::SharedPtr< ISlideComponentget_Parent_ISlideComponent ()
 
System::SharedPtr< BaseSlideget_Slide ()
 
System::SharedPtr< Aspose::Slides::Presentationget_Presentation ()
 
 PVIObject (System::SharedPtr< IDOMObject > parentImmediate)
 
void Reset_Parent_IPresentationComponent ()
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. 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 ()
 Impleemnts C# typeof(System.Object) construct. More...
 

Detailed Description

This class contains the text portion formatting properties. Unlike PortionFormatEffectiveData, 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 PortionFormatEffectiveData instance.

Constructor & Destructor Documentation

◆ PortionFormat() [1/2]

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

Initializes a new instance of PortionFormat class.

◆ PortionFormat() [2/2]

Aspose::Slides::PortionFormat::PortionFormat ( System::SharedPtr< IDOMObject parentImmediate)
protected

Member Function Documentation

◆ ClearEffective()

void Aspose::Slides::PortionFormat::ClearEffective ( )
protected

◆ Clone()

System::SharedPtr<PortionFormat> Aspose::Slides::PortionFormat::Clone ( )
protected

◆ CopyDataFrom()

void Aspose::Slides::PortionFormat::CopyDataFrom ( System::SharedPtr< PortionFormatEffectiveData >  source)
protected

◆ CopyTextDataFrom()

void Aspose::Slides::PortionFormat::CopyTextDataFrom ( System::SharedPtr< PortionFormatEffectiveData >  source)
protected

◆ CreateChildObjects()

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

Reimplemented from Aspose::Slides::BasePortionFormat.

◆ CreateRealObject()

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

◆ get_BookmarkId()

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

Returns bookmark identifier. Read System::String.

Implements Aspose::Slides::IPortionFormat.

◆ get_HyperlinkClick()

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

Returns the hyperlink defined for mouse click. Read IHyperlink.

Implements Aspose::Slides::IHyperlinkContainer.

◆ get_HyperlinkManager()

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

Hyperlinks manager. Read-only IHyperlinkManager.

Implements Aspose::Slides::IHyperlinkContainer.

◆ get_HyperlinkMouseOver()

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

Returns the hyperlink defined for mouse over. Read IHyperlink.

Implements Aspose::Slides::IHyperlinkContainer.

◆ get_ManualStretch()

bool Aspose::Slides::PortionFormat::get_ManualStretch ( )
protected

◆ get_ParentParagraphFormat()

System::SharedPtr<ParagraphFormat> Aspose::Slides::PortionFormat::get_ParentParagraphFormat ( )
protected

◆ get_PPTUnsupportedProps()

System::SharedPtr<UnsupportedProps::PPTUnsupportedProps::PortionFormatPPTUnsupportedProps> Aspose::Slides::PortionFormat::get_PPTUnsupportedProps ( )
protected

◆ get_RealObject()

System::SharedPtr<PortionFormatImpl> Aspose::Slides::PortionFormat::get_RealObject ( )
protected

◆ get_SmartTagClean()

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

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 ( )
virtual

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.

◆ GetEffectiveInternal()

System::SharedPtr<PortionFormatEffectiveData> Aspose::Slides::PortionFormat::GetEffectiveInternal ( )
protected

◆ Reset()

void Aspose::Slides::PortionFormat::Reset ( )
protected

Sets all properties to NotDefined state.

◆ ScaleSizes()

void Aspose::Slides::PortionFormat::ScaleSizes ( float  scalingCoef)
protected

◆ set_BookmarkId()

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

Sets bookmark identifier. Write System::String.

Implements Aspose::Slides::IPortionFormat.

◆ set_HyperlinkClick()

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

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)
virtual

Sets the hyperlink defined for mouse over. Write IHyperlink.

Implements Aspose::Slides::IHyperlinkContainer.

◆ set_ManualStretch()

void Aspose::Slides::PortionFormat::set_ManualStretch ( bool  value)
protected

◆ set_SmartTagClean()

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

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

Implements Aspose::Slides::IPortionFormat.

◆ SetParent()

void Aspose::Slides::PortionFormat::SetParent ( System::SharedPtr< Portion parentImmediate)
protected