System::Drawing::FontFamily Class Reference

Represents a group of type faces that share a similar basic design. 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...

Inherits System::Object.

Public Member Functions

ASPOSECPP_SHARED_API FontFamily (const String &name)
 Constructs a new instance of FontFamily class that represents a font family with the specified name. More...
 
ASPOSECPP_SHARED_API FontFamily (const String &name, const SharedPtr< Text::FontCollection > &font_collection)
 Constructs a new instance of FontFamily in the specified FontCollection with the specified name. More...
 
ASPOSECPP_SHARED_API FontFamily (Text::GenericFontFamilies generic_family)
 Constructs a new instance of FontFamily from the specified generic font family. More...
 
virtual ASPOSECPP_SHARED_API ~FontFamily ()
 Destructor. More...
 
ASPOSECPP_SHARED_API bool IsStyleAvailable (FontStyle style)
 Determines if the specified font style is available. More...
 
ASPOSECPP_SHARED_API int GetEmHeight (FontStyle style)
 Returns the height of em square in font design units for the specified style. More...
 
ASPOSECPP_SHARED_API int GetCellAscent (FontStyle style)
 Returns the cell ascent of the font family represented by the current object for the specified font style. More...
 
ASPOSECPP_SHARED_API int GetCellDescent (FontStyle style)
 Returns the cell descent of the font family represented by the current object for the specified font style. More...
 
ASPOSECPP_SHARED_API int GetLineSpacing (FontStyle style)
 Returns the line spacing of the font family represented by the current object for the specified font style. More...
 
ASPOSECPP_SHARED_API String get_Name () const
 Returns the name of the font family represented by the current object. More...
 
ASPOSECPP_SHARED_API String GetName (int language) const
 Returns the name of the font family represented by the current object. More...
 
void Dispose ()
 Releases all operating system resources acquired by the current object. More...
 
ASPOSECPP_SHARED_API bool Equals (System::SharedPtr< System::Object > obj) override
 Determines if the current and the specified objects are identical. More...
 
ASPOSECPP_SHARED_API SharedPtr< FontFamilyClone ()
 Returns a copy of the current FontFamily object. 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 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 (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 ASPOSECPP_SHARED_API ArrayPtr< SharedPtr< FontFamily > > get_Families ()
 Returns an array containing all FontFamily objects associated with the current graphics context. More...
 
static ASPOSECPP_SHARED_API SharedPtr< FontFamilyget_GenericSansSerif ()
 Returns a FontFamily object that represents a Generic Sans Serif font family. More...
 
static ASPOSECPP_SHARED_API SharedPtr< FontFamilyget_GenericMonospace ()
 Returns a FontFamily object that represents a Generic Monospace font family. More...
 
static ASPOSECPP_SHARED_API SharedPtr< FontFamilyget_GenericSerif ()
 Returns a FontFamily object that represents a Generic Serif font family. 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 a group of type faces that share a similar basic design. 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

◆ FontFamily() [1/3]

ASPOSECPP_SHARED_API System::Drawing::FontFamily::FontFamily ( const String name)

Constructs a new instance of FontFamily class that represents a font family with the specified name.

Parameters
nameA font family name

◆ FontFamily() [2/3]

ASPOSECPP_SHARED_API System::Drawing::FontFamily::FontFamily ( const String name,
const SharedPtr< Text::FontCollection > &  font_collection 
)

Constructs a new instance of FontFamily in the specified FontCollection with the specified name.

Parameters
nameA font family name
font_collectionThe FontCollection what contains this instance.

◆ FontFamily() [3/3]

ASPOSECPP_SHARED_API System::Drawing::FontFamily::FontFamily ( Text::GenericFontFamilies  generic_family)

Constructs a new instance of FontFamily from the specified generic font family.

Parameters
generic_familyThe GenericFontFamilies value to construct the FontFamily.

◆ ~FontFamily()

virtual ASPOSECPP_SHARED_API System::Drawing::FontFamily::~FontFamily ( )
virtual

Destructor.

Member Function Documentation

◆ Clone()

ASPOSECPP_SHARED_API SharedPtr<FontFamily> System::Drawing::FontFamily::Clone ( )

Returns a copy of the current FontFamily object.

Returns
The created FontFamily object

◆ Dispose()

void System::Drawing::FontFamily::Dispose ( )
inline

Releases all operating system resources acquired by the current object.

◆ Equals()

ASPOSECPP_SHARED_API bool System::Drawing::FontFamily::Equals ( System::SharedPtr< System::Object obj)
override

Determines if the current and the specified objects are identical.

Parameters
objAn object to compare the current object with
Returns
True if the current and the specified objects are identical, otherwise - false

◆ get_Families()

static ASPOSECPP_SHARED_API ArrayPtr<SharedPtr<FontFamily> > System::Drawing::FontFamily::get_Families ( )
static

Returns an array containing all FontFamily objects associated with the current graphics context.

◆ get_GenericMonospace()

static ASPOSECPP_SHARED_API SharedPtr<FontFamily> System::Drawing::FontFamily::get_GenericMonospace ( )
static

Returns a FontFamily object that represents a Generic Monospace font family.

◆ get_GenericSansSerif()

static ASPOSECPP_SHARED_API SharedPtr<FontFamily> System::Drawing::FontFamily::get_GenericSansSerif ( )
static

Returns a FontFamily object that represents a Generic Sans Serif font family.

◆ get_GenericSerif()

static ASPOSECPP_SHARED_API SharedPtr<FontFamily> System::Drawing::FontFamily::get_GenericSerif ( )
static

Returns a FontFamily object that represents a Generic Serif font family.

◆ get_Name()

ASPOSECPP_SHARED_API String System::Drawing::FontFamily::get_Name ( ) const

Returns the name of the font family represented by the current object.

◆ GetCellAscent()

ASPOSECPP_SHARED_API int System::Drawing::FontFamily::GetCellAscent ( FontStyle  style)

Returns the cell ascent of the font family represented by the current object for the specified font style.

Parameters
styleThe font style
Returns
The cell ascent of the font family represented by the current object for the specified font style.

◆ GetCellDescent()

ASPOSECPP_SHARED_API int System::Drawing::FontFamily::GetCellDescent ( FontStyle  style)

Returns the cell descent of the font family represented by the current object for the specified font style.

Parameters
styleThe font style
Returns
The cell descent of the font family represented by the current object for the specified font style.

◆ GetEmHeight()

ASPOSECPP_SHARED_API int System::Drawing::FontFamily::GetEmHeight ( FontStyle  style)

Returns the height of em square in font design units for the specified style.

Parameters
styleThe style for which to get the height
Returns
The hight of the em square for the specified style

◆ GetLineSpacing()

ASPOSECPP_SHARED_API int System::Drawing::FontFamily::GetLineSpacing ( FontStyle  style)

Returns the line spacing of the font family represented by the current object for the specified font style.

Parameters
styleThe font style
Returns
The line spacing of the font family represented by the current object for the specified font style.

◆ GetName()

ASPOSECPP_SHARED_API String System::Drawing::FontFamily::GetName ( int  language) const

Returns the name of the font family represented by the current object.

Parameters
languageIGNORED
Returns
The name of the font family represented by the current object

◆ IsStyleAvailable()

ASPOSECPP_SHARED_API bool System::Drawing::FontFamily::IsStyleAvailable ( FontStyle  style)

Determines if the specified font style is available.

Parameters
styleThe font style to test
Returns
True if the specified font style is avaliable, otherwise - false