iText 8.0.5 API
iText.Layout.Properties.Leading Class Reference

A specialized class that specifies the leading, "the vertical distance between the baselines of adjacent lines of text" (ISO-32000-1, section 9.3.5). More...

Public Member Functions

  Leading (int type, float value)
  Creates a Leading object. More...
 
virtual int  GetLeadingType ()
  Gets the calculation type of the Leading object. More...
 
virtual float  GetValue ()
  Gets the value to be used as the basis for the leading calculation. More...
 
override bool  Equals (Object obj)
 
override int  GetHashCode ()
 

Static Public Attributes

const int  FIXED = 1
  A leading type independent of font size. More...
 
const int  MULTIPLIED = 2
  A leading type related to the font size and the resulting bounding box. More...
 

Package Attributes

int  type
 
float  value
 

Detailed Description

A specialized class that specifies the leading, "the vertical distance between the baselines of adjacent lines of text" (ISO-32000-1, section 9.3.5).

A specialized class that specifies the leading, "the vertical distance between the baselines of adjacent lines of text" (ISO-32000-1, section 9.3.5). Allows to use either an absolute (constant) leading value, or one determined by font size. Pronounce as 'ledding' (cfr. Led Zeppelin). This class is meant to be used as the value for the Property.LEADING key in an iText.Layout.IPropertyContainer.

Constructor & Destructor Documentation

◆ Leading()

iText.Layout.Properties.Leading.Leading ( int  type,
float  value 
)
inline

Creates a Leading object.

Parameters
type a constant type that defines the calculation of actual leading distance. Either FIXED or MULTIPLIED
value to be used as a basis for the leading calculation.

Member Function Documentation

◆ GetLeadingType()

virtual int iText.Layout.Properties.Leading.GetLeadingType ( )
inlinevirtual

Gets the calculation type of the Leading object.

Returns
the calculation type. Either FIXED or MULTIPLIED

◆ GetValue()

virtual float iText.Layout.Properties.Leading.GetValue ( )
inlinevirtual

Gets the value to be used as the basis for the leading calculation.

Returns
a calculation value

Member Data Documentation

◆ FIXED

const int iText.Layout.Properties.Leading.FIXED = 1
static

A leading type independent of font size.

◆ MULTIPLIED

const int iText.Layout.Properties.Leading.MULTIPLIED = 2
static

A leading type related to the font size and the resulting bounding box.