Aspose::Pdf::Annotations::Measure::NumberFormat Class Reference

Number format for measure. More...

#include "Measure.h"

Inherits System::Object.

Public Types

enum  FractionStyle { FractionStyle::ShowAsDecimal, FractionStyle::ShowAsFraction, FractionStyle::Round, FractionStyle::Truncate }
 Value which indicates in which manner fraction values are displayed. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Public Member Functions

ASPOSE_PDF_SHARED_API System::String get_UnitLabel ()
 A text string specifying a label for displaying the units. More...
 
ASPOSE_PDF_SHARED_API void set_UnitLabel (System::String value)
 A text string specifying a label for displaying the units. More...
 
ASPOSE_PDF_SHARED_API double get_ConvresionFactor ()
 The conversion factor used to multiply a value in partial units of the previous number format array element to obtain a value in the units of this number format. More...
 
ASPOSE_PDF_SHARED_API void set_ConvresionFactor (double value)
 The conversion factor used to multiply a value in partial units of the previous number format array element to obtain a value in the units of this number format. More...
 
ASPOSE_PDF_SHARED_API Measure::NumberFormat::FractionStyle get_FractionDisplayment ()
 In what manner fractional values are displayed. More...
 
ASPOSE_PDF_SHARED_API void set_FractionDisplayment (Measure::NumberFormat::FractionStyle value)
 In what manner fractional values are displayed. More...
 
ASPOSE_PDF_SHARED_API int32_t get_Precision ()
 If FractionDisplayment is ShowAsDecimal, this value is precision of fractional value; It shall me multiple of 10. Default is 100. More...
 
ASPOSE_PDF_SHARED_API void set_Precision (int32_t value)
 If FractionDisplayment is ShowAsDecimal, this value is precision of fractional value; It shall me multiple of 10. Default is 100. More...
 
ASPOSE_PDF_SHARED_API int32_t get_Denominator ()
 If FractionDisplayment is ShowAsFraction, this value is denominator of the fraction. Default value is 16. More...
 
ASPOSE_PDF_SHARED_API void set_Denominator (int32_t value)
 If FractionDisplayment is ShowAsFraction, this value is denominator of the fraction. Default value is 16. More...
 
ASPOSE_PDF_SHARED_API bool get_ForceDenominator ()
 If FractionDisplayment is ShowAsFraction, this value determines meay or not the fraction be reduced. If value is true fraction may not be reduced. More...
 
ASPOSE_PDF_SHARED_API void set_ForceDenominator (bool value)
 If FractionDisplayment is ShowAsFraction, this value determines meay or not the fraction be reduced. If value is true fraction may not be reduced. More...
 
ASPOSE_PDF_SHARED_API System::String get_ThousandsSeparator ()
 Text that shall be used between orders of thousands in display of numerical values. An empty string indicates that no text shall be added. Default is comma. More...
 
ASPOSE_PDF_SHARED_API void set_ThousandsSeparator (System::String value)
 Text that shall be used between orders of thousands in display of numerical values. An empty string indicates that no text shall be added. Default is comma. More...
 
ASPOSE_PDF_SHARED_API System::String get_FractionSeparator ()
 Text that shall be used as the decimal position in displaying numerical values. An empty string indicates that the default shall be used. Default is period character. More...
 
ASPOSE_PDF_SHARED_API void set_FractionSeparator (System::String value)
 Text that shall be used as the decimal position in displaying numerical values. An empty string indicates that the default shall be used. Default is period character. More...
 
ASPOSE_PDF_SHARED_API System::String get_BeforeText ()
 Text that shall be concatenated to the left of the label. More...
 
ASPOSE_PDF_SHARED_API void set_BeforeText (System::String value)
 Text that shall be concatenated to the left of the label. More...
 
ASPOSE_PDF_SHARED_API System::String get_AfterText ()
 Text that shall be concatenated after the label More...
 
ASPOSE_PDF_SHARED_API void set_AfterText (System::String value)
 Text that shall be concatenated after the label More...
 
ASPOSE_PDF_SHARED_API NumberFormat (System::SharedPtr< Measure > measure)
 Constructor for NumberFormat class. 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...
 

Protected Member Functions

System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > get_EngineDict () const
 
 NumberFormat (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > dictionary)
 
 MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (NumberFormat, CODEPORTING_ARGS(System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > dictionary))
 
Measure::NumberFormat::FractionStyle TranslateFractionStyle (System::String fractionStyle)
 
void WriteXfdfAttributes (System::SharedPtr< System::Xml::XmlWriter > writer)
 
void ReadXfdf (System::SharedPtr< System::Xml::XmlReader > reader)
 

Additional Inherited Members

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

Detailed Description

Number format for measure.

Member Enumeration Documentation

◆ FractionStyle

Value which indicates in which manner fraction values are displayed.

Enumerator
ShowAsDecimal 

Show fractional values as decimal fraction.

ShowAsFraction 

Show fractional value as fraction.

Round 

Round fractional values to the nearest whole integer.

Truncate 

Truncate to achieve whole units.

Constructor & Destructor Documentation

◆ NumberFormat() [1/2]

ASPOSE_PDF_SHARED_API Aspose::Pdf::Annotations::Measure::NumberFormat::NumberFormat ( System::SharedPtr< Measure measure)

Constructor for NumberFormat class.

Parameters
measureMeasure object which contains this number format.

◆ NumberFormat() [2/2]

Aspose::Pdf::Annotations::Measure::NumberFormat::NumberFormat ( System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary >  dictionary)
protected

Member Function Documentation

◆ get_AfterText()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Annotations::Measure::NumberFormat::get_AfterText ( )

Text that shall be concatenated after the label

◆ get_BeforeText()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Annotations::Measure::NumberFormat::get_BeforeText ( )

Text that shall be concatenated to the left of the label.

◆ get_ConvresionFactor()

ASPOSE_PDF_SHARED_API double Aspose::Pdf::Annotations::Measure::NumberFormat::get_ConvresionFactor ( )

The conversion factor used to multiply a value in partial units of the previous number format array element to obtain a value in the units of this number format.

◆ get_Denominator()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Annotations::Measure::NumberFormat::get_Denominator ( )

If FractionDisplayment is ShowAsFraction, this value is denominator of the fraction. Default value is 16.

◆ get_EngineDict()

System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfDictionary> Aspose::Pdf::Annotations::Measure::NumberFormat::get_EngineDict ( ) const
protected

◆ get_ForceDenominator()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Annotations::Measure::NumberFormat::get_ForceDenominator ( )

If FractionDisplayment is ShowAsFraction, this value determines meay or not the fraction be reduced. If value is true fraction may not be reduced.

◆ get_FractionDisplayment()

ASPOSE_PDF_SHARED_API Measure::NumberFormat::FractionStyle Aspose::Pdf::Annotations::Measure::NumberFormat::get_FractionDisplayment ( )

In what manner fractional values are displayed.

◆ get_FractionSeparator()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Annotations::Measure::NumberFormat::get_FractionSeparator ( )

Text that shall be used as the decimal position in displaying numerical values. An empty string indicates that the default shall be used. Default is period character.

◆ get_Precision()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Annotations::Measure::NumberFormat::get_Precision ( )

If FractionDisplayment is ShowAsDecimal, this value is precision of fractional value; It shall me multiple of 10. Default is 100.

◆ get_ThousandsSeparator()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Annotations::Measure::NumberFormat::get_ThousandsSeparator ( )

Text that shall be used between orders of thousands in display of numerical values. An empty string indicates that no text shall be added. Default is comma.

◆ get_UnitLabel()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::Annotations::Measure::NumberFormat::get_UnitLabel ( )

A text string specifying a label for displaying the units.

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION()

Aspose::Pdf::Annotations::Measure::NumberFormat::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION ( NumberFormat  ,
CODEPORTING_ARGS(System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > dictionary)   
)
protected

◆ ReadXfdf()

void Aspose::Pdf::Annotations::Measure::NumberFormat::ReadXfdf ( System::SharedPtr< System::Xml::XmlReader reader)
protected

◆ set_AfterText()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Measure::NumberFormat::set_AfterText ( System::String  value)

Text that shall be concatenated after the label

◆ set_BeforeText()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Measure::NumberFormat::set_BeforeText ( System::String  value)

Text that shall be concatenated to the left of the label.

◆ set_ConvresionFactor()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Measure::NumberFormat::set_ConvresionFactor ( double  value)

The conversion factor used to multiply a value in partial units of the previous number format array element to obtain a value in the units of this number format.

◆ set_Denominator()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Measure::NumberFormat::set_Denominator ( int32_t  value)

If FractionDisplayment is ShowAsFraction, this value is denominator of the fraction. Default value is 16.

◆ set_ForceDenominator()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Measure::NumberFormat::set_ForceDenominator ( bool  value)

If FractionDisplayment is ShowAsFraction, this value determines meay or not the fraction be reduced. If value is true fraction may not be reduced.

◆ set_FractionDisplayment()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Measure::NumberFormat::set_FractionDisplayment ( Measure::NumberFormat::FractionStyle  value)

In what manner fractional values are displayed.

◆ set_FractionSeparator()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Measure::NumberFormat::set_FractionSeparator ( System::String  value)

Text that shall be used as the decimal position in displaying numerical values. An empty string indicates that the default shall be used. Default is period character.

◆ set_Precision()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Measure::NumberFormat::set_Precision ( int32_t  value)

If FractionDisplayment is ShowAsDecimal, this value is precision of fractional value; It shall me multiple of 10. Default is 100.

◆ set_ThousandsSeparator()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Measure::NumberFormat::set_ThousandsSeparator ( System::String  value)

Text that shall be used between orders of thousands in display of numerical values. An empty string indicates that no text shall be added. Default is comma.

◆ set_UnitLabel()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::Measure::NumberFormat::set_UnitLabel ( System::String  value)

A text string specifying a label for displaying the units.

◆ TranslateFractionStyle()

Measure::NumberFormat::FractionStyle Aspose::Pdf::Annotations::Measure::NumberFormat::TranslateFractionStyle ( System::String  fractionStyle)
protected

◆ WriteXfdfAttributes()

void Aspose::Pdf::Annotations::Measure::NumberFormat::WriteXfdfAttributes ( System::SharedPtr< System::Xml::XmlWriter writer)
protected