A list item is a layout element that is one entry in a List. More...

Inheritance diagram for iText.Layout.Element.ListItem:

Public Member Functions
	ListItem ()
	Creates a ListItem. More...

	ListItem (String text)
	Creates a list item with text. More...

virtual iText.Layout.Element.ListItem	SetListSymbolOrdinalValue (int ordinalValue)
	Customizes the index of the item in the list. More...

	ListItem (Image image)
	Creates a list item with an image. More...

override T1	GetDefaultProperty< T1 > (int property)

virtual iText.Layout.Element.ListItem	SetListSymbol (String symbol)
	Sets the list item symbol to be used. More...

virtual iText.Layout.Element.ListItem	SetListSymbol (Text text)
	Sets the list item symbol to be used. More...

virtual iText.Layout.Element.ListItem	SetListSymbol (Image image)
	Sets the list item symbol to be used. More...

virtual iText.Layout.Element.ListItem	SetListSymbol (ListNumberingType listNumberingType)
	Sets the list item numbering type to be used. More...

override AccessibilityProperties	GetAccessibilityProperties ()
	Gets the accessibility properties. More...

Public Member Functions inherited from iText.Layout.Element.Div
virtual Div	Add (IBlockElement element)
	Adds any block element to the div's contents. More...

virtual Div	Add (Image element)
	Adds an image to the div's contents. More...

virtual Div	Add (AreaBreak areaBreak)
	Adds an area break to the div's contents. More...

virtual Div	SetFillAvailableArea (bool fillArea)
	Defines whether the Div should occupy all the space left in the available area in case it is the last element in this area. More...

virtual Div	SetFillAvailableAreaOnSplit (bool fillAreaOnSplit)
	Defines whether the Div should occupy all the space left in the available area in case the area has been split and it is the last element in the split part of this area. More...

Public Member Functions inherited from iText.Layout.Element.BlockElement< Div >
override T1	GetDefaultProperty< T1 > (int property)
	Gets the default property from this entity. More...

virtual UnitValue	GetMarginLeft ()
	Gets the current left margin width of the element. More...

virtual T	SetMarginLeft (float value)
	Sets the left margin width of the element. More...

virtual UnitValue	GetMarginRight ()
	Gets the current right margin width of the element. More...

virtual T	SetMarginRight (float value)
	Sets the right margin width of the element. More...

virtual UnitValue	GetMarginTop ()
	Gets the current top margin width of the element. More...

virtual T	SetMarginTop (float value)
	Sets the top margin width of the element. More...

virtual UnitValue	GetMarginBottom ()
	Gets the current bottom margin width of the element. More...

virtual T	SetMarginBottom (float value)
	Sets the bottom margin width of the element. More...

virtual T	SetMargin (float commonMargin)
	Sets all margins around the element to the same width. More...

virtual T	SetMargins (float marginTop, float marginRight, float marginBottom, float marginLeft)
	Sets the margins around the element to a series of new widths. More...

virtual UnitValue	GetPaddingLeft ()
	Gets the current left padding width of the element. More...

virtual T	SetPaddingLeft (float value)
	Sets the left padding width of the element. More...

virtual UnitValue	GetPaddingRight ()
	Gets the current right padding width of the element. More...

virtual T	SetPaddingRight (float value)
	Sets the right padding width of the element. More...

virtual UnitValue	GetPaddingTop ()
	Gets the current top padding width of the element. More...

virtual T	SetPaddingTop (float value)
	Sets the top padding width of the element. More...

virtual UnitValue	GetPaddingBottom ()
	Gets the current bottom padding width of the element. More...

virtual T	SetPaddingBottom (float value)
	Sets the bottom padding width of the element. More...

virtual T	SetPadding (float commonPadding)
	Sets all paddings around the element to the same width. More...

virtual T	SetPaddings (float paddingTop, float paddingRight, float paddingBottom, float paddingLeft)
	Sets the paddings around the element to a series of new widths. More...

virtual T	SetVerticalAlignment (VerticalAlignment? verticalAlignment)
	Sets the vertical alignment of the element. More...

virtual T	SetSpacingRatio (float ratio)
	Sets a ratio which determines in which proportion will word spacing and character spacing be applied when horizontal alignment is justified. More...

virtual ? bool	IsKeepTogether ()
	Returns whether the BlockElement should be kept together as much as possible. More...

virtual T	SetKeepTogether (bool keepTogether)
	Sets whether the BlockElement should be kept together as much as possible. More...

virtual ? bool	IsKeepWithNext ()
	Returns whether the end of this BlockElement and the start of the next sibling of this element should be placed in the same area. More...

virtual T	SetKeepWithNext (bool keepWithNext)
	Sets whether the end of this BlockElement and the start of the next sibling of this element should be placed in the same area. More...

virtual T	SetRotationAngle (float angleInRadians)
	Sets the rotation radAngle. More...

virtual T	SetRotationAngle (double angleInRadians)
	Sets the rotation angle. More...

virtual T	SetWidth (float width)
	Sets the width property of a block element, measured in points. More...

virtual T	SetWidth (UnitValue width)
	Sets the width property of a block element with a iText.Layout.Properties.UnitValue. More...

virtual UnitValue	GetWidth ()
	Gets the width property of a block element. More...

virtual T	SetHeight (UnitValue height)
	Sets the height property of a block element with a iText.Layout.Properties.UnitValue. More...

virtual T	SetHeight (float height)
	Sets the height property a block element as a point-value. More...

virtual UnitValue	GetHeight ()
	Gets the height property of a block element. More...

virtual T	SetMaxHeight (float maxHeight)
	Sets the max-height of a block element as point-unit value. More...

virtual T	SetMaxHeight (UnitValue maxHeight)
	Sets the max-height property of a block element with a iText.Layout.Properties.UnitValue. More...

virtual T	SetMinHeight (UnitValue minHeight)
	Sets the min-height property of a block element with a iText.Layout.Properties.UnitValue. More...

virtual T	SetMinHeight (float minHeight)
	Sets the min-height of a block element as point-unit value. More...

virtual T	SetMaxWidth (UnitValue maxWidth)
	Sets the max-width property of a block element with a iText.Layout.Properties.UnitValue. More...

virtual T	SetMaxWidth (float maxWidth)
	Sets the max-width of a block element as point-unit value. More...

virtual T	SetMinWidth (UnitValue minWidth)
	Sets the min-width property of a block element with a iText.Layout.Properties.UnitValue. More...

virtual T	SetMinWidth (float minWidth)
	Sets the min-width of a block element as point-unit value. More...

virtual T	SetNeutralRole ()
	Give this element a neutral role. More...

Detailed Description

A list item is a layout element that is one entry in a List.

A list item is a layout element that is one entry in a List . The list object controls the prefix, postfix, and numbering of the list items.

Constructor & Destructor Documentation

◆ ListItem() [1/3]

iText.Layout.Element.ListItem.ListItem ( )

inline

Creates a ListItem.

◆ ListItem() [2/3]

iText.Layout.Element.ListItem.ListItem ( String text )

inline

Creates a list item with text.

Parameters

text	the textual contents of the list item

◆ ListItem() [3/3]

iText.Layout.Element.ListItem.ListItem ( Image image )

inline

Creates a list item with an image.

Parameters

image the graphical contents of the list item

Member Function Documentation

◆ GetAccessibilityProperties()

override AccessibilityProperties iText.Layout.Element.ListItem.GetAccessibilityProperties ( )

inlinevirtual

Gets the accessibility properties.

Gets the accessibility properties . See also IAccessibleElement.

Returns: an interface that allows to specify properties of a tagged element in Tagged PDF.

Reimplemented from iText.Layout.Element.Div.

◆ SetListSymbol() [1/4]

virtual iText.Layout.Element.ListItem iText.Layout.Element.ListItem.SetListSymbol ( Image image )

inlinevirtual

Sets the list item symbol to be used.

Parameters

image the Image object to be used for the item.

Returns: this list.

◆ SetListSymbol() [2/4]

virtual iText.Layout.Element.ListItem iText.Layout.Element.ListItem.SetListSymbol ( ListNumberingType listNumberingType )

inlinevirtual

Sets the list item numbering type to be used.

Parameters

listNumberingType the iText.Layout.Properties.ListNumberingType that will generate appropriate prefixes for the ListItem.

Returns: this list item.

◆ SetListSymbol() [3/4]

virtual iText.Layout.Element.ListItem iText.Layout.Element.ListItem.SetListSymbol ( String symbol )

inlinevirtual

Sets the list item symbol to be used.

Parameters

symbol the textual symbol to be used for the item.

Returns: this list item.

◆ SetListSymbol() [4/4]

virtual iText.Layout.Element.ListItem iText.Layout.Element.ListItem.SetListSymbol ( Text text )

inlinevirtual

Sets the list item symbol to be used.

Parameters

text	the Text object to be used for the item.

Returns: this list item.

◆ SetListSymbolOrdinalValue()

virtual iText.Layout.Element.ListItem iText.Layout.Element.ListItem.SetListSymbolOrdinalValue ( int ordinalValue )

inlinevirtual

Customizes the index of the item in the list.

Parameters

ordinalValue the custom value property of an ordered list's list item.

Returns: this listItem.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ListItem() [1/3]

◆ ListItem() [2/3]

◆ ListItem() [3/3]

Member Function Documentation

◆ GetAccessibilityProperties()

◆ SetListSymbol() [1/4]

◆ SetListSymbol() [2/4]

◆ SetListSymbol() [3/4]

◆ SetListSymbol() [4/4]

◆ SetListSymbolOrdinalValue()