IParagraphFormat

IParagraphFormat class

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

class IParagraphFormat : public virtual System::Object

Methods

MethodDescription
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 std::enable_if<!IsSmartPtr<T1>::value&&!IsSmartPtr<T2>::value, bool>::type Equals(T1 const&, T2 const&)Compares value 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.
virtual TextAlignment get_Alignment()Returns the text alignment in a paragraph with no inheritance. Read TextAlignment.
virtual System::SharedPtr<IBulletFormat> get_Bullet()Returns bullet format of the paragraph. Read-only IBulletFormat.
virtual System::SharedPtr<IPortionFormat> get_DefaultPortionFormat()Returns default portion format of a paragraph. No inheritance applied. Read-only IPortionFormat.
virtual float get_DefaultTabSize()Returns default tabulation size with no inheritance. Read float.
virtual int16_t get_Depth()Returns depth of the paragraph. Value 0 means undefined value. Read int16_t.
virtual NullableBool get_EastAsianLineBreak()Determines whether the East Asian line break is used in a paragraph. No inheritance applied. Read NullableBool.
virtual Aspose::Slides::FontAlignment get_FontAlignment()Returns a font alignment in a paragraph with no inheritance. Read Slides::FontAlignment.
virtual NullableBool get_HangingPunctuation()Determines whether the hanging punctuation is used in a paragraph. No inheritance applied. Read NullableBool.
virtual float get_Indent()Returns paragraph First Line Indent/Hanging Indent with no inheritance. Hanging Indent can be defined with negative values. Read float.
virtual NullableBool get_LatinLineBreak()Determines whether the Latin line break is used in a paragraph. No inheritance applied. Read NullableBool.
virtual float get_MarginLeft()Returns the left margin in a paragraph with no inheritance. Read float.
virtual float get_MarginRight()Returns the right margin in a paragraph with no inheritance. Read float.
virtual NullableBool get_RightToLeft()Determines whether the Right to Left writing is used in a paragraph. No inheritance applied. Read NullableBool.
virtual float get_SpaceAfter()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.
virtual float get_SpaceBefore()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.
virtual float get_SpaceWithin()Returns the amount of space between base lines in a paragraph. Positive value means percentage, negative - size in points. No inheritance applied. Read float.
virtual System::SharedPtr<ITab> get_Tab(int32_t)Returns the tabulation of a paragraph at the specified index. No inheritance applied. Read-only Aspose::Slides::ITab
virtual System::SharedPtr<ITabCollection> get_Tabs()Returns tabulations of a paragraph. No inheritance applied. Read-only ITabCollection.
Detail::SmartPtrCounter * GetCounter()Gets reference counter data structure associated with the object.
virtual System::SharedPtr<IParagraphFormatEffectiveData> GetEffective()Gets effective paragraph formatting data with the inheritance applied.
virtual int32_t GetHashCode() constAnalog of C# Object.GetHashCode() method. Enables hashing of custom objects.
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.
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.
virtual void set_Alignment(TextAlignment)Sets the text alignment in a paragraph with no inheritance. Write TextAlignment.
virtual void set_DefaultTabSize(float)Sets default tabulation size with no inheritance. Write float.
virtual void set_Depth(int16_t)Sets depth of the paragraph. Value 0 means undefined value. Write int16_t.
virtual void set_EastAsianLineBreak(NullableBool)Determines whether the East Asian line break is used in a paragraph. No inheritance applied. Write NullableBool.
virtual void set_FontAlignment(Aspose::Slides::FontAlignment)Sets a font alignment in a paragraph with no inheritance. Write Slides::FontAlignment.
virtual void set_HangingPunctuation(NullableBool)Determines whether the hanging punctuation is used in a paragraph. No inheritance applied. Write NullableBool.
virtual void set_Indent(float)Sets paragraph First Line Indent/Hanging Indent with no inheritance. Hanging Indent can be defined with negative values. Write float.
virtual void set_LatinLineBreak(NullableBool)Determines whether the Latin line break is used in a paragraph. No inheritance applied. Write NullableBool.
virtual void set_MarginLeft(float)Sets the left margin in a paragraph with no inheritance. Write float.
virtual void set_MarginRight(float)Sets the right margin in a paragraph with no inheritance. Write float.
virtual void set_RightToLeft(NullableBool)Determines whether the Right to Left writing is used in a paragraph. No inheritance applied. Write NullableBool.
virtual void set_SpaceAfter(float)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.
virtual void set_SpaceBefore(float)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.
virtual void set_SpaceWithin(float)Sets the amount of space between base lines in a paragraph. Positive value means percentage, negative - size in points. No inheritance applied. Write float.
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.
virtual ~Object()Destroys object. Frees all internal data structures.

Remarks

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.

See Also