Aspose::Words::Drawing::HorizontalRuleFormat Class Reference

Represents horizontal rule formatting. More...

#include "Aspose.Words.Cpp/Model/Drawing/HorizontalRuleFormat.h"

Inherits System::Object.

Public Member Functions

double get_WidthPercent ()
 Gets or sets the length of the specified horizontal rule expressed as a percentage of the window width. More...
 
void set_WidthPercent (double value)
 Setter for Aspose::Words::Drawing::HorizontalRuleFormat::get_WidthPercent. More...
 
double get_Height ()
 Gets or sets the height of the horizontal rule. More...
 
void set_Height (double value)
 Setter for Aspose::Words::Drawing::HorizontalRuleFormat::get_Height. More...
 
bool get_NoShade ()
 Indicates the presence of 3D shading for the horizontal rule. If true, then the horizontal rule is without 3D shading and solid color is used. More...
 
void set_NoShade (bool value)
 Setter for Aspose::Words::Drawing::HorizontalRuleFormat::get_NoShade. More...
 
System::Drawing::Color get_Color ()
 Gets or sets the brush color that fills the horizontal rule. More...
 
void set_Color (System::Drawing::Color value)
 Setter for Aspose::Words::Drawing::HorizontalRuleFormat::get_Color. More...
 
Aspose::Words::Drawing::HorizontalRuleAlignment get_Alignment ()
 Gets or sets the alignment of the horizontal rule. More...
 
void set_Alignment (Aspose::Words::Drawing::HorizontalRuleAlignment value)
 Setter for Aspose::Words::Drawing::HorizontalRuleFormat::get_Alignment. 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 int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. 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...
 

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

Detailed Description

Represents horizontal rule formatting.

Member Function Documentation

◆ get_Alignment()

Aspose::Words::Drawing::HorizontalRuleAlignment Aspose::Words::Drawing::HorizontalRuleFormat::get_Alignment ( )

Gets or sets the alignment of the horizontal rule.

The default value is Aspose::Words::Drawing::HorizontalRuleAlignment::Left.

◆ get_Color()

System::Drawing::Color Aspose::Words::Drawing::HorizontalRuleFormat::get_Color ( )

Gets or sets the brush color that fills the horizontal rule.

This is a shortcut to the Aspose::Words::Drawing::Fill::get_Color property.

The default value is System::Drawing::Color::get_Gray.

◆ get_Height()

double Aspose::Words::Drawing::HorizontalRuleFormat::get_Height ( )

Gets or sets the height of the horizontal rule.

This is a shortcut to the Aspose::Words::Drawing::ShapeBase::get_Height property.

Valid values ??range from 0 to 1584 inclusive.

The default value is 1.5.

Exceptions
T:System.ArgumentOutOfRangeExceptionThrows when argument was out of the range of valid values.

◆ get_NoShade()

bool Aspose::Words::Drawing::HorizontalRuleFormat::get_NoShade ( )

Indicates the presence of 3D shading for the horizontal rule. If true, then the horizontal rule is without 3D shading and solid color is used.

The default value is false.

◆ get_WidthPercent()

double Aspose::Words::Drawing::HorizontalRuleFormat::get_WidthPercent ( )

Gets or sets the length of the specified horizontal rule expressed as a percentage of the window width.

Valid values ??range from 1 to 100 inclusive.

The default value is 100.

Exceptions
T:System.ArgumentOutOfRangeExceptionThrows when argument was out of the range of valid values.

◆ set_Alignment()

void Aspose::Words::Drawing::HorizontalRuleFormat::set_Alignment ( Aspose::Words::Drawing::HorizontalRuleAlignment  value)

◆ set_Color()

void Aspose::Words::Drawing::HorizontalRuleFormat::set_Color ( System::Drawing::Color  value)

◆ set_Height()

void Aspose::Words::Drawing::HorizontalRuleFormat::set_Height ( double  value)

◆ set_NoShade()

void Aspose::Words::Drawing::HorizontalRuleFormat::set_NoShade ( bool  value)

◆ set_WidthPercent()

void Aspose::Words::Drawing::HorizontalRuleFormat::set_WidthPercent ( double  value)