Aspose::Words::Border Class Reference

Represents a border of an object. More...

#include "Aspose.Words.Cpp/Model/Borders/Border.h"

Inherits Aspose::Words::InternableComplexAttr, and IComplexAttr.

Public Member Functions

Aspose::Words::LineStyle get_LineStyle ()
 Gets or sets the border style. More...
 
void set_LineStyle (Aspose::Words::LineStyle value)
 Setter for Aspose::Words::Border::get_LineStyle. More...
 
double get_LineWidth ()
 Gets or sets the border width in points. More...
 
void set_LineWidth (double value)
 Setter for Aspose::Words::Border::get_LineWidth. More...
 
bool get_IsVisible ()
 Returns true if the LineStyle is not LineStyle.None. More...
 
System::Drawing::Color get_Color ()
 Gets or sets the border color. More...
 
void set_Color (System::Drawing::Color value)
 Setter for Aspose::Words::Border::get_Color. More...
 
double get_DistanceFromText ()
 Gets or sets distance of the border from text or from the page edge in points. More...
 
void set_DistanceFromText (double value)
 Setter for Aspose::Words::Border::get_DistanceFromText. More...
 
bool get_Shadow ()
 Gets or sets a value indicating whether the border has a shadow. More...
 
void set_Shadow (bool value)
 Setter for Aspose::Words::Border::get_Shadow. More...
 
bool get_IsInheritedComplexAttr ()
 
void ClearFormatting ()
 Resets border properties to default values. More...
 
bool Equals (System::SharedPtr< Aspose::Words::Border > rhs)
 Determines whether the specified border is equal in value to the current border. More...
 
virtual bool Equals (System::SharedPtr< System::Object > obj)
 Determines whether the specified object is equal in value to the current object. More...
 
virtual int32_t GetHashCode () const
 Serves as a hash function for this type. More...
 
System::SharedPtr< Aspose::Words::IComplexAttr > DeepCloneComplexAttr ()
 
- 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 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...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

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)
 

Detailed Description

Represents a border of an object.

Borders can be applied to various document elements including paragraph, run of text inside a paragraph or a table cell.

Member Function Documentation

◆ ClearFormatting()

void Aspose::Words::Border::ClearFormatting ( )

Resets border properties to default values.

When border properties are reset to default values, the border is invisible.

◆ DeepCloneComplexAttr()

System::SharedPtr<Aspose::Words::IComplexAttr> Aspose::Words::Border::DeepCloneComplexAttr ( )

◆ Equals() [1/2]

bool Aspose::Words::Border::Equals ( System::SharedPtr< Aspose::Words::Border rhs)

Determines whether the specified border is equal in value to the current border.

◆ Equals() [2/2]

virtual bool Aspose::Words::Border::Equals ( System::SharedPtr< System::Object obj)
virtual

Determines whether the specified object is equal in value to the current object.

◆ get_Color()

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

Gets or sets the border color.

◆ get_DistanceFromText()

double Aspose::Words::Border::get_DistanceFromText ( )

Gets or sets distance of the border from text or from the page edge in points.

Has no effect and will be automatically reset to zero for borders of table cells.

See also
Aspose::Words::PageSetup::get_BorderDistanceFrom

◆ get_IsInheritedComplexAttr()

bool Aspose::Words::Border::get_IsInheritedComplexAttr ( )

◆ get_IsVisible()

bool Aspose::Words::Border::get_IsVisible ( )

Returns true if the LineStyle is not LineStyle.None.

◆ get_LineStyle()

Aspose::Words::LineStyle Aspose::Words::Border::get_LineStyle ( )

Gets or sets the border style.

If you set line style to none, then line width is automatically changed to zero.

◆ get_LineWidth()

double Aspose::Words::Border::get_LineWidth ( )

Gets or sets the border width in points.

If you set line width greater than zero when line style is none, the line style is automatically changed to single line.

◆ get_Shadow()

bool Aspose::Words::Border::get_Shadow ( )

Gets or sets a value indicating whether the border has a shadow.

In Microsoft Word, for a border to have a shadow, the borders on all four sides (left, top, right and bottom) should be of the same type, width, color and all should have the Shadow property set to true.

◆ GetHashCode()

virtual int32_t Aspose::Words::Border::GetHashCode ( ) const
virtual

Serves as a hash function for this type.

Reimplemented from System::Object.

◆ set_Color()

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

◆ set_DistanceFromText()

void Aspose::Words::Border::set_DistanceFromText ( double  value)

◆ set_LineStyle()

void Aspose::Words::Border::set_LineStyle ( Aspose::Words::LineStyle  value)

◆ set_LineWidth()

void Aspose::Words::Border::set_LineWidth ( double  value)

◆ set_Shadow()

void Aspose::Words::Border::set_Shadow ( bool  value)