Aspose::Words::BorderCollection Class Referencefinal

A collection of Border objects. More...

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

Inherits IEnumerable< System::SharedPtr< Aspose::Words::Border > >.

Public Member Functions

System::SharedPtr< Aspose::Words::Borderget_Left ()
 Gets the left border. More...
 
System::SharedPtr< Aspose::Words::Borderget_Right ()
 Gets the right border. More...
 
System::SharedPtr< Aspose::Words::Borderget_Top ()
 Gets the top border. More...
 
System::SharedPtr< Aspose::Words::Borderget_Bottom ()
 Gets the bottom border. More...
 
System::SharedPtr< Aspose::Words::Borderget_Horizontal ()
 Gets the horizontal border that is used between cells or conforming paragraphs. More...
 
System::SharedPtr< Aspose::Words::Borderget_Vertical ()
 Gets the vertical border that is used between cells. More...
 
int32_t get_Count ()
 Gets the number of borders in the collection. More...
 
double get_LineWidth ()
 Gets or sets the border width in points. More...
 
void set_LineWidth (double value)
 Setter for Aspose::Words::BorderCollection::get_LineWidth. More...
 
Aspose::Words::LineStyle get_LineStyle ()
 Gets or sets the border style. More...
 
void set_LineStyle (Aspose::Words::LineStyle value)
 Setter for Aspose::Words::BorderCollection::get_LineStyle. More...
 
System::Drawing::Color get_Color ()
 Gets or sets the border color. More...
 
void set_Color (System::Drawing::Color value)
 Setter for Aspose::Words::BorderCollection::get_Color. More...
 
double get_DistanceFromText ()
 Gets or sets distance of the border from text in points. More...
 
void set_DistanceFromText (double value)
 Setter for Aspose::Words::BorderCollection::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::BorderCollection::get_Shadow. More...
 
bool Equals (System::SharedPtr< Aspose::Words::BorderCollection > brColl)
 Compares collections of borders. More...
 
System::SharedPtr< Aspose::Words::Borderidx_get (Aspose::Words::BorderType borderType)
 Retrieves a Border object by border type. More...
 
System::SharedPtr< Aspose::Words::Borderidx_get (int32_t index)
 Retrieves a Border object by index. More...
 
void ClearFormatting ()
 Removes all borders of an object. More...
 
System::SharedPtr< System::Collections::Generic::IEnumerator< System::SharedPtr< Aspose::Words::Border > > > GetEnumerator ()
 Returns an enumerator object that can be used to iterate over all borders in the collection. More...
 

Detailed Description

A collection of Border objects.

Different document elements have different borders. For example, ParagraphFormat has Bottom, Left, Right and Top borders. You can specify different formatting for each border independently or enumerate through all borders and apply same formatting.

Member Function Documentation

◆ ClearFormatting()

void Aspose::Words::BorderCollection::ClearFormatting ( )

Removes all borders of an object.

◆ Equals()

bool Aspose::Words::BorderCollection::Equals ( System::SharedPtr< Aspose::Words::BorderCollection brColl)

Compares collections of borders.

◆ get_Bottom()

System::SharedPtr<Aspose::Words::Border> Aspose::Words::BorderCollection::get_Bottom ( )

Gets the bottom border.

◆ get_Color()

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

Gets or sets the border color.

Returns the color of the first border in the collection.

Sets the color of all borders in the collection excluding diagonal borders.

◆ get_Count()

int32_t Aspose::Words::BorderCollection::get_Count ( )

Gets the number of borders in the collection.

◆ get_DistanceFromText()

double Aspose::Words::BorderCollection::get_DistanceFromText ( )

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

Gets the distance from text for the first border.

Sets the distance from text for all borders in the collection excluding diagonal borders.

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

◆ get_Horizontal()

System::SharedPtr<Aspose::Words::Border> Aspose::Words::BorderCollection::get_Horizontal ( )

Gets the horizontal border that is used between cells or conforming paragraphs.

◆ get_Left()

System::SharedPtr<Aspose::Words::Border> Aspose::Words::BorderCollection::get_Left ( )

Gets the left border.

◆ get_LineStyle()

Aspose::Words::LineStyle Aspose::Words::BorderCollection::get_LineStyle ( )

Gets or sets the border style.

Returns the style of the first border in the collection.

Sets the style of all borders in the collection excluding diagonal borders.

◆ get_LineWidth()

double Aspose::Words::BorderCollection::get_LineWidth ( )

Gets or sets the border width in points.

Returns the width of the first border in the collection.

Sets the width of all borders in the collection excluding diagonal borders.

◆ get_Right()

System::SharedPtr<Aspose::Words::Border> Aspose::Words::BorderCollection::get_Right ( )

Gets the right border.

◆ get_Shadow()

bool Aspose::Words::BorderCollection::get_Shadow ( )

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

Gets the value from the first border in the collection.

Sets the value for all borders in the collection excluding diagonal borders.

◆ get_Top()

System::SharedPtr<Aspose::Words::Border> Aspose::Words::BorderCollection::get_Top ( )

Gets the top border.

◆ get_Vertical()

System::SharedPtr<Aspose::Words::Border> Aspose::Words::BorderCollection::get_Vertical ( )

Gets the vertical border that is used between cells.

◆ GetEnumerator()

System::SharedPtr<System::Collections::Generic::IEnumerator<System::SharedPtr<Aspose::Words::Border> > > Aspose::Words::BorderCollection::GetEnumerator ( )

Returns an enumerator object that can be used to iterate over all borders in the collection.

◆ idx_get() [1/2]

System::SharedPtr<Aspose::Words::Border> Aspose::Words::BorderCollection::idx_get ( Aspose::Words::BorderType  borderType)

Retrieves a Border object by border type.

Note that not all borders are present for different document elements. This method throws an exception if you request a border not applicable to the current object.

Parameters
borderTypeA Aspose::Words::BorderType value that specifies the type of the border to retrieve.

◆ idx_get() [2/2]

System::SharedPtr<Aspose::Words::Border> Aspose::Words::BorderCollection::idx_get ( int32_t  index)

Retrieves a Border object by index.

Parameters
indexZero-based index of the border to retrieve.

◆ set_Color()

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

◆ set_DistanceFromText()

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

◆ set_LineStyle()

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

◆ set_LineWidth()

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

◆ set_Shadow()

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