Aspose::Words::Drawing::Stroke Class Reference

Defines a stroke for a shape. More...

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

Inherits System::Object.

Public Member Functions

bool get_On ()
 Defines whether the path will be stroked. More...
 
void set_On (bool value)
 Setter for Aspose::Words::Drawing::Stroke::get_On. More...
 
double get_Weight ()
 Defines the brush thickness that strokes the path of a shape in points. More...
 
void set_Weight (double value)
 Setter for Aspose::Words::Drawing::Stroke::get_Weight. More...
 
System::Drawing::Color get_Color ()
 Defines the color of a stroke. More...
 
void set_Color (System::Drawing::Color value)
 Setter for Aspose::Words::Drawing::Stroke::get_Color. More...
 
System::Drawing::Color get_Color2 ()
 Defines a second color for a stroke. More...
 
void set_Color2 (System::Drawing::Color value)
 Setter for Aspose::Words::Drawing::Stroke::get_Color2. More...
 
Aspose::Words::Drawing::DashStyle get_DashStyle ()
 Specifies the dot and dash pattern for a stroke. More...
 
void set_DashStyle (Aspose::Words::Drawing::DashStyle value)
 Setter for Aspose::Words::Drawing::Stroke::get_DashStyle. More...
 
Aspose::Words::Drawing::JoinStyle get_JoinStyle ()
 Defines the join style of a polyline. More...
 
void set_JoinStyle (Aspose::Words::Drawing::JoinStyle value)
 Setter for Aspose::Words::Drawing::Stroke::get_JoinStyle. More...
 
Aspose::Words::Drawing::EndCap get_EndCap ()
 Defines the cap style for the end of a stroke. More...
 
void set_EndCap (Aspose::Words::Drawing::EndCap value)
 Setter for Aspose::Words::Drawing::Stroke::get_EndCap. More...
 
Aspose::Words::Drawing::ShapeLineStyle get_LineStyle ()
 Defines the line style of the stroke. More...
 
void set_LineStyle (Aspose::Words::Drawing::ShapeLineStyle value)
 Setter for Aspose::Words::Drawing::Stroke::get_LineStyle. More...
 
Aspose::Words::Drawing::ArrowType get_StartArrowType ()
 Defines the arrowhead for the start of a stroke. More...
 
void set_StartArrowType (Aspose::Words::Drawing::ArrowType value)
 Setter for Aspose::Words::Drawing::Stroke::get_StartArrowType. More...
 
Aspose::Words::Drawing::ArrowType get_EndArrowType ()
 Defines the arrowhead for the end of a stroke. More...
 
void set_EndArrowType (Aspose::Words::Drawing::ArrowType value)
 Setter for Aspose::Words::Drawing::Stroke::get_EndArrowType. More...
 
Aspose::Words::Drawing::ArrowWidth get_StartArrowWidth ()
 Defines the arrowhead width for the start of a stroke. More...
 
void set_StartArrowWidth (Aspose::Words::Drawing::ArrowWidth value)
 Setter for Aspose::Words::Drawing::Stroke::get_StartArrowWidth. More...
 
Aspose::Words::Drawing::ArrowLength get_StartArrowLength ()
 Defines the arrowhead length for the start of a stroke. More...
 
void set_StartArrowLength (Aspose::Words::Drawing::ArrowLength value)
 Setter for Aspose::Words::Drawing::Stroke::get_StartArrowLength. More...
 
Aspose::Words::Drawing::ArrowWidth get_EndArrowWidth ()
 Defines the arrowhead width for the end of a stroke. More...
 
void set_EndArrowWidth (Aspose::Words::Drawing::ArrowWidth value)
 Setter for Aspose::Words::Drawing::Stroke::get_EndArrowWidth. More...
 
Aspose::Words::Drawing::ArrowLength get_EndArrowLength ()
 Defines the arrowhead length for the end of a stroke. More...
 
void set_EndArrowLength (Aspose::Words::Drawing::ArrowLength value)
 Setter for Aspose::Words::Drawing::Stroke::get_EndArrowLength. More...
 
double get_Opacity ()
 Defines the amount of transparency of a stroke. Valid range is from 0 to 1. More...
 
void set_Opacity (double value)
 Setter for Aspose::Words::Drawing::Stroke::get_Opacity. More...
 
System::ArrayPtr< uint8_t > get_ImageBytes ()
 Defines the image for a stroke image or pattern fill. 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

Defines a stroke for a shape.

Use the Aspose::Words::Drawing::Shape::get_Stroke property to access stroke properties of a shape. You do not create instances of the Aspose::Words::Drawing::Stroke class directly.

See also
Aspose::Words::Drawing::Shape::get_Stroke

Member Function Documentation

◆ get_Color()

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

Defines the color of a stroke.

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

◆ get_Color2()

System::Drawing::Color Aspose::Words::Drawing::Stroke::get_Color2 ( )

Defines a second color for a stroke.

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

◆ get_DashStyle()

Aspose::Words::Drawing::DashStyle Aspose::Words::Drawing::Stroke::get_DashStyle ( )

Specifies the dot and dash pattern for a stroke.

The default value is Aspose::Words::Drawing::DashStyle::Solid.

◆ get_EndArrowLength()

Aspose::Words::Drawing::ArrowLength Aspose::Words::Drawing::Stroke::get_EndArrowLength ( )

Defines the arrowhead length for the end of a stroke.

The default value is Aspose::Words::Drawing::ArrowLength::Medium.

◆ get_EndArrowType()

Aspose::Words::Drawing::ArrowType Aspose::Words::Drawing::Stroke::get_EndArrowType ( )

Defines the arrowhead for the end of a stroke.

The default value is Aspose::Words::Drawing::ArrowType::None.

◆ get_EndArrowWidth()

Aspose::Words::Drawing::ArrowWidth Aspose::Words::Drawing::Stroke::get_EndArrowWidth ( )

Defines the arrowhead width for the end of a stroke.

The default value is Aspose::Words::Drawing::ArrowWidth::Medium.

◆ get_EndCap()

Aspose::Words::Drawing::EndCap Aspose::Words::Drawing::Stroke::get_EndCap ( )

Defines the cap style for the end of a stroke.

The default value is Aspose::Words::Drawing::EndCap::Flat.

◆ get_ImageBytes()

System::ArrayPtr<uint8_t> Aspose::Words::Drawing::Stroke::get_ImageBytes ( )

Defines the image for a stroke image or pattern fill.

◆ get_JoinStyle()

Aspose::Words::Drawing::JoinStyle Aspose::Words::Drawing::Stroke::get_JoinStyle ( )

Defines the join style of a polyline.

The default value is Aspose::Words::Drawing::JoinStyle::Round.

◆ get_LineStyle()

Aspose::Words::Drawing::ShapeLineStyle Aspose::Words::Drawing::Stroke::get_LineStyle ( )

Defines the line style of the stroke.

The default value is Aspose::Words::Drawing::ShapeLineStyle::Single.

◆ get_On()

bool Aspose::Words::Drawing::Stroke::get_On ( )

Defines whether the path will be stroked.

The default value is true.

◆ get_Opacity()

double Aspose::Words::Drawing::Stroke::get_Opacity ( )

Defines the amount of transparency of a stroke. Valid range is from 0 to 1.

The default value is 1.

◆ get_StartArrowLength()

Aspose::Words::Drawing::ArrowLength Aspose::Words::Drawing::Stroke::get_StartArrowLength ( )

Defines the arrowhead length for the start of a stroke.

The default value is Aspose::Words::Drawing::ArrowLength::Medium.

◆ get_StartArrowType()

Aspose::Words::Drawing::ArrowType Aspose::Words::Drawing::Stroke::get_StartArrowType ( )

Defines the arrowhead for the start of a stroke.

The default value is Aspose::Words::Drawing::ArrowType::None.

◆ get_StartArrowWidth()

Aspose::Words::Drawing::ArrowWidth Aspose::Words::Drawing::Stroke::get_StartArrowWidth ( )

Defines the arrowhead width for the start of a stroke.

The default value is Aspose::Words::Drawing::ArrowWidth::Medium.

◆ get_Weight()

double Aspose::Words::Drawing::Stroke::get_Weight ( )

Defines the brush thickness that strokes the path of a shape in points.

The default value is 0.75.

◆ set_Color()

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

◆ set_Color2()

void Aspose::Words::Drawing::Stroke::set_Color2 ( System::Drawing::Color  value)

◆ set_DashStyle()

void Aspose::Words::Drawing::Stroke::set_DashStyle ( Aspose::Words::Drawing::DashStyle  value)

◆ set_EndArrowLength()

void Aspose::Words::Drawing::Stroke::set_EndArrowLength ( Aspose::Words::Drawing::ArrowLength  value)

◆ set_EndArrowType()

void Aspose::Words::Drawing::Stroke::set_EndArrowType ( Aspose::Words::Drawing::ArrowType  value)

◆ set_EndArrowWidth()

void Aspose::Words::Drawing::Stroke::set_EndArrowWidth ( Aspose::Words::Drawing::ArrowWidth  value)

◆ set_EndCap()

void Aspose::Words::Drawing::Stroke::set_EndCap ( Aspose::Words::Drawing::EndCap  value)

◆ set_JoinStyle()

void Aspose::Words::Drawing::Stroke::set_JoinStyle ( Aspose::Words::Drawing::JoinStyle  value)

◆ set_LineStyle()

void Aspose::Words::Drawing::Stroke::set_LineStyle ( Aspose::Words::Drawing::ShapeLineStyle  value)

◆ set_On()

void Aspose::Words::Drawing::Stroke::set_On ( bool  value)

◆ set_Opacity()

void Aspose::Words::Drawing::Stroke::set_Opacity ( double  value)

◆ set_StartArrowLength()

void Aspose::Words::Drawing::Stroke::set_StartArrowLength ( Aspose::Words::Drawing::ArrowLength  value)

◆ set_StartArrowType()

void Aspose::Words::Drawing::Stroke::set_StartArrowType ( Aspose::Words::Drawing::ArrowType  value)

◆ set_StartArrowWidth()

void Aspose::Words::Drawing::Stroke::set_StartArrowWidth ( Aspose::Words::Drawing::ArrowWidth  value)

◆ set_Weight()

void Aspose::Words::Drawing::Stroke::set_Weight ( double  value)