ParagraphFormat

ParagraphFormat class

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

class ParagraphFormat : public Aspose::Slides::PVIObject,
                        public Aspose::Slides::IParagraphFormat,
                        public Aspose::Slides::Charts::IChartParagraphFormat

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.
TextAlignment get_Alignment() overrideReturns the text alignment in a paragraph with no inheritance. Read TextAlignment.
float get_DefaultTabSize() overrideReturns default tabulation size with no inheritance. Read float.
NullableBool get_EastAsianLineBreak() overrideDetermines whether the East Asian line break is used in a paragraph. No inheritance applied. Read NullableBool.
Aspose::Slides::FontAlignment get_FontAlignment() overrideReturns a font alignment in a paragraph with no inheritance. Read Slides::FontAlignment.
NullableBool get_HangingPunctuation() overrideDetermines whether the hanging punctuation is used in a paragraph. No inheritance applied. Read NullableBool.
float get_Indent() overrideReturns paragraph First Line Indent/Hanging Indent with no inheritance. Hanging Indent can be defined with negative values. Read float.
NullableBool get_LatinLineBreak() overrideDetermines whether the Latin line break is used in a paragraph. No inheritance applied. Read NullableBool.
float get_MarginLeft() overrideReturns the left margin in a paragraph with no inheritance. Read float.
float get_MarginRight() overrideReturns the right margin in a paragraph with no inheritance. Read float.
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_RightToLeft() overrideDetermines whether the Right to Left writing is used in a paragraph. No inheritance applied. Read NullableBool.
float get_SpaceAfter() overrideReturns 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.
float get_SpaceBefore() overrideReturns 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.
float get_SpaceWithin() overrideReturns the amount of space between base lines in a paragraph. Positive value means percentage, negative - size in points. No inheritance applied. Read float.
System::SharedPtr<ITab> get_Tab(int32_t) overrideReturns the tabulation of a paragraph at the specified index. No inheritance applied. Read-only Aspose::Slides::ITab
System::SharedPtr<ITabCollection> get_Tabs() overrideReturns tabulations of a paragraph. No inheritance applied. Read-only ITabCollection.
Detail::SmartPtrCounter * GetCounter()Gets reference counter data structure associated with the object.
System::SharedPtr<IParagraphFormatEffectiveData> GetEffective() overrideGets effective paragraph 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.
ParagraphFormat()Initializes a new instance of ParagraphFormat 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_Alignment(TextAlignment) overrideSets the text alignment in a paragraph with no inheritance. Write TextAlignment.
void set_DefaultTabSize(float) overrideSets default tabulation size with no inheritance. Write float.
void set_EastAsianLineBreak(NullableBool) overrideDetermines whether the East Asian line break is used in a paragraph. No inheritance applied. Write NullableBool.
void set_FontAlignment(Aspose::Slides::FontAlignment) overrideSets a font alignment in a paragraph with no inheritance. Write Slides::FontAlignment.
void set_HangingPunctuation(NullableBool) overrideDetermines whether the hanging punctuation is used in a paragraph. No inheritance applied. Write NullableBool.
void set_Indent(float) overrideSets paragraph First Line Indent/Hanging Indent with no inheritance. Hanging Indent can be defined with negative values. Write float.
void set_LatinLineBreak(NullableBool) overrideDetermines whether the Latin line break is used in a paragraph. No inheritance applied. Write NullableBool.
void set_MarginLeft(float) overrideSets the left margin in a paragraph with no inheritance. Write float.
void set_MarginRight(float) overrideSets the right margin in a paragraph with no inheritance. Write float.
void set_RightToLeft(NullableBool) overrideDetermines whether the Right to Left writing is used in a paragraph. No inheritance applied. Write NullableBool.
void set_SpaceAfter(float) overrideSets 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.
void set_SpaceBefore(float) overrideSets 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.
void set_SpaceWithin(float) overrideSets 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.
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 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 ParagraphFormat::GetEffective method which returns a IParagraphFormatEffectiveData instance.

See Also

ParagraphFactory PathSegment