DynaPDF Manual - Page 450

Previous Page 449   Index   Next Page 451

Function Reference
Page 450 of 818
GetNumberFormatObj
Syntax:
LBOOL pdfGetNumberFormatObj(
const INFM* NumberFmt, // Pointer of a Number Format dictionary
struct TPDFNumberFormat* Value) // See below
struct TPDFNumberFormat
{
UI32
StructSize; // Must be set to sizeof(TPDFNumberFormat)
float
C;
// The conversion factor used to multiply a value in partial units.
SI32
D;
// A positive integer that shall specify the precision or denominator of a
// fractional amount.
TMeasureNumFormat F;
// See below
LBOOL
FD;
// If true, a fractional value formatted according to the D entry may not
// have its denominator reduced or low-order zeros truncated.
TMeasureLblPos
O;
// See below
const char*
PSA; // Text to be concatenated to the left of the label specified by U.
const UI16*
PSW; // Text to be concatenated to the left of the label specified by U.
const char*
RDA; // Text for the decimal position in displaying numerical values.
const UI16*
RDW; // Text for the decimal position in displaying numerical values.
const char*
RTA; // Text to be used between orders of thousands of numerical values.
const UI16*
RTW; // Text to be used between orders of thousands of numerical values.
const char*
SSA; // Text that shall be concatenated after the label specified by U.
const UI16*
SSW; // Text that shall be concatenated after the label specified by U.
const char*
UA;
// Label -> should be a universally recognized abbreviation.
const UI16*
UW;
// Label -> should be a universally recognized abbreviation.
};
typedef enum
{
mnfDecimal,
mnfFractional,
mnfRound,
mnfTruncate
}TMeasureNumFormat;
typedef enum
{
mlpSuffix,
mlpPrefix
}TMeasureLblPos;
The function retrieves the properties of a Number Format dictionary. The member StructSize must
be set to sizeof(TPDFNumberFormat) before the function can be called.
The structure members are named as specified in the PDF Reference 2.0. To determine how the
values must be used please have a look into the PDF Reference 2.0, ISO/DIS 32000-2, Section
Measurement properties.
Return values:
If the function succeeds the return value is 1. If the function fails the return value is 0.
 

Previous topic: GetNamedDest, GetNamedDestCount, GetNeedAppearance

Next topic: GetObjActionCount (obsolete), GetObjActions


Start Chat