iText 9.8.0 API
iText.Layout.Properties.Margins.FootnotesProperties Class Reference

Class representing properties to customize footnotes. More...

Public Member Functions

  FootnotesProperties ()
  Creates new FootnotesProperties instance. More...
 
virtual ? FootnoteNumberingType  GetFootnoteNumberingType ()
  Gets FootnoteNumberingType? representing numbering type for footnote anchors. More...
 
virtual iText.Layout.Properties.Margins.FootnotesProperties  SetFootnoteNumberingType (FootnoteNumberingType? footnoteNumberingType)
  Sets FootnoteNumberingType? representing numbering type for footnote anchors. More...
 
virtual FootnoteNumberingConfig  GetFootnoteNumberingConfig ()
  Gets FootnoteNumberingConfig representing numbering configuration for footnotes. More...
 
virtual iText.Layout.Properties.Margins.FootnotesProperties  SetFootnoteNumberingConfig (FootnoteNumberingConfig footnoteNumberingConfig)
  Sets FootnoteNumberingConfig representing numbering configuration for footnotes. More...
 
virtual Style  GetFootnotesContainerStyle ()
  Gets iText.Layout.Style storing style properties for footnotes container. More...
 
virtual iText.Layout.Properties.Margins.FootnotesProperties  SetFootnotesContainerStyle (Style footnotesContainerStyle)
  Sets iText.Layout.Style storing style properties for footnotes container. More...
 
virtual Style  GetFootnoteAnchorLabelStyle ()
  Gets iText.Layout.Style storing style properties for footnote anchors that are placed inside the footnotes container. More...
 
virtual iText.Layout.Properties.Margins.FootnotesProperties  SetFootnoteAnchorLabelStyle (Style footnoteAnchorLabelStyle)
  Sets iText.Layout.Style storing style properties for footnote anchors that are placed inside the footnotes container. More...
 
virtual Style  GetFootnoteAnchorStyle ()
  Gets iText.Layout.Style storing style properties for footnote anchors. More...
 
virtual iText.Layout.Properties.Margins.FootnotesProperties  SetFootnoteAnchorStyle (Style footnoteAnchorStyle)
  Sets iText.Layout.Style storing style properties for footnote anchors. More...
 

Detailed Description

Class representing properties to customize footnotes.

Class representing properties to customize footnotes.

Can be specified via iText.Layout.Document.SetFootnotesProperties(FootnotesProperties) or iText.Layout.Element.SectionBreak.SetFootnotesProperties(FootnotesProperties).

Constructor & Destructor Documentation

◆ FootnotesProperties()

iText.Layout.Properties.Margins.FootnotesProperties.FootnotesProperties ( )
inline

Creates new FootnotesProperties instance.

Member Function Documentation

◆ GetFootnoteAnchorLabelStyle()

virtual Style iText.Layout.Properties.Margins.FootnotesProperties.GetFootnoteAnchorLabelStyle ( )
inlinevirtual

Gets iText.Layout.Style storing style properties for footnote anchors that are placed inside the footnotes container.

Returns

iText.Layout.Style storing properties for footnote anchors that are inside the footnotes

◆ GetFootnoteAnchorStyle()

virtual Style iText.Layout.Properties.Margins.FootnotesProperties.GetFootnoteAnchorStyle ( )
inlinevirtual

Gets iText.Layout.Style storing style properties for footnote anchors.

Returns

iText.Layout.Style storing properties for footnote anchors

◆ GetFootnoteNumberingConfig()

virtual FootnoteNumberingConfig iText.Layout.Properties.Margins.FootnotesProperties.GetFootnoteNumberingConfig ( )
inlinevirtual

Gets FootnoteNumberingConfig representing numbering configuration for footnotes.

Returns

FootnoteNumberingConfig representing footnotes numbering configuration

◆ GetFootnoteNumberingType()

virtual ? FootnoteNumberingType iText.Layout.Properties.Margins.FootnotesProperties.GetFootnoteNumberingType ( )
inlinevirtual

Gets FootnoteNumberingType? representing numbering type for footnote anchors.

Returns

FootnoteNumberingType? numbering type

◆ GetFootnotesContainerStyle()

virtual Style iText.Layout.Properties.Margins.FootnotesProperties.GetFootnotesContainerStyle ( )
inlinevirtual

Gets iText.Layout.Style storing style properties for footnotes container.

Returns

iText.Layout.Style storing properties for footnotes container

◆ SetFootnoteAnchorLabelStyle()

virtual iText.Layout.Properties.Margins.FootnotesProperties iText.Layout.Properties.Margins.FootnotesProperties.SetFootnoteAnchorLabelStyle ( Style  footnoteAnchorLabelStyle )
inlinevirtual

Sets iText.Layout.Style storing style properties for footnote anchors that are placed inside the footnotes container.

Parameters
footnoteAnchorLabelStyle

iText.Layout.Style storing properties for footnote anchors inside the footnotes

Returns
this same FootnotesProperties instance

◆ SetFootnoteAnchorStyle()

virtual iText.Layout.Properties.Margins.FootnotesProperties iText.Layout.Properties.Margins.FootnotesProperties.SetFootnoteAnchorStyle ( Style  footnoteAnchorStyle )
inlinevirtual

Sets iText.Layout.Style storing style properties for footnote anchors.

Parameters
footnoteAnchorStyle

iText.Layout.Style storing properties for footnote anchors

Returns
this same FootnotesProperties instance

◆ SetFootnoteNumberingConfig()

virtual iText.Layout.Properties.Margins.FootnotesProperties iText.Layout.Properties.Margins.FootnotesProperties.SetFootnoteNumberingConfig ( FootnoteNumberingConfig  footnoteNumberingConfig )
inlinevirtual

Sets FootnoteNumberingConfig representing numbering configuration for footnotes.

Parameters
footnoteNumberingConfig

FootnoteNumberingConfig representing footnotes numbering configuration

Returns
this same FootnotesProperties instance

◆ SetFootnoteNumberingType()

virtual iText.Layout.Properties.Margins.FootnotesProperties iText.Layout.Properties.Margins.FootnotesProperties.SetFootnoteNumberingType ( FootnoteNumberingType?  footnoteNumberingType )
inlinevirtual

Sets FootnoteNumberingType? representing numbering type for footnote anchors.

Parameters
footnoteNumberingType

FootnoteNumberingType? representing numbering type for footnote anchors

Returns
this same FootnotesProperties instance

◆ SetFootnotesContainerStyle()

virtual iText.Layout.Properties.Margins.FootnotesProperties iText.Layout.Properties.Margins.FootnotesProperties.SetFootnotesContainerStyle ( Style  footnotesContainerStyle )
inlinevirtual

Sets iText.Layout.Style storing style properties for footnotes container.

Parameters
footnotesContainerStyle

iText.Layout.Style storing properties for footnotes container

Returns
this same FootnotesProperties instance