System::Drawing::Imaging::ImageFormat Class Reference

Represents the file format of an image. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

#include "image_format.h"

Inherits System::Object.

Public Member Functions

ASPOSECPP_SHARED_API ImageFormat (const System::Guid &guid)
 Constructs an instance of ImageFormat class that represents an image format format associated with the specified GUID. More...
 
ASPOSECPP_SHARED_API bool Equals (ImageFormatPtr format) const
 Determines if the image formats represented by the current and specified objects are equal. More...
 
System::Guid get_Guid () const
 Returns the GUID associated with the image format represented by the current object. More...
 
ASPOSECPP_SHARED_API System::String ToString () const
 Converts this ImageFormat object to a human-readable string. More...
 
- 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 reference 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 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 (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. 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...
 
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...
 

Static Public Member Functions

static ImageFormatPtr get_MemoryBmp ()
 Returns a shared pointer to an ImageFormat object that represents the format of a bitmap in memory. More...
 
static ImageFormatPtr get_Bmp ()
 Returns a shared pointer to an ImageFormat object that represents the bitmap image format. More...
 
static ImageFormatPtr get_Emf ()
 Returns a shared pointer to an ImageFormat object that represents the enhanced metafile format. More...
 
static ImageFormatPtr get_Wmf ()
 Returns a shared pointer to an ImageFormat object that represents the Windows metafile (WMF) image format. More...
 
static ImageFormatPtr get_Gif ()
 Returns a shared pointer to an ImageFormat object that represents the Graphics Interchange Format (GIF) image format. More...
 
static ImageFormatPtr get_Jpeg ()
 Returns a shared pointer to an ImageFormat object that represents the Joint Photographic Experts Group (JPEG) image format. More...
 
static ImageFormatPtr get_Png ()
 Returns a shared pointer to an ImageFormat object that represents the W3C Portable Network Graphics (PNG) image format. More...
 
static ImageFormatPtr get_Tiff ()
 Returns a shared pointer to an ImageFormat object that represents the Tagged Image File Format (TIFF) image format. More...
 
static ImageFormatPtr get_Exif ()
 Returns a shared pointer to an ImageFormat object that represents the Exchangeable Image File (Exif) format. More...
 
static ImageFormatPtr get_Icon ()
 Returns a shared pointer to an ImageFormat object that represents the Windows icon image format. 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...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Detailed Description

Represents the file format of an image. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

Constructor & Destructor Documentation

◆ ImageFormat()

ASPOSECPP_SHARED_API System::Drawing::Imaging::ImageFormat::ImageFormat ( const System::Guid guid)

Constructs an instance of ImageFormat class that represents an image format format associated with the specified GUID.

Parameters
guidGUID specifying the image format

Member Function Documentation

◆ Equals()

ASPOSECPP_SHARED_API bool System::Drawing::Imaging::ImageFormat::Equals ( ImageFormatPtr  format) const

Determines if the image formats represented by the current and specified objects are equal.

Parameters
formatThe image format object to compare the current object with
Returns
True if the current and the specified objects represent the same image format, otherwise - false

◆ get_Bmp()

static ImageFormatPtr System::Drawing::Imaging::ImageFormat::get_Bmp ( )
inlinestatic

Returns a shared pointer to an ImageFormat object that represents the bitmap image format.

◆ get_Emf()

static ImageFormatPtr System::Drawing::Imaging::ImageFormat::get_Emf ( )
inlinestatic

Returns a shared pointer to an ImageFormat object that represents the enhanced metafile format.

◆ get_Exif()

static ImageFormatPtr System::Drawing::Imaging::ImageFormat::get_Exif ( )
inlinestatic

Returns a shared pointer to an ImageFormat object that represents the Exchangeable Image File (Exif) format.

◆ get_Gif()

static ImageFormatPtr System::Drawing::Imaging::ImageFormat::get_Gif ( )
inlinestatic

Returns a shared pointer to an ImageFormat object that represents the Graphics Interchange Format (GIF) image format.

◆ get_Guid()

System::Guid System::Drawing::Imaging::ImageFormat::get_Guid ( ) const
inline

Returns the GUID associated with the image format represented by the current object.

◆ get_Icon()

static ImageFormatPtr System::Drawing::Imaging::ImageFormat::get_Icon ( )
inlinestatic

Returns a shared pointer to an ImageFormat object that represents the Windows icon image format.

◆ get_Jpeg()

static ImageFormatPtr System::Drawing::Imaging::ImageFormat::get_Jpeg ( )
inlinestatic

Returns a shared pointer to an ImageFormat object that represents the Joint Photographic Experts Group (JPEG) image format.

◆ get_MemoryBmp()

static ImageFormatPtr System::Drawing::Imaging::ImageFormat::get_MemoryBmp ( )
inlinestatic

Returns a shared pointer to an ImageFormat object that represents the format of a bitmap in memory.

◆ get_Png()

static ImageFormatPtr System::Drawing::Imaging::ImageFormat::get_Png ( )
inlinestatic

Returns a shared pointer to an ImageFormat object that represents the W3C Portable Network Graphics (PNG) image format.

◆ get_Tiff()

static ImageFormatPtr System::Drawing::Imaging::ImageFormat::get_Tiff ( )
inlinestatic

Returns a shared pointer to an ImageFormat object that represents the Tagged Image File Format (TIFF) image format.

◆ get_Wmf()

static ImageFormatPtr System::Drawing::Imaging::ImageFormat::get_Wmf ( )
inlinestatic

Returns a shared pointer to an ImageFormat object that represents the Windows metafile (WMF) image format.

◆ ToString()

ASPOSECPP_SHARED_API System::String System::Drawing::Imaging::ImageFormat::ToString ( ) const
virtual

Converts this ImageFormat object to a human-readable string.

Reimplemented from System::Object.