Asposecpplib

Represents a particular format for text, including font face, size, and style. 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 Font (const SharedPtr< Font > &prototype, FontStyle new_style)
 Constructs a new instance of Font class that represents the specified existing font with the specified font style. More...
 
ASPOSECPP_SHARED_API Font (const SharedPtr< FontFamily > &family, float em_size, FontStyle style, GraphicsUnit unit=GraphicsUnit::Point, uint8_t gdi_charset=1, bool gdi_vertical_font=false)
 Constructs a new instance of Font class. More...
 
ASPOSECPP_SHARED_API Font (const SharedPtr< FontFamily > &family, float em_size, GraphicsUnit unit=GraphicsUnit::Point)
 Constructs a new instance of Font class. More...
 
ASPOSECPP_SHARED_API Font (const String &family_name, float em_size, FontStyle style, GraphicsUnit unit=GraphicsUnit::Point, uint8_t gdi_charset=1, bool gdi_vertical_font=false)
 Constructs a new instance of Font class. More...
 
ASPOSECPP_SHARED_API Font (const String &family_name, float em_size, GraphicsUnit unit=GraphicsUnit::Point)
 Constructs a new instance of Font class. More...
 
ASPOSECPP_SHARED_API float GetHeight (const SharedPtr< Graphics > &graphics)
 Returns the line spacing of the font represented by the current object, in the current unit of a specified Graphics object. More...
 
ASPOSECPP_SHARED_API float GetHeight (float dpi=DEFAULT_FONT_OPERATIONS_DPI)
 Returns the height of the font represented by the current object when drawn to a display device with the specified vertical resolution. More...
 
ASPOSECPP_SHARED_API String get_Name ()
 Returns the face name of the font represented by the current object. More...
 
ASPOSECPP_SHARED_API String get_OriginalFontName ()
 Returns the originally specified name of the font. More...
 
ASPOSECPP_SHARED_API SharedPtr< FontFamilyget_FontFamily ()
 Returns the font family of the font represented by the current object. More...
 
ASPOSECPP_SHARED_API FontStyle get_FontStyle ()
 Returns the font style of the font represneted by the current object. More...
 
ASPOSECPP_SHARED_API float get_Size ()
 Returns the em size of the font represented by the current object measured in the units specified by the Unit property. More...
 
ASPOSECPP_SHARED_API bool get_Bold ()
 Determines if the font represented by the current object has the bold style applied. More...
 
ASPOSECPP_SHARED_API bool get_Italic ()
 Determines if the font represented by the current object has the italic style applied. More...
 
ASPOSECPP_SHARED_API bool get_Underline ()
 Determines if the font represented by the current object has the underline style applied. More...
 
ASPOSECPP_SHARED_API bool get_Strikeout ()
 Determines if the font represented by the current object has the strikeout style applied. More...
 
ASPOSECPP_SHARED_API int get_Height ()
 Returns the line spacing of the font represented by the current object in pixels. More...
 
ASPOSECPP_SHARED_API float get_SizeInPoints ()
 Returns the em size of the font represented by the current object in points. More...
 
ASPOSECPP_SHARED_API uint8_t get_GdiCharSet ()
 Returns a value that indicates the GDI character set used by the font represented by the current object. More...
 
ASPOSECPP_SHARED_API GraphicsUnit get_Unit ()
 Returns the measurement unit for the font represented by the current object. More...
 
FontStyle get_Style ()
 Returns the font style of the font represented by the current object. More...
 
ASPOSECPP_SHARED_API SharedPtr< FontClone ()
 Returns a copy of the current font. 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...
 
- 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 int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () ASPOSE_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)
 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 SharedPtr< FontFromLogFont (const SharedPtr< Object > &lf)
 NOT IMPLEMENTED. 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...
 

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...
 

Detailed Description

Represents a particular format for text, including font face, size, and style. 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

◆ Font() [1/5]

ASPOSECPP_SHARED_API System::Drawing::Font::Font ( const SharedPtr< Font > &  prototype,
FontStyle  new_style 
)

Constructs a new instance of Font class that represents the specified existing font with the specified font style.

Parameters
prototypeThe existing font to create the new one from
new_styleA font style to apply to the new font

◆ Font() [2/5]

ASPOSECPP_SHARED_API System::Drawing::Font::Font ( const SharedPtr< FontFamily > &  family,
float  em_size,
FontStyle  style,
GraphicsUnit  unit = GraphicsUnit::Point,
uint8_t  gdi_charset = 1,
bool  gdi_vertical_font = false 
)

Constructs a new instance of Font class.

Parameters
familyThe font family of the new font
em_sizeThe em size of the new font in the units specified by unit parameter
styleThe style of the new font
unitThe measurement units of the new font
gdi_charsetA GDI charset to be used for the new font
gdi_vertical_fontTrue if the new font is derived from a GDI vertical font

◆ Font() [3/5]

ASPOSECPP_SHARED_API System::Drawing::Font::Font ( const SharedPtr< FontFamily > &  family,
float  em_size,
GraphicsUnit  unit = GraphicsUnit::Point 
)

Constructs a new instance of Font class.

Parameters
familyThe font family of the new font
em_sizeThe em size of the new font in the units specified by unit parameter
unitThe measurement units of the new font

◆ Font() [4/5]

ASPOSECPP_SHARED_API System::Drawing::Font::Font ( const String family_name,
float  em_size,
FontStyle  style,
GraphicsUnit  unit = GraphicsUnit::Point,
uint8_t  gdi_charset = 1,
bool  gdi_vertical_font = false 
)

Constructs a new instance of Font class.

Parameters
family_nameThe name of the new font's font family
em_sizeThe em size of the new font in the units specified by unit parameter
styleThe style of the new font
unitThe measurement units of the new font
gdi_charsetA GDI charset to be used for the new font
gdi_vertical_fontTrue if the new font is derived from a GDI vertical font

◆ Font() [5/5]

ASPOSECPP_SHARED_API System::Drawing::Font::Font ( const String family_name,
float  em_size,
GraphicsUnit  unit = GraphicsUnit::Point 
)

Constructs a new instance of Font class.

Parameters
family_nameThe name of the new font's font family
em_sizeThe em size of the new font in the units specified by unit parameter
unitThe measurement units of the new font

Member Function Documentation

◆ Clone()

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

Returns a copy of the current font.

◆ Dispose()

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

Releases all operating system resources acquired by the current object.

◆ Equals()

ASPOSECPP_SHARED_API bool System::Drawing::Font::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

◆ FromLogFont()

static ASPOSECPP_SHARED_API SharedPtr<Font> System::Drawing::Font::FromLogFont ( const SharedPtr< Object > &  lf)
static

NOT IMPLEMENTED.

Exceptions
NotImplementedExceptionAlways

◆ get_Bold()

ASPOSECPP_SHARED_API bool System::Drawing::Font::get_Bold ( )

Determines if the font represented by the current object has the bold style applied.

◆ get_FontFamily()

ASPOSECPP_SHARED_API SharedPtr<FontFamily> System::Drawing::Font::get_FontFamily ( )

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

◆ get_FontStyle()

ASPOSECPP_SHARED_API FontStyle System::Drawing::Font::get_FontStyle ( )

Returns the font style of the font represneted by the current object.

◆ get_GdiCharSet()

ASPOSECPP_SHARED_API uint8_t System::Drawing::Font::get_GdiCharSet ( )

Returns a value that indicates the GDI character set used by the font represented by the current object.

◆ get_Height()

ASPOSECPP_SHARED_API int System::Drawing::Font::get_Height ( )

Returns the line spacing of the font represented by the current object in pixels.

◆ get_Italic()

ASPOSECPP_SHARED_API bool System::Drawing::Font::get_Italic ( )

Determines if the font represented by the current object has the italic style applied.

◆ get_Name()

ASPOSECPP_SHARED_API String System::Drawing::Font::get_Name ( )

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

◆ get_OriginalFontName()

ASPOSECPP_SHARED_API String System::Drawing::Font::get_OriginalFontName ( )

Returns the originally specified name of the font.

◆ get_Size()

ASPOSECPP_SHARED_API float System::Drawing::Font::get_Size ( )

Returns the em size of the font represented by the current object measured in the units specified by the Unit property.

◆ get_SizeInPoints()

ASPOSECPP_SHARED_API float System::Drawing::Font::get_SizeInPoints ( )

Returns the em size of the font represented by the current object in points.

◆ get_Strikeout()

ASPOSECPP_SHARED_API bool System::Drawing::Font::get_Strikeout ( )

Determines if the font represented by the current object has the strikeout style applied.

◆ get_Style()

FontStyle System::Drawing::Font::get_Style ( )
inline

Returns the font style of the font represented by the current object.

◆ get_Underline()

ASPOSECPP_SHARED_API bool System::Drawing::Font::get_Underline ( )

Determines if the font represented by the current object has the underline style applied.

◆ get_Unit()

ASPOSECPP_SHARED_API GraphicsUnit System::Drawing::Font::get_Unit ( )

Returns the measurement unit for the font represented by the current object.

◆ GetHeight() [1/2]

ASPOSECPP_SHARED_API float System::Drawing::Font::GetHeight ( const SharedPtr< Graphics > &  graphics)

Returns the line spacing of the font represented by the current object, in the current unit of a specified Graphics object.

Parameters
graphicsA Graphics object that specifies the measurement units

◆ GetHeight() [2/2]

ASPOSECPP_SHARED_API float System::Drawing::Font::GetHeight ( float  dpi = DEFAULT_FONT_OPERATIONS_DPI)

Returns the height of the font represented by the current object when drawn to a display device with the specified vertical resolution.

Parameters
dpiThe vertical resolution of the display device
Returns
The hegiht of the font in pixels