Aspose::Slides::IParagraphFormat Class Referenceabstract

This class contains the paragraph formatting properties. Unlike IParagraphFormatEffectiveData, all properties of this class are writeable. More...

Inherits System::Object.

Inherited by Aspose::Slides::ParagraphFormat.

Public Member Functions

virtual System::SharedPtr< IBulletFormatget_Bullet ()=0
 Returns bullet format of the paragraph. Read-only IBulletFormat. More...
 
virtual int16_t get_Depth ()=0
 Returns depth of the paragraph. Value 0 means undefined value. Read int16_t. More...
 
virtual void set_Depth (int16_t value)=0
 Sets depth of the paragraph. Value 0 means undefined value. Write int16_t. More...
 
virtual TextAlignment get_Alignment ()=0
 Returns the text alignment in a paragraph with no inheritance. Read TextAlignment. More...
 
virtual void set_Alignment (TextAlignment value)=0
 Sets the text alignment in a paragraph with no inheritance. Write TextAlignment. More...
 
virtual float get_SpaceWithin ()=0
 Returns the amount of space between base lines in a paragraph. Positive value means percentage, negative - size in points. No inheritance applied. Read float. More...
 
virtual void set_SpaceWithin (float value)=0
 Sets the amount of space between base lines in a paragraph. Positive value means percentage, negative - size in points. No inheritance applied. Write float. More...
 
virtual float get_SpaceBefore ()=0
 Returns the amount of space before the first line in a paragraph with no inheritance. A positive value specifies the percentage of the font size that the white space should be. A negative value specifies the size of the white space in point size. Read float. More...
 
virtual void set_SpaceBefore (float value)=0
 Sets the amount of space before the first line in a paragraph with no inheritance. A positive value specifies the percentage of the font size that the white space should be. A negative value specifies the size of the white space in point size. Write float. More...
 
virtual float get_SpaceAfter ()=0
 Returns the amount of space after the last line in a paragraph with no inheritance. A positive value specifies the percentage of the font size that the white space should be. A negative value specifies the size of the white space in point size. Read float. More...
 
virtual void set_SpaceAfter (float value)=0
 Sets the amount of space after the last line in a paragraph with no inheritance. A positive value specifies the percentage of the font size that the white space should be. A negative value specifies the size of the white space in point size. Write float. More...
 
virtual NullableBool get_EastAsianLineBreak ()=0
 Determines whether the East Asian line break is used in a paragraph. No inheritance applied. Read NullableBool. More...
 
virtual void set_EastAsianLineBreak (NullableBool value)=0
 Determines whether the East Asian line break is used in a paragraph. No inheritance applied. Write NullableBool. More...
 
virtual NullableBool get_RightToLeft ()=0
 Determines whether the Right to Left writing is used in a paragraph. No inheritance applied. Read NullableBool. More...
 
virtual void set_RightToLeft (NullableBool value)=0
 Determines whether the Right to Left writing is used in a paragraph. No inheritance applied. Write NullableBool. More...
 
virtual NullableBool get_LatinLineBreak ()=0
 Determines whether the Latin line break is used in a paragraph. No inheritance applied. Read NullableBool. More...
 
virtual void set_LatinLineBreak (NullableBool value)=0
 Determines whether the Latin line break is used in a paragraph. No inheritance applied. Write NullableBool. More...
 
virtual NullableBool get_HangingPunctuation ()=0
 Determines whether the hanging punctuation is used in a paragraph. No inheritance applied. Read NullableBool. More...
 
virtual void set_HangingPunctuation (NullableBool value)=0
 Determines whether the hanging punctuation is used in a paragraph. No inheritance applied. Write NullableBool. More...
 
virtual float get_MarginLeft ()=0
 Returns the left margin in a paragraph with no inheritance. Read float. More...
 
virtual void set_MarginLeft (float value)=0
 Sets the left margin in a paragraph with no inheritance. Write float. More...
 
virtual float get_MarginRight ()=0
 Returns the right margin in a paragraph with no inheritance. Read float. More...
 
virtual void set_MarginRight (float value)=0
 Sets the right margin in a paragraph with no inheritance. Write float. More...
 
virtual float get_Indent ()=0
 Returns paragraph First Line Indent/Hanging Indent with no inheritance. Hanging Indent can be defined with negative values. Read float. More...
 
virtual void set_Indent (float value)=0
 Sets paragraph First Line Indent/Hanging Indent with no inheritance. Hanging Indent can be defined with negative values. Write float. More...
 
virtual float get_DefaultTabSize ()=0
 Returns default tabulation size with no inheritance. Read float. More...
 
virtual void set_DefaultTabSize (float value)=0
 Sets default tabulation size with no inheritance. Write float. More...
 
virtual System::SharedPtr< ITabCollectionget_Tabs ()=0
 Returns tabulations of a paragraph. No inheritance applied. Read-only ITabCollection. More...
 
virtual Aspose::Slides::FontAlignment get_FontAlignment ()=0
 Returns a font alignment in a paragraph with no inheritance. Read Slides::FontAlignment. More...
 
virtual void set_FontAlignment (Aspose::Slides::FontAlignment value)=0
 Sets a font alignment in a paragraph with no inheritance. Write Slides::FontAlignment. More...
 
virtual System::SharedPtr< IPortionFormatget_DefaultPortionFormat ()=0
 Returns default portion format of a paragraph. No inheritance applied. Read-only IPortionFormat. More...
 
virtual System::SharedPtr< IParagraphFormatEffectiveDataGetEffective ()=0
 Gets effective paragraph formatting data with the inheritance applied. 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 paragraph formatting properties. Unlike IParagraphFormatEffectiveData, all properties of this class are writeable.

This class is used to return and manipulate paragraph formatting properties defined for the particular paragraph. 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 IParagraphFormat::GetEffective method which returns a IParagraphFormatEffectiveData instance.

Member Function Documentation

◆ get_Alignment()

virtual TextAlignment Aspose::Slides::IParagraphFormat::get_Alignment ( )
pure virtual

Returns the text alignment in a paragraph with no inheritance. Read TextAlignment.

Implemented in Aspose::Slides::ParagraphFormat.

◆ get_Bullet()

virtual System::SharedPtr<IBulletFormat> Aspose::Slides::IParagraphFormat::get_Bullet ( )
pure virtual

Returns bullet format of the paragraph. Read-only IBulletFormat.

◆ get_DefaultPortionFormat()

virtual System::SharedPtr<IPortionFormat> Aspose::Slides::IParagraphFormat::get_DefaultPortionFormat ( )
pure virtual

Returns default portion format of a paragraph. No inheritance applied. Read-only IPortionFormat.

◆ get_DefaultTabSize()

virtual float Aspose::Slides::IParagraphFormat::get_DefaultTabSize ( )
pure virtual

Returns default tabulation size with no inheritance. Read float.

Implemented in Aspose::Slides::ParagraphFormat.

◆ get_Depth()

virtual int16_t Aspose::Slides::IParagraphFormat::get_Depth ( )
pure virtual

Returns depth of the paragraph. Value 0 means undefined value. Read int16_t.

◆ get_EastAsianLineBreak()

virtual NullableBool Aspose::Slides::IParagraphFormat::get_EastAsianLineBreak ( )
pure virtual

Determines whether the East Asian line break is used in a paragraph. No inheritance applied. Read NullableBool.

Implemented in Aspose::Slides::ParagraphFormat.

◆ get_FontAlignment()

virtual Aspose::Slides::FontAlignment Aspose::Slides::IParagraphFormat::get_FontAlignment ( )
pure virtual

Returns a font alignment in a paragraph with no inheritance. Read Slides::FontAlignment.

Implemented in Aspose::Slides::ParagraphFormat.

◆ get_HangingPunctuation()

virtual NullableBool Aspose::Slides::IParagraphFormat::get_HangingPunctuation ( )
pure virtual

Determines whether the hanging punctuation is used in a paragraph. No inheritance applied. Read NullableBool.

Implemented in Aspose::Slides::ParagraphFormat.

◆ get_Indent()

virtual float Aspose::Slides::IParagraphFormat::get_Indent ( )
pure virtual

Returns paragraph First Line Indent/Hanging Indent with no inheritance. Hanging Indent can be defined with negative values. Read float.

Implemented in Aspose::Slides::ParagraphFormat.

◆ get_LatinLineBreak()

virtual NullableBool Aspose::Slides::IParagraphFormat::get_LatinLineBreak ( )
pure virtual

Determines whether the Latin line break is used in a paragraph. No inheritance applied. Read NullableBool.

Implemented in Aspose::Slides::ParagraphFormat.

◆ get_MarginLeft()

virtual float Aspose::Slides::IParagraphFormat::get_MarginLeft ( )
pure virtual

Returns the left margin in a paragraph with no inheritance. Read float.

Implemented in Aspose::Slides::ParagraphFormat.

◆ get_MarginRight()

virtual float Aspose::Slides::IParagraphFormat::get_MarginRight ( )
pure virtual

Returns the right margin in a paragraph with no inheritance. Read float.

Implemented in Aspose::Slides::ParagraphFormat.

◆ get_RightToLeft()

virtual NullableBool Aspose::Slides::IParagraphFormat::get_RightToLeft ( )
pure virtual

Determines whether the Right to Left writing is used in a paragraph. No inheritance applied. Read NullableBool.

Implemented in Aspose::Slides::ParagraphFormat.

◆ get_SpaceAfter()

virtual float Aspose::Slides::IParagraphFormat::get_SpaceAfter ( )
pure virtual

Returns the amount of space after the last line in a paragraph with no inheritance. A positive value specifies the percentage of the font size that the white space should be. A negative value specifies the size of the white space in point size. Read float.

Implemented in Aspose::Slides::ParagraphFormat.

◆ get_SpaceBefore()

virtual float Aspose::Slides::IParagraphFormat::get_SpaceBefore ( )
pure virtual

Returns the amount of space before the first line in a paragraph with no inheritance. A positive value specifies the percentage of the font size that the white space should be. A negative value specifies the size of the white space in point size. Read float.

Implemented in Aspose::Slides::ParagraphFormat.

◆ get_SpaceWithin()

virtual float Aspose::Slides::IParagraphFormat::get_SpaceWithin ( )
pure virtual

Returns the amount of space between base lines in a paragraph. Positive value means percentage, negative - size in points. No inheritance applied. Read float.

Implemented in Aspose::Slides::ParagraphFormat.

◆ get_Tabs()

virtual System::SharedPtr<ITabCollection> Aspose::Slides::IParagraphFormat::get_Tabs ( )
pure virtual

Returns tabulations of a paragraph. No inheritance applied. Read-only ITabCollection.

Implemented in Aspose::Slides::ParagraphFormat.

◆ GetEffective()

virtual System::SharedPtr<IParagraphFormatEffectiveData> Aspose::Slides::IParagraphFormat::GetEffective ( )
pure virtual

Gets effective paragraph formatting data with the inheritance applied.

Returns
A IParagraphFormatEffectiveData.

Implemented in Aspose::Slides::ParagraphFormat.

◆ set_Alignment()

virtual void Aspose::Slides::IParagraphFormat::set_Alignment ( TextAlignment  value)
pure virtual

Sets the text alignment in a paragraph with no inheritance. Write TextAlignment.

Implemented in Aspose::Slides::ParagraphFormat.

◆ set_DefaultTabSize()

virtual void Aspose::Slides::IParagraphFormat::set_DefaultTabSize ( float  value)
pure virtual

Sets default tabulation size with no inheritance. Write float.

Implemented in Aspose::Slides::ParagraphFormat.

◆ set_Depth()

virtual void Aspose::Slides::IParagraphFormat::set_Depth ( int16_t  value)
pure virtual

Sets depth of the paragraph. Value 0 means undefined value. Write int16_t.

◆ set_EastAsianLineBreak()

virtual void Aspose::Slides::IParagraphFormat::set_EastAsianLineBreak ( NullableBool  value)
pure virtual

Determines whether the East Asian line break is used in a paragraph. No inheritance applied. Write NullableBool.

Implemented in Aspose::Slides::ParagraphFormat.

◆ set_FontAlignment()

virtual void Aspose::Slides::IParagraphFormat::set_FontAlignment ( Aspose::Slides::FontAlignment  value)
pure virtual

Sets a font alignment in a paragraph with no inheritance. Write Slides::FontAlignment.

Implemented in Aspose::Slides::ParagraphFormat.

◆ set_HangingPunctuation()

virtual void Aspose::Slides::IParagraphFormat::set_HangingPunctuation ( NullableBool  value)
pure virtual

Determines whether the hanging punctuation is used in a paragraph. No inheritance applied. Write NullableBool.

Implemented in Aspose::Slides::ParagraphFormat.

◆ set_Indent()

virtual void Aspose::Slides::IParagraphFormat::set_Indent ( float  value)
pure virtual

Sets paragraph First Line Indent/Hanging Indent with no inheritance. Hanging Indent can be defined with negative values. Write float.

Implemented in Aspose::Slides::ParagraphFormat.

◆ set_LatinLineBreak()

virtual void Aspose::Slides::IParagraphFormat::set_LatinLineBreak ( NullableBool  value)
pure virtual

Determines whether the Latin line break is used in a paragraph. No inheritance applied. Write NullableBool.

Implemented in Aspose::Slides::ParagraphFormat.

◆ set_MarginLeft()

virtual void Aspose::Slides::IParagraphFormat::set_MarginLeft ( float  value)
pure virtual

Sets the left margin in a paragraph with no inheritance. Write float.

Implemented in Aspose::Slides::ParagraphFormat.

◆ set_MarginRight()

virtual void Aspose::Slides::IParagraphFormat::set_MarginRight ( float  value)
pure virtual

Sets the right margin in a paragraph with no inheritance. Write float.

Implemented in Aspose::Slides::ParagraphFormat.

◆ set_RightToLeft()

virtual void Aspose::Slides::IParagraphFormat::set_RightToLeft ( NullableBool  value)
pure virtual

Determines whether the Right to Left writing is used in a paragraph. No inheritance applied. Write NullableBool.

Implemented in Aspose::Slides::ParagraphFormat.

◆ set_SpaceAfter()

virtual void Aspose::Slides::IParagraphFormat::set_SpaceAfter ( float  value)
pure virtual

Sets the amount of space after the last line in a paragraph with no inheritance. A positive value specifies the percentage of the font size that the white space should be. A negative value specifies the size of the white space in point size. Write float.

Implemented in Aspose::Slides::ParagraphFormat.

◆ set_SpaceBefore()

virtual void Aspose::Slides::IParagraphFormat::set_SpaceBefore ( float  value)
pure virtual

Sets the amount of space before the first line in a paragraph with no inheritance. A positive value specifies the percentage of the font size that the white space should be. A negative value specifies the size of the white space in point size. Write float.

Implemented in Aspose::Slides::ParagraphFormat.

◆ set_SpaceWithin()

virtual void Aspose::Slides::IParagraphFormat::set_SpaceWithin ( float  value)
pure virtual

Sets the amount of space between base lines in a paragraph. Positive value means percentage, negative - size in points. No inheritance applied. Write float.

Implemented in Aspose::Slides::ParagraphFormat.