Aspose::Slides::ColorFormat Class Reference

Represents a color used in a presentation. More...

Inherits Aspose::Slides::PVIObject, and Aspose::Slides::IColorFormat.

Public Member Functions

Aspose::Slides::ColorType get_ColorType () override
 Returns the color definition method. Read Slides::ColorType. More...
 
void set_ColorType (Aspose::Slides::ColorType value) override
 Sets the color definition method. Write Slides::ColorType. More...
 
System::Drawing::Color get_Color () override
 Returns resulting color (with all color transformations applied). Sets RGB colors and clears all color transformations. Read System::Drawing::Color. More...
 
void set_Color (System::Drawing::Color value) override
 Returns resulting color (with all color transformations applied). Sets RGB colors and clears all color transformations. Write System::Drawing::Color. More...
 
Aspose::Slides::PresetColor get_PresetColor () override
 Returns the color preset. Read Slides::PresetColor. More...
 
void set_PresetColor (Aspose::Slides::PresetColor value) override
 Sets the color preset. Write Slides::PresetColor. More...
 
Aspose::Slides::SystemColor get_SystemColor () override
 Returns the color identified by the system color table. Read Slides::SystemColor. More...
 
void set_SystemColor (Aspose::Slides::SystemColor value) override
 Sets the color identified by the system color table. Write Slides::SystemColor. More...
 
Aspose::Slides::SchemeColor get_SchemeColor () override
 Returns the color identified by a color scheme. Read Slides::SchemeColor. More...
 
void set_SchemeColor (Aspose::Slides::SchemeColor value) override
 Sets the color identified by a color scheme. Write Slides::SchemeColor. More...
 
uint8_t get_R () override
 Returns the red component of a color. All color transformations are ignored. Read uint8_t. More...
 
void set_R (uint8_t value) override
 Sets the red component of a color. All color transformations are ignored. Write uint8_t. More...
 
uint8_t get_G () override
 Returns the green component of a color. All color transformations are ignored. More...
 
void set_G (uint8_t value) override
 Sets the green component of a color. All color transformations are ignored. More...
 
uint8_t get_B () override
 Returns the blue component of a color. All color transformations are ignored. Read uint8_t. More...
 
void set_B (uint8_t value) override
 Sets the blue component of a color. All color transformations are ignored. Write uint8_t. More...
 
float get_FloatR () override
 Returns the red component of a color. All color transformations are ignored. Read float. More...
 
void set_FloatR (float value) override
 Sets the red component of a color. All color transformations are ignored. Write float. More...
 
float get_FloatG () override
 Returns the green component of a color. All color transformations are ignored. Read float. More...
 
void set_FloatG (float value) override
 Sets the green component of a color. All color transformations are ignored. Write float. More...
 
float get_FloatB () override
 Returns the blue component of a color. All color transformations are ignored. Read float. More...
 
void set_FloatB (float value) override
 Sets the blue component of a color. All color transformations are ignored. Write float. More...
 
float get_Hue () override
 Returns the hue component of a color in HSL representation. All color transformations are ignored. Read float. More...
 
void set_Hue (float value) override
 Sets the hue component of a color in HSL representation. All color transformations are ignored. Write float. More...
 
float get_Saturation () override
 Returns the saturation component of a color in HSL representation. All color transformations are ignored. Read float. More...
 
void set_Saturation (float value) override
 Sets the saturation component of a color in HSL representation. All color transformations are ignored. Write float. More...
 
float get_Luminance () override
 Returns the luminance component of a color in HSL representation. All color transformations are ignored. Read float. More...
 
void set_Luminance (float value) override
 Sets the luminance component of a color in HSL representation. All color transformations are ignored. Write float. More...
 
System::SharedPtr< IColorOperationCollectionget_ColorTransform () override
 Returns the collection of color transformations applied to a color. Read-only IColorOperationCollection. More...
 
System::String ToString (ColorStringFormat format) override
 Returns a System::String that represents the current color format. More...
 
void CopyFrom (System::SharedPtr< IColorFormat > color) override
 Copy color format from "color". More...
 
bool Equals (System::SharedPtr< System::Object > obj) override
 Checks for equality with specified object. More...
 
int32_t GetHashCode () const override
 Returns hash code. More...
 
- Public Member Functions inherited from Aspose::Slides::PVIObject
bool Equals (System::SharedPtr< System::Object > obj) override
 Compares with specified object. More...
 
int32_t GetHashCode () const override
 Returns hash code. More...
 
System::String ToString () const override
 Returns string representation. More...
 
- Public Member Functions inherited from Aspose::Slides::IPVIObject
virtual System::SharedPtr< IPresentationComponentget_Parent_IPresentationComponent ()=0
 Returns parent IPresentationComponent. Read-only IPresentationComponent. More...
 
virtual uint32_t get_Version ()=0
 Version. Read-only uint32_t. More...
 
- Public Member Functions inherited from Aspose::Slides::IDOMObject
virtual System::SharedPtr< IDOMObjectget_Parent_Immediate ()=0
 Returns Parent_Immediate object. Read-only IDOMObject. More...
 
virtual System::String get_DOMPath ()=0
 Returns DOM path. Read-only System::String. 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 reference 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 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 (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Protected Member Functions

void CreateChildObjects () override
 
System::SharedPtr< System::ObjectCreateRealObject () override
 
virtual ~ColorFormat ()
 
- Protected Member Functions inherited from Aspose::Slides::PVIObject
virtual ~PVIObject ()
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. 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 ()
 Implements C# typeof(System.Object) construct. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 

Detailed Description

Represents a color used in a presentation.

Constructor & Destructor Documentation

◆ ~ColorFormat()

virtual Aspose::Slides::ColorFormat::~ColorFormat ( )
protectedvirtual

Member Function Documentation

◆ CopyFrom()

void Aspose::Slides::ColorFormat::CopyFrom ( System::SharedPtr< IColorFormat color)
overridevirtual

Copy color format from "color".

Implements Aspose::Slides::IColorFormat.

◆ CreateChildObjects()

void Aspose::Slides::ColorFormat::CreateChildObjects ( )
overrideprotected

◆ CreateRealObject()

System::SharedPtr<System::Object> Aspose::Slides::ColorFormat::CreateRealObject ( )
overrideprotected

◆ Equals()

bool Aspose::Slides::ColorFormat::Equals ( System::SharedPtr< System::Object obj)
override

Checks for equality with specified object.

Parameters
objObject.
Returns
True if objects are equal, otherwise false.

◆ get_B()

uint8_t Aspose::Slides::ColorFormat::get_B ( )
overridevirtual

Returns the blue component of a color. All color transformations are ignored. Read uint8_t.

Implements Aspose::Slides::IColorFormat.

◆ get_Color()

System::Drawing::Color Aspose::Slides::ColorFormat::get_Color ( )
overridevirtual

Returns resulting color (with all color transformations applied). Sets RGB colors and clears all color transformations. Read System::Drawing::Color.

Implements Aspose::Slides::IColorFormat.

◆ get_ColorTransform()

System::SharedPtr<IColorOperationCollection> Aspose::Slides::ColorFormat::get_ColorTransform ( )
overridevirtual

Returns the collection of color transformations applied to a color. Read-only IColorOperationCollection.

Implements Aspose::Slides::IColorFormat.

◆ get_ColorType()

Aspose::Slides::ColorType Aspose::Slides::ColorFormat::get_ColorType ( )
overridevirtual

Returns the color definition method. Read Slides::ColorType.

Implements Aspose::Slides::IColorFormat.

◆ get_FloatB()

float Aspose::Slides::ColorFormat::get_FloatB ( )
overridevirtual

Returns the blue component of a color. All color transformations are ignored. Read float.

Implements Aspose::Slides::IColorFormat.

◆ get_FloatG()

float Aspose::Slides::ColorFormat::get_FloatG ( )
overridevirtual

Returns the green component of a color. All color transformations are ignored. Read float.

Implements Aspose::Slides::IColorFormat.

◆ get_FloatR()

float Aspose::Slides::ColorFormat::get_FloatR ( )
overridevirtual

Returns the red component of a color. All color transformations are ignored. Read float.

Implements Aspose::Slides::IColorFormat.

◆ get_G()

uint8_t Aspose::Slides::ColorFormat::get_G ( )
overridevirtual

Returns the green component of a color. All color transformations are ignored.

Implements Aspose::Slides::IColorFormat.

◆ get_Hue()

float Aspose::Slides::ColorFormat::get_Hue ( )
overridevirtual

Returns the hue component of a color in HSL representation. All color transformations are ignored. Read float.

Implements Aspose::Slides::IColorFormat.

◆ get_Luminance()

float Aspose::Slides::ColorFormat::get_Luminance ( )
overridevirtual

Returns the luminance component of a color in HSL representation. All color transformations are ignored. Read float.

Implements Aspose::Slides::IColorFormat.

◆ get_PresetColor()

Aspose::Slides::PresetColor Aspose::Slides::ColorFormat::get_PresetColor ( )
overridevirtual

Returns the color preset. Read Slides::PresetColor.

Implements Aspose::Slides::IColorFormat.

◆ get_R()

uint8_t Aspose::Slides::ColorFormat::get_R ( )
overridevirtual

Returns the red component of a color. All color transformations are ignored. Read uint8_t.

Implements Aspose::Slides::IColorFormat.

◆ get_Saturation()

float Aspose::Slides::ColorFormat::get_Saturation ( )
overridevirtual

Returns the saturation component of a color in HSL representation. All color transformations are ignored. Read float.

Implements Aspose::Slides::IColorFormat.

◆ get_SchemeColor()

Aspose::Slides::SchemeColor Aspose::Slides::ColorFormat::get_SchemeColor ( )
overridevirtual

Returns the color identified by a color scheme. Read Slides::SchemeColor.

Implements Aspose::Slides::IColorFormat.

◆ get_SystemColor()

Aspose::Slides::SystemColor Aspose::Slides::ColorFormat::get_SystemColor ( )
overridevirtual

Returns the color identified by the system color table. Read Slides::SystemColor.

Implements Aspose::Slides::IColorFormat.

◆ GetHashCode()

int32_t Aspose::Slides::ColorFormat::GetHashCode ( ) const
overridevirtual

Returns hash code.

Returns
Hash code.

Reimplemented from System::Object.

◆ set_B()

void Aspose::Slides::ColorFormat::set_B ( uint8_t  value)
overridevirtual

Sets the blue component of a color. All color transformations are ignored. Write uint8_t.

Implements Aspose::Slides::IColorFormat.

◆ set_Color()

void Aspose::Slides::ColorFormat::set_Color ( System::Drawing::Color  value)
overridevirtual

Returns resulting color (with all color transformations applied). Sets RGB colors and clears all color transformations. Write System::Drawing::Color.

Implements Aspose::Slides::IColorFormat.

◆ set_ColorType()

void Aspose::Slides::ColorFormat::set_ColorType ( Aspose::Slides::ColorType  value)
overridevirtual

Sets the color definition method. Write Slides::ColorType.

Implements Aspose::Slides::IColorFormat.

◆ set_FloatB()

void Aspose::Slides::ColorFormat::set_FloatB ( float  value)
overridevirtual

Sets the blue component of a color. All color transformations are ignored. Write float.

Implements Aspose::Slides::IColorFormat.

◆ set_FloatG()

void Aspose::Slides::ColorFormat::set_FloatG ( float  value)
overridevirtual

Sets the green component of a color. All color transformations are ignored. Write float.

Implements Aspose::Slides::IColorFormat.

◆ set_FloatR()

void Aspose::Slides::ColorFormat::set_FloatR ( float  value)
overridevirtual

Sets the red component of a color. All color transformations are ignored. Write float.

Implements Aspose::Slides::IColorFormat.

◆ set_G()

void Aspose::Slides::ColorFormat::set_G ( uint8_t  value)
overridevirtual

Sets the green component of a color. All color transformations are ignored.

Implements Aspose::Slides::IColorFormat.

◆ set_Hue()

void Aspose::Slides::ColorFormat::set_Hue ( float  value)
overridevirtual

Sets the hue component of a color in HSL representation. All color transformations are ignored. Write float.

Implements Aspose::Slides::IColorFormat.

◆ set_Luminance()

void Aspose::Slides::ColorFormat::set_Luminance ( float  value)
overridevirtual

Sets the luminance component of a color in HSL representation. All color transformations are ignored. Write float.

Implements Aspose::Slides::IColorFormat.

◆ set_PresetColor()

void Aspose::Slides::ColorFormat::set_PresetColor ( Aspose::Slides::PresetColor  value)
overridevirtual

Sets the color preset. Write Slides::PresetColor.

Implements Aspose::Slides::IColorFormat.

◆ set_R()

void Aspose::Slides::ColorFormat::set_R ( uint8_t  value)
overridevirtual

Sets the red component of a color. All color transformations are ignored. Write uint8_t.

Implements Aspose::Slides::IColorFormat.

◆ set_Saturation()

void Aspose::Slides::ColorFormat::set_Saturation ( float  value)
overridevirtual

Sets the saturation component of a color in HSL representation. All color transformations are ignored. Write float.

Implements Aspose::Slides::IColorFormat.

◆ set_SchemeColor()

void Aspose::Slides::ColorFormat::set_SchemeColor ( Aspose::Slides::SchemeColor  value)
overridevirtual

Sets the color identified by a color scheme. Write Slides::SchemeColor.

Implements Aspose::Slides::IColorFormat.

◆ set_SystemColor()

void Aspose::Slides::ColorFormat::set_SystemColor ( Aspose::Slides::SystemColor  value)
overridevirtual

Sets the color identified by the system color table. Write Slides::SystemColor.

Implements Aspose::Slides::IColorFormat.

◆ ToString()

System::String Aspose::Slides::ColorFormat::ToString ( ColorStringFormat  format)
overridevirtual

Returns a System::String that represents the current color format.

Parameters
formatA type of color string format.
Returns
A string that represents the current color format.

Implements Aspose::Slides::IColorFormat.