Aspose::Page::XPS::XpsModel::XpsGradientStop Class Referencefinal

Class incapsulating GradientStop element features. This element is used by both the LinearGradientBrush and RadialGradientBrush elements to define the location and range of color progression for rendering a gradient. More...

Inherits Aspose::Page::XPS::XpsModel::XpsObject.

Public Member Functions

ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsColorget_Color ()
 The gradient stop color. More...
 
ASPOSE_PAGE_SHARED_API float get_Offset () const
 Returns/sets the gradient offset. The offset indicates a point along the progression of the gradient at which a color is specified. Colors between gradient offsets in the progression are interpolated. More...
 
ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsGradientStopClone ()
 Clones this gradient stop. More...
 
- Public Member Functions inherited from Aspose::Page::XPS::XpsModel::XpsObject
ASPOSE_PAGE_SHARED_API void AssertObject ()
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API 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...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API 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 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)
 

Protected Member Functions

 XpsGradientStop (System::SharedPtr< XpsContext > context, System::SharedPtr< XpsColor > color, float offset)
 
 MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (XpsGradientStop, CODEPORTING_ARGS(System::SharedPtr< XpsContext > context, System::SharedPtr< XpsColor > color, float offset))
 
 XpsGradientStop (System::Drawing::Color color, float offset)
 
 MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (XpsGradientStop, CODEPORTING_ARGS(System::Drawing::Color color, float offset))
 
 XpsGradientStop (System::SharedPtr< XpsContext > context)
 
 MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (XpsGradientStop, CODEPORTING_ARGS(System::SharedPtr< XpsContext > context))
 
 XpsGradientStop (System::SharedPtr< System::Xml::XmlElement > element, System::SharedPtr< XpsContext > context)
 
 MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (XpsGradientStop, CODEPORTING_ARGS(System::SharedPtr< System::Xml::XmlElement > element, System::SharedPtr< XpsContext > context))
 
ASPOSE_PAGE_SHARED_API void Initialize (System::SharedPtr< System::Xml::XmlElement > element) override
 
ASPOSE_PAGE_SHARED_API void Accept (System::SharedPtr< XpsDocumentVisitor > visitor) override
 
ASPOSE_PAGE_SHARED_API System::SharedPtr< XpsObjectClone (bool deep, System::SharedPtr< XpsContext > context) override
 
ASPOSE_PAGE_SHARED_API void CopySimplePropertyValues (System::SharedPtr< XpsObject > obj) override
 
ASPOSE_PAGE_SHARED_API void ClonePropertyValues (System::SharedPtr< XpsObject > obj) override
 
ASPOSE_PAGE_SHARED_API void Dispose () override
 
virtual ASPOSE_PAGE_SHARED_API ~XpsGradientStop ()
 
- Protected Member Functions inherited from Aspose::Page::XPS::XpsModel::XpsObject
int32_t get_Id () const
 
System::String get_xKey () const
 
void set_xKey (System::String value)
 
System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< XpsObject > > > get_Owners ()
 
 XpsObject (System::SharedPtr< XpsContext > context)
 
virtual ASPOSE_PAGE_SHARED_API void ForceRegisterForPreprocessing (bool add=true)
 
virtual ASPOSE_PAGE_SHARED_API void RegisterForPreprocessing (System::SharedPtr< XpsElement > element, RegistrationType regType, bool add=true)
 
virtual ASPOSE_PAGE_SHARED_API void ForceRegisterForPreprocessingPV (bool add=true)
 
virtual ASPOSE_PAGE_SHARED_API void RegisterForPreprocessingPV (System::SharedPtr< XpsElement > element, RegistrationType regType, bool add=true)
 
virtual ASPOSE_PAGE_SHARED_API void CopyPropertyValues (System::SharedPtr< XpsObject > obj)
 
virtual ASPOSE_PAGE_SHARED_API void AcceptProperties (System::SharedPtr< XpsDocumentVisitor > visitor)
 

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...
 
- Protected Attributes inherited from Aspose::Page::XPS::XpsModel::XpsObject
System::WeakPtr< XpsContext_context
 
System::DynamicWeakPtr< System::Collections::Generic::List< System::SharedPtr< XpsObject > >, System::SmartPtrMode::Shared, 0 > _owners
 
System::String _xKey
 

Detailed Description

Class incapsulating GradientStop element features. This element is used by both the LinearGradientBrush and RadialGradientBrush elements to define the location and range of color progression for rendering a gradient.

Constructor & Destructor Documentation

◆ XpsGradientStop() [1/4]

Aspose::Page::XPS::XpsModel::XpsGradientStop::XpsGradientStop ( System::SharedPtr< XpsContext context,
System::SharedPtr< XpsColor color,
float  offset 
)
protected

◆ XpsGradientStop() [2/4]

Aspose::Page::XPS::XpsModel::XpsGradientStop::XpsGradientStop ( System::Drawing::Color  color,
float  offset 
)
protected

◆ XpsGradientStop() [3/4]

Aspose::Page::XPS::XpsModel::XpsGradientStop::XpsGradientStop ( System::SharedPtr< XpsContext context)
protected

◆ XpsGradientStop() [4/4]

Aspose::Page::XPS::XpsModel::XpsGradientStop::XpsGradientStop ( System::SharedPtr< System::Xml::XmlElement element,
System::SharedPtr< XpsContext context 
)
protected

◆ ~XpsGradientStop()

virtual ASPOSE_PAGE_SHARED_API Aspose::Page::XPS::XpsModel::XpsGradientStop::~XpsGradientStop ( )
protectedvirtual

Member Function Documentation

◆ Accept()

ASPOSE_PAGE_SHARED_API void Aspose::Page::XPS::XpsModel::XpsGradientStop::Accept ( System::SharedPtr< XpsDocumentVisitor visitor)
overrideprotectedvirtual

◆ Clone() [1/2]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsGradientStop> Aspose::Page::XPS::XpsModel::XpsGradientStop::Clone ( )

Clones this gradient stop.

Returns
Clone of this gradient stop.

◆ Clone() [2/2]

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsObject> Aspose::Page::XPS::XpsModel::XpsGradientStop::Clone ( bool  deep,
System::SharedPtr< XpsContext context 
)
overrideprotectedvirtual

◆ ClonePropertyValues()

ASPOSE_PAGE_SHARED_API void Aspose::Page::XPS::XpsModel::XpsGradientStop::ClonePropertyValues ( System::SharedPtr< XpsObject obj)
overrideprotectedvirtual

◆ CopySimplePropertyValues()

ASPOSE_PAGE_SHARED_API void Aspose::Page::XPS::XpsModel::XpsGradientStop::CopySimplePropertyValues ( System::SharedPtr< XpsObject obj)
overrideprotectedvirtual

◆ Dispose()

ASPOSE_PAGE_SHARED_API void Aspose::Page::XPS::XpsModel::XpsGradientStop::Dispose ( )
overrideprotectedvirtual

◆ get_Color()

ASPOSE_PAGE_SHARED_API System::SharedPtr<XpsColor> Aspose::Page::XPS::XpsModel::XpsGradientStop::get_Color ( )

The gradient stop color.

◆ get_Offset()

ASPOSE_PAGE_SHARED_API float Aspose::Page::XPS::XpsModel::XpsGradientStop::get_Offset ( ) const

Returns/sets the gradient offset. The offset indicates a point along the progression of the gradient at which a color is specified. Colors between gradient offsets in the progression are interpolated.

◆ Initialize()

ASPOSE_PAGE_SHARED_API void Aspose::Page::XPS::XpsModel::XpsGradientStop::Initialize ( System::SharedPtr< System::Xml::XmlElement element)
overrideprotectedvirtual

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION() [1/4]

Aspose::Page::XPS::XpsModel::XpsGradientStop::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION ( XpsGradientStop  ,
CODEPORTING_ARGS(System::SharedPtr< XpsContext > context, System::SharedPtr< XpsColor > color, float offset)   
)
protected

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION() [2/4]

Aspose::Page::XPS::XpsModel::XpsGradientStop::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION ( XpsGradientStop  ,
CODEPORTING_ARGS(System::Drawing::Color color, float offset)   
)
protected

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION() [3/4]

Aspose::Page::XPS::XpsModel::XpsGradientStop::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION ( XpsGradientStop  ,
CODEPORTING_ARGS(System::SharedPtr< XpsContext > context)   
)
protected

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION() [4/4]

Aspose::Page::XPS::XpsModel::XpsGradientStop::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION ( XpsGradientStop  ,
CODEPORTING_ARGS(System::SharedPtr< System::Xml::XmlElement > element, System::SharedPtr< XpsContext > context)   
)
protected