Aspose::Slides::BulletFormat Class Reference

Represents paragraph bullet formatting properties. More...

Inherits Aspose::Slides::PVIObject, and Aspose::Slides::IBulletFormat.

Public Member Functions

BulletType get_Type () override
 Returns the bullet type of a paragraph with no inheritance. Read BulletType. More...
 
void set_Type (BulletType value) override
 Sets the bullet type of a paragraph with no inheritance. Write BulletType. More...
 
char16_t get_Char () override
 Returns the bullet char of a paragraph with no inheritance. Read wchar_t. More...
 
void set_Char (char16_t value) override
 Sets the bullet char of a paragraph with no inheritance. Write wchar_t. More...
 
System::SharedPtr< IFontDataget_Font () override
 Returns the bullet font of a paragraph with no inheritance. Read IFontData. More...
 
void set_Font (System::SharedPtr< IFontData > value) override
 Sets the bullet font of a paragraph with no inheritance. Write IFontData. More...
 
float get_Height () override
 Returns the bullet height of a paragraph with no inheritance. Value std::numeric_limits<float>::quiet_NaN() determines that bullet inherits height from the first portion in the paragraph. Read float. More...
 
void set_Height (float value) override
 Sets the bullet height of a paragraph with no inheritance. Value std::numeric_limits<float>::quiet_NaN() determines that bullet inherits height from the first portion in the paragraph. Write float. More...
 
System::SharedPtr< IColorFormatget_Color () override
 Returns the color format of a bullet of a paragraph with no inheritance. Read-only IColorFormat. More...
 
int16_t get_NumberedBulletStartWith () override
 Returns the first number which is used for group of numbered bullets with no inheritance. Read int16_t. More...
 
void set_NumberedBulletStartWith (int16_t value) override
 Sets the first number which is used for group of numbered bullets with no inheritance. Write int16_t. More...
 
Aspose::Slides::NumberedBulletStyle get_NumberedBulletStyle () override
 Returns the style of a numbered bullet with no inheritance. Read Slides::NumberedBulletStyle. More...
 
void set_NumberedBulletStyle (Aspose::Slides::NumberedBulletStyle value) override
 Sets the style of a numbered bullet with no inheritance. Write Slides::NumberedBulletStyle. More...
 
NullableBool get_IsBulletHardColor () override
 Determines whether the bullet has own color or inherits it from the first portion in the paragraph. NullableBool::True if bullet has own color and NullableBool::False if bullet inherits color from the first portion in the paragraph. Read NullableBool. More...
 
void set_IsBulletHardColor (NullableBool value) override
 Determines whether the bullet has own color or inherits it from the first portion in the paragraph. NullableBool::True if bullet has own color and NullableBool::False if bullet inherits color from the first portion in the paragraph. Write NullableBool. More...
 
NullableBool get_IsBulletHardFont () override
 Determines whether the bullet has own font or inherits it from the first portion in the paragraph. NullableBool::True if bullet has own font and NullableBool::False if bullet inherits font from the first portion in the paragraph. Read NullableBool. More...
 
void set_IsBulletHardFont (NullableBool value) override
 Determines whether the bullet has own font or inherits it from the first portion in the paragraph. NullableBool::True if bullet has own font and NullableBool::False if bullet inherits font from the first portion in the paragraph. Write NullableBool. More...
 
System::SharedPtr< ISlidesPictureget_Picture () override
 Returns the picture used as a bullet in a paragraph with no inheritance. Read-only ISlidesPicture. More...
 
void ApplyDefaultParagraphIndentsShifts () override
 Sets default non-zero shifts for effective paragraph Indent and MarginLeft when bullets is enabled (like PowerPoint do if enable paragraph bullets/numbering in it). If bullets is disabled then just reset paragraph Indent and MarginLeft (like PowerPoint do if disable paragraph bullets/numbering in it). Indents shifts are applied in regard to current bullet context - IBulletFormat::get(set)_Type, .NumberedBulletStyle and FontHeight of first portion. Non-zero indents shifts are applied to effective Indent and MarginLeft of current paragraph (make result values to be local values). More...
 
System::SharedPtr< IBulletFormatEffectiveDataGetEffective () override
 Gets effective bullet formatting data with the inheritance applied. More...
 
- Public Member Functions inherited from Aspose::Slides::PVIObject
bool Equals (System::SharedPtr< System::Object > obj) override
 Compares with specified object. More...
 
int32_t GetHashCode () const override
 Returns hash code. More...
 
System::String ToString () const override
 Returns string representation. More...
 
- Public Member Functions inherited from Aspose::Slides::IPVIObject
virtual System::SharedPtr< IPresentationComponentget_Parent_IPresentationComponent ()=0
 Returns parent IPresentationComponent. Read-only IPresentationComponent. More...
 
- Public Member Functions inherited from Aspose::Slides::IDOMObject
virtual System::SharedPtr< IDOMObjectget_Parent_Immediate ()=0
 Returns Parent_Immediate object. Read-only IDOMObject. More...
 
virtual System::String get_DOMPath ()=0
 Returns DOM path. Read-only System::String. 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 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...
 

Protected Member Functions

uint32_t get_Version () override
 Version. Read-only uint32_t. More...
 
void CreateChildObjects () override
 
System::SharedPtr< System::ObjectCreateRealObject () override
 
virtual ~BulletFormat ()
 
- Protected Member Functions inherited from Aspose::Slides::PVIObject
virtual ~PVIObject ()
 

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

Represents paragraph bullet formatting properties.

Constructor & Destructor Documentation

◆ ~BulletFormat()

virtual Aspose::Slides::BulletFormat::~BulletFormat ( )
protectedvirtual

Member Function Documentation

◆ ApplyDefaultParagraphIndentsShifts()

void Aspose::Slides::BulletFormat::ApplyDefaultParagraphIndentsShifts ( )
overridevirtual

Sets default non-zero shifts for effective paragraph Indent and MarginLeft when bullets is enabled (like PowerPoint do if enable paragraph bullets/numbering in it). If bullets is disabled then just reset paragraph Indent and MarginLeft (like PowerPoint do if disable paragraph bullets/numbering in it). Indents shifts are applied in regard to current bullet context - IBulletFormat::get(set)_Type, .NumberedBulletStyle and FontHeight of first portion. Non-zero indents shifts are applied to effective Indent and MarginLeft of current paragraph (make result values to be local values).

Exceptions
System::InvalidOperationExceptionCalling this method doesn't matter and throw System::InvalidOperationException in following cases: if parent formatted object is not a paragraph (for example calling ITextStyle->get_DefaultParagraphFormat()->get_Bullet()->ApplyDefaultParagraphIndentsShifts() will throw exception); or if paragraph wasn't added to any ITextFrame->get_Paragraphs() collection (add it first);

Implements Aspose::Slides::IBulletFormat.

◆ CreateChildObjects()

void Aspose::Slides::BulletFormat::CreateChildObjects ( )
overrideprotected

◆ CreateRealObject()

System::SharedPtr<System::Object> Aspose::Slides::BulletFormat::CreateRealObject ( )
overrideprotected

◆ get_Char()

char16_t Aspose::Slides::BulletFormat::get_Char ( )
overridevirtual

Returns the bullet char of a paragraph with no inheritance. Read wchar_t.

Implements Aspose::Slides::IBulletFormat.

◆ get_Color()

System::SharedPtr<IColorFormat> Aspose::Slides::BulletFormat::get_Color ( )
overridevirtual

Returns the color format of a bullet of a paragraph with no inheritance. Read-only IColorFormat.

Implements Aspose::Slides::IBulletFormat.

◆ get_Font()

System::SharedPtr<IFontData> Aspose::Slides::BulletFormat::get_Font ( )
overridevirtual

Returns the bullet font of a paragraph with no inheritance. Read IFontData.

Implements Aspose::Slides::IBulletFormat.

◆ get_Height()

float Aspose::Slides::BulletFormat::get_Height ( )
overridevirtual

Returns the bullet height of a paragraph with no inheritance. Value std::numeric_limits<float>::quiet_NaN() determines that bullet inherits height from the first portion in the paragraph. Read float.

Implements Aspose::Slides::IBulletFormat.

◆ get_IsBulletHardColor()

NullableBool Aspose::Slides::BulletFormat::get_IsBulletHardColor ( )
overridevirtual

Determines whether the bullet has own color or inherits it from the first portion in the paragraph. NullableBool::True if bullet has own color and NullableBool::False if bullet inherits color from the first portion in the paragraph. Read NullableBool.

Implements Aspose::Slides::IBulletFormat.

◆ get_IsBulletHardFont()

NullableBool Aspose::Slides::BulletFormat::get_IsBulletHardFont ( )
overridevirtual

Determines whether the bullet has own font or inherits it from the first portion in the paragraph. NullableBool::True if bullet has own font and NullableBool::False if bullet inherits font from the first portion in the paragraph. Read NullableBool.

Implements Aspose::Slides::IBulletFormat.

◆ get_NumberedBulletStartWith()

int16_t Aspose::Slides::BulletFormat::get_NumberedBulletStartWith ( )
overridevirtual

Returns the first number which is used for group of numbered bullets with no inheritance. Read int16_t.

Implements Aspose::Slides::IBulletFormat.

◆ get_NumberedBulletStyle()

Aspose::Slides::NumberedBulletStyle Aspose::Slides::BulletFormat::get_NumberedBulletStyle ( )
overridevirtual

Returns the style of a numbered bullet with no inheritance. Read Slides::NumberedBulletStyle.

Implements Aspose::Slides::IBulletFormat.

◆ get_Picture()

System::SharedPtr<ISlidesPicture> Aspose::Slides::BulletFormat::get_Picture ( )
overridevirtual

Returns the picture used as a bullet in a paragraph with no inheritance. Read-only ISlidesPicture.

Implements Aspose::Slides::IBulletFormat.

◆ get_Type()

BulletType Aspose::Slides::BulletFormat::get_Type ( )
overridevirtual

Returns the bullet type of a paragraph with no inheritance. Read BulletType.

Implements Aspose::Slides::IBulletFormat.

◆ get_Version()

uint32_t Aspose::Slides::BulletFormat::get_Version ( )
overrideprotectedvirtual

Version. Read-only uint32_t.

Implements Aspose::Slides::IPVIObject.

◆ GetEffective()

System::SharedPtr<IBulletFormatEffectiveData> Aspose::Slides::BulletFormat::GetEffective ( )
overridevirtual

Gets effective bullet formatting data with the inheritance applied.

Returns
A IBulletFormatEffectiveData.

This example demonstrates getting some effective bullet format properties.

using namespace System;
using namespace Aspose::Slides;
auto pres = MakeObject<Presentation>(u"MyPresentation.pptx");
auto shape = DynamicCast_noexcept<Aspose::Slides::IAutoShape>(pres->get_Slides()->idx_get(0)->get_Shapes()->idx_get(0));
auto effectiveBulletFormat = shape->get_TextFrame()->get_Paragraphs()->idx_get(0)->get_ParagraphFormat()->get_Bullet()->GetEffective();
Console::WriteLine(String(u"Bullet type: ") + ObjectExt::ToString(effectiveBulletFormat->get_Type()));
if (effectiveBulletFormat->get_Type() == Aspose::Slides::BulletType::Numbered)
{
Console::WriteLine(String(u"Numbered style: ") + ObjectExt::ToString(effectiveBulletFormat->get_NumberedBulletStyle()));
Console::WriteLine(String(u"Starting number: ") + effectiveBulletFormat->get_NumberedBulletStartWith());
}
Definition: BuildVersionInfo.h:17
@ Numbered
Numbered bullets.
@ String
A string.
Definition: xpath_result_type.h:13
Definition: TrackedValueType.h:271

Implements Aspose::Slides::IBulletFormat.

◆ set_Char()

void Aspose::Slides::BulletFormat::set_Char ( char16_t  value)
overridevirtual

Sets the bullet char of a paragraph with no inheritance. Write wchar_t.

Implements Aspose::Slides::IBulletFormat.

◆ set_Font()

void Aspose::Slides::BulletFormat::set_Font ( System::SharedPtr< IFontData value)
overridevirtual

Sets the bullet font of a paragraph with no inheritance. Write IFontData.

Implements Aspose::Slides::IBulletFormat.

◆ set_Height()

void Aspose::Slides::BulletFormat::set_Height ( float  value)
overridevirtual

Sets the bullet height of a paragraph with no inheritance. Value std::numeric_limits<float>::quiet_NaN() determines that bullet inherits height from the first portion in the paragraph. Write float.

Implements Aspose::Slides::IBulletFormat.

◆ set_IsBulletHardColor()

void Aspose::Slides::BulletFormat::set_IsBulletHardColor ( NullableBool  value)
overridevirtual

Determines whether the bullet has own color or inherits it from the first portion in the paragraph. NullableBool::True if bullet has own color and NullableBool::False if bullet inherits color from the first portion in the paragraph. Write NullableBool.

Implements Aspose::Slides::IBulletFormat.

◆ set_IsBulletHardFont()

void Aspose::Slides::BulletFormat::set_IsBulletHardFont ( NullableBool  value)
overridevirtual

Determines whether the bullet has own font or inherits it from the first portion in the paragraph. NullableBool::True if bullet has own font and NullableBool::False if bullet inherits font from the first portion in the paragraph. Write NullableBool.

Implements Aspose::Slides::IBulletFormat.

◆ set_NumberedBulletStartWith()

void Aspose::Slides::BulletFormat::set_NumberedBulletStartWith ( int16_t  value)
overridevirtual

Sets the first number which is used for group of numbered bullets with no inheritance. Write int16_t.

Implements Aspose::Slides::IBulletFormat.

◆ set_NumberedBulletStyle()

void Aspose::Slides::BulletFormat::set_NumberedBulletStyle ( Aspose::Slides::NumberedBulletStyle  value)
overridevirtual

Sets the style of a numbered bullet with no inheritance. Write Slides::NumberedBulletStyle.

Implements Aspose::Slides::IBulletFormat.

◆ set_Type()

void Aspose::Slides::BulletFormat::set_Type ( BulletType  value)
overridevirtual

Sets the bullet type of a paragraph with no inheritance. Write BulletType.

Implements Aspose::Slides::IBulletFormat.