iText 9.0.0 API
iText.Layout.Properties Namespace Reference

Classes

class   Background
  A specialized class holding configurable properties related to an iText.Layout.Element.IElement 's background. More...
 
class   BackgroundImage
  Class to hold background-image property. More...
 
class   BackgroundPosition
  Class to hold background-position property. More...
 
class   BackgroundRepeat
  Class to hold background-repeat property. More...
 
class   BackgroundSize
  Class to hold background-size property. More...
 
class   BlendMode
  Defines all possible blend modes and their mapping to pdf names. More...
 
class   BorderRadius
  Represents a border radius. More...
 
class   ContinuousContainer
  This class is used to store properties of the renderer that are needed to be removed/reapplied. More...
 
interface   IListSymbolFactory
  Interface for implementing custom symbols for lists More...
 
class   InlineVerticalAlignment
  A property corresponding to the css vertical-align property and used to set vertical alignment on inline blocks, it specifies the type of alignment and where needed a numerical value to complete it. More...
 
class   Leading
  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...
 
class   LineHeight
  A property corresponding to the css line-height property and used to set the height of a line box in the HTML mode. More...
 
class   ParagraphOrphansControl
  A specialized class holding configurable parameters related to iText.Layout.Element.Paragraph 's orphans restrictions. More...
 
class   ParagraphWidowsControl
  A specialized class holding configurable parameters related to iText.Layout.Element.Paragraph 's widows restrictions. More...
 
class   Property
  An enum of property names that are used for graphical properties of layout elements. More...
 
class   Transform
  This class is used to store and process multiple transform css property before drawing. More...
 
class   TransparentColor
  Represents a color with the specified opacity. More...
 
class   Underline
  A POJO that describes the underline of a layout element. More...
 
class   UnitValue
  A specialized class that holds a value and the unit it is measured in. More...
 

Enumerations

enum   AlignmentPropertyValue {
  CENTER, START, END, SELF_START,
  SELF_END, FLEX_START, FLEX_END, BASELINE,
  STRETCH, NORMAL
}
  A specialized enum containing potential property values for Property.ALIGN_ITEMS and Property.ALIGN_SELF. More...
 
enum   AreaBreakType { NEXT_AREA, NEXT_PAGE, LAST_PAGE }
  The possible values for the type of break that is executed by an AreaBreak. More...
 
enum   BackgroundBox { BORDER_BOX, PADDING_BOX, CONTENT_BOX }
  Enum with boxes that can be used as a value in background-clip and background-origin properties. More...
 
enum   BaseDirection { NO_BIDI, DEFAULT_BIDI, LEFT_TO_RIGHT, RIGHT_TO_LEFT }
  A specialized enum holding the possible values for a text IElement 's base direction. More...
 
enum   BorderCollapsePropertyValue { COLLAPSE, SEPARATE }
  A specialized enum containing potential property values for Property.BORDER_COLLAPSE. More...
 
enum   BoxSizingPropertyValue { CONTENT_BOX, BORDER_BOX }
  A specialized enum containing potential property values for Property.BOX_SIZING. More...
 
enum   CaptionSide { BOTTOM, TOP }
  A specialized enum containing the potential caption side values for a Table 's caption. More...
 
enum   ClearPropertyValue { LEFT, NONE, RIGHT, BOTH }
  A specialized enum containing potential property values for Property.CLEAR. More...
 
enum   FlexDirectionPropertyValue { ROW, ROW_REVERSE, COLUMN, COLUMN_REVERSE }
  A specialized enum containing potential property values for Property.FLEX_DIRECTION. More...
 
enum   FlexWrapPropertyValue { NOWRAP, WRAP, WRAP_REVERSE }
  A specialized enum containing potential property values for Property.FLEX_WRAP. More...
 
enum   FloatPropertyValue { LEFT, NONE, RIGHT }
  A specialized enum containing potential property values for Property.FLOAT. More...
 
enum   FontKerning { YES, NO }
  A specialized enum holding the possible values for a text IElement 's kerning property. More...
 
enum   HorizontalAlignment { LEFT, CENTER, RIGHT }
  A specialized enum containing potential property values for Property.HORIZONTAL_ALIGNMENT. More...
 
enum   InlineVerticalAlignmentType {
  BASELINE, TEXT_TOP, TEXT_BOTTOM, SUB,
  SUPER, InlineVerticalAlignmentType.FIXED, InlineVerticalAlignmentType.FRACTION, MIDDLE,
  TOP, BOTTOM
}
  The possible values for InlineVerticalAlignment.GetType(). More...
 
enum   JustifyContent {
  CENTER, START, END, SELF_START,
  SELF_END, FLEX_START, FLEX_END, LEFT,
  RIGHT, NORMAL, STRETCH
}
  A enum containing potential property values for Property.JUSTIFY_CONTENT. More...
 
enum   ListNumberingType {
  DECIMAL, DECIMAL_LEADING_ZERO, ROMAN_LOWER, ROMAN_UPPER,
  ENGLISH_LOWER, ENGLISH_UPPER, GREEK_LOWER, GREEK_UPPER,
  ListNumberingType.ZAPF_DINGBATS_1, ListNumberingType.ZAPF_DINGBATS_2, ListNumberingType.ZAPF_DINGBATS_3, ListNumberingType.ZAPF_DINGBATS_4
}
  A specialized enum holding the possible values for a list List 's entry prefix. More...
 
enum   ListSymbolAlignment { RIGHT, LEFT }
  A specialized enum containing alignment properties for list symbols. More...
 
enum   ListSymbolPosition { DEFAULT, INSIDE, OUTSIDE }
  A specialized enum containing position properties for list symbols. More...
 
enum   ObjectFit {
  ObjectFit.FILL, ObjectFit.CONTAIN, ObjectFit.COVER, ObjectFit.SCALE_DOWN,
  ObjectFit.NONE
}
  A specialized enum holding the possible values for an object-fit property which define the way of fitting the image into the content box with different size. More...
 
enum   OverflowPropertyValue { FIT, VISIBLE, HIDDEN }
  The possible values for the type of overflow of BlockElement. More...
 
enum   OverflowWrapPropertyValue { ANYWHERE, BREAK_WORD, NORMAL }
  The possible values for the overflow wrap property. More...
 
enum   RenderingMode { RenderingMode.DEFAULT_LAYOUT_MODE, RenderingMode.HTML_MODE }
  Enum of rendering modes that can be used in layout logic. More...
 
enum   TabAlignment { LEFT, RIGHT, CENTER, ANCHOR }
  A specialized enum holding the possible values for a Tab 's alignment. More...
 
enum   TextAlignment {
  LEFT, CENTER, RIGHT, JUSTIFIED,
  JUSTIFIED_ALL
}
  A specialized enum containing potential property values for Property.TEXT_ALIGNMENT. More...
 
enum   VerticalAlignment { TOP, MIDDLE, BOTTOM }
  A specialized enum containing potential property values for Property.VERTICAL_ALIGNMENT. More...
 

Enumeration Type Documentation

◆ AlignmentPropertyValue

A specialized enum containing potential property values for Property.ALIGN_ITEMS and Property.ALIGN_SELF.

◆ AreaBreakType

The possible values for the type of break that is executed by an AreaBreak.

◆ BackgroundBox

Enum with boxes that can be used as a value in background-clip and background-origin properties.

◆ BaseDirection

A specialized enum holding the possible values for a text IElement 's base direction.

A specialized enum holding the possible values for a text IElement 's base direction. This class is meant to be used as the value for the Property.BASE_DIRECTION key in an IPropertyContainer.

◆ BorderCollapsePropertyValue

A specialized enum containing potential property values for Property.BORDER_COLLAPSE.

◆ BoxSizingPropertyValue

A specialized enum containing potential property values for Property.BOX_SIZING.

◆ CaptionSide

A specialized enum containing the potential caption side values for a Table 's caption.

◆ ClearPropertyValue

A specialized enum containing potential property values for Property.CLEAR.

◆ FlexDirectionPropertyValue

A specialized enum containing potential property values for Property.FLEX_DIRECTION.

◆ FlexWrapPropertyValue

A specialized enum containing potential property values for Property.FLEX_WRAP.

◆ FloatPropertyValue

A specialized enum containing potential property values for Property.FLOAT.

◆ FontKerning

A specialized enum holding the possible values for a text IElement 's kerning property.

A specialized enum holding the possible values for a text IElement 's kerning property. This class is meant to be used as the value for the Property.FONT_KERNING key in an IPropertyContainer.

◆ HorizontalAlignment

A specialized enum containing potential property values for Property.HORIZONTAL_ALIGNMENT.

◆ InlineVerticalAlignmentType

The possible values for InlineVerticalAlignment.GetType().

Enumerator
FIXED 

Fixed is used when a length value is given in css.

Fixed is used when a length value is given in css. It needs a companion value in InlineVerticalAlignment.SetValue(float)

FRACTION 

Fixed is used when a percentage value is given in css.

Fixed is used when a percentage value is given in css. It needs a companion value in InlineVerticalAlignment.SetValue(float)

◆ JustifyContent

A enum containing potential property values for Property.JUSTIFY_CONTENT.

◆ ListNumberingType

A specialized enum holding the possible values for a list List 's entry prefix.

A specialized enum holding the possible values for a list List 's entry prefix. This class is meant to be used as the value for the Property.LIST_SYMBOL key in an IPropertyContainer.

Enumerator
ZAPF_DINGBATS_1 

Zapfdingbats font characters in range [172; 181]

ZAPF_DINGBATS_2 

Zapfdingbats font characters in range [182; 191]

ZAPF_DINGBATS_3 

Zapfdingbats font characters in range [192; 201]

ZAPF_DINGBATS_4 

Zapfdingbats font characters in range [202; 221]

◆ ListSymbolAlignment

A specialized enum containing alignment properties for list symbols.

A specialized enum containing alignment properties for list symbols.

LEFT means that the items will be aligned as follows:

  1. Item 9
  2. Item 10

Whereas RIGHT means the items will be aligned as follows:

  1. Item 9
  2. Item 10

◆ ListSymbolPosition

A specialized enum containing position properties for list symbols.

◆ ObjectFit

A specialized enum holding the possible values for an object-fit property which define the way of fitting the image into the content box with different size.

Enumerator
FILL 

If object-fit set to FILL, image will be sized to fill the element's content box.

If object-fit set to FILL, image will be sized to fill the element's content box. This can change the aspect-ratio of the image.

CONTAIN 

If object-fit set to CONTAIN, image will be scaled keeping its aspect ratio to fit in the content box.

If object-fit set to CONTAIN, image will be scaled keeping its aspect ratio to fit in the content box. The whole picture will be rendered in the document but some are of the image container might be blank.

COVER 

If object-fit set to COVER, image will be scaled keeping its aspect ratio to cover the content box.

If object-fit set to COVER, image will be scaled keeping its aspect ratio to cover the content box. The image will be clipped to fit the container's bounds.

SCALE_DOWN 

If object-fit set to SCALE_DOWN, image will be scaled keeping its aspect ratio to fit in the content box but scaling coefficient cannot be greater than 1.

If object-fit set to SCALE_DOWN, image will be scaled keeping its aspect ratio to fit in the content box but scaling coefficient cannot be greater than 1. If content box is greater than the image, picture will be rendered in its original size leaving the rest area of the container blank.

NONE 

If object-fit set to NONE, image will not be scaled.

If object-fit set to NONE, image will not be scaled. It will keep its original size. If the content box is greater than image it will contain blank areas, otherwise picture will be clipped to fit the container's bounds.

◆ OverflowPropertyValue

The possible values for the type of overflow of BlockElement.

◆ OverflowWrapPropertyValue

The possible values for the overflow wrap property.

The possible values for the overflow wrap property.

ANYWHERE and BREAK_WORD mean that long words will break if they overflow the container.

NORMAL means that long words will not break, even if they overflow the container.

◆ RenderingMode

Enum of rendering modes that can be used in layout logic.

Enumerator
DEFAULT_LAYOUT_MODE 

Default object layout mode

HTML_MODE 

Mode in which objects are processed in accordance with the HTML documentation

◆ TabAlignment

A specialized enum holding the possible values for a Tab 's alignment.

◆ TextAlignment

A specialized enum containing potential property values for Property.TEXT_ALIGNMENT.

◆ VerticalAlignment

A specialized enum containing potential property values for Property.VERTICAL_ALIGNMENT.