iText 9.7.0 API
iText.Layout.Properties.Margins.FootnoteAnchor Class Reference

Class representing an anchor for a footnote which is placed at the bottom of the page. More...

Inheritance diagram for iText.Layout.Properties.Margins.FootnoteAnchor:
iText.Layout.Element.AbstractElement< iText.Layout.Properties.Margins.FootnoteAnchor > iText.Layout.Tagging.IAccessibleElement

Public Member Functions

  FootnoteAnchor (Footnote footnote)
  Creates new FootnoteAnchor instance. More...
 
  FootnoteAnchor (String text, Footnote footnote)
  Creates new FootnoteAnchor instance. More...
 
  FootnoteAnchor (Text text, Footnote footnote)
  Creates new FootnoteAnchor instance. More...
 
  FootnoteAnchor (Image image, Footnote footnote)
  Creates new FootnoteAnchor instance. More...
 
virtual IElement  GetFootnoteAnchor ()
  Gets layout element iText.Layout.Element.IElement representing footnote anchor. More...
 
virtual iText.Layout.Properties.Margins.FootnoteAnchor  SetFootnoteAnchor (Text footnoteAnchor)
  Sets iText.Layout.Element.Text layout element representing footnote anchor. More...
 
virtual iText.Layout.Properties.Margins.FootnoteAnchor  SetFootnoteAnchor (Image footnoteAnchor)
  Sets iText.Layout.Element.Image layout element representing footnote anchor. More...
 
virtual Footnote  GetFootnote ()
  Gets Footnote linked to this anchor. More...
 
virtual AccessibilityProperties  GetAccessibilityProperties ()
  Gets the accessibility properties. More...
 
- Public Member Functions inherited from iText.Layout.Element.AbstractElement< iText.Layout.Properties.Margins.FootnoteAnchor >
virtual IRenderer  GetRenderer ()
  Gets a renderer for this element. More...
 
virtual void  SetNextRenderer (IRenderer renderer)
  Overrides the iText.Layout.Renderer.IRenderer instance which will be returned by the next call to the GetRenderer(). More...
 
virtual IRenderer  CreateRendererSubTree ()
  Creates a renderer subtree with root in the current element. More...
 
override bool  HasProperty (int property)
  Checks if this entity has the specified property. More...
 
override T1  GetProperty< T1 > (int property)
  Gets the property from this entity. More...
 
virtual T  AddStyle (Style style)
  Add a new style to this element. More...
 
virtual IList< IElement GetChildren ()
  Gets the child elements of this elements More...
 
virtual bool  IsEmpty ()
  Returns true if this list contains no elements. More...
 
virtual T  SetAction (PdfAction action)
  Sets an action on this Element. More...
 
virtual T  SetPageNumber (int pageNumber)
  Explicitly sets the page number this element should be put on. More...
 

Package Functions

override IRenderer  MakeNewRenderer ()
  Creates a new renderer instance. More...
 

Package Attributes

DefaultAccessibilityProperties  tagProperties
 
- Package Attributes inherited from iText.Layout.Element.AbstractElement< iText.Layout.Properties.Margins.FootnoteAnchor >
IRenderer  nextRenderer
 
IList< IElement childElements
 
ICollection< Style styles
 

Detailed Description

Class representing an anchor for a footnote which is placed at the bottom of the page.

Class representing an anchor for a footnote which is placed at the bottom of the page. Footnote anchor indicates footnote in the text with superscript numbers (or letters or other symbols).

Constructor & Destructor Documentation

◆ FootnoteAnchor() [1/4]

iText.Layout.Properties.Margins.FootnoteAnchor.FootnoteAnchor ( Footnote  footnote )
inline

Creates new FootnoteAnchor instance.

Parameters
footnote

Footnote linked to this anchor

◆ FootnoteAnchor() [2/4]

iText.Layout.Properties.Margins.FootnoteAnchor.FootnoteAnchor ( String  text,
Footnote  footnote 
)
inline

Creates new FootnoteAnchor instance.

Parameters
text superscript text for anchor to indicate a footnote
footnote

Footnote linked to this anchor

◆ FootnoteAnchor() [3/4]

iText.Layout.Properties.Margins.FootnoteAnchor.FootnoteAnchor ( Text  text,
Footnote  footnote 
)
inline

Creates new FootnoteAnchor instance.

Parameters
text

iText.Layout.Element.Text for anchor to indicate a footnote

Parameters
footnote

Footnote linked to this anchor

◆ FootnoteAnchor() [4/4]

iText.Layout.Properties.Margins.FootnoteAnchor.FootnoteAnchor ( Image  image,
Footnote  footnote 
)
inline

Creates new FootnoteAnchor instance.

Parameters
image

iText.Layout.Element.Image to use as footnote anchor

Parameters
footnote

Footnote linked to this anchor

Member Function Documentation

◆ GetAccessibilityProperties()

virtual AccessibilityProperties iText.Layout.Properties.Margins.FootnoteAnchor.GetAccessibilityProperties ( )
inlinevirtual

◆ GetFootnote()

virtual Footnote iText.Layout.Properties.Margins.FootnoteAnchor.GetFootnote ( )
inlinevirtual

Gets Footnote linked to this anchor.

Returns

Footnote linked to this anchor

◆ GetFootnoteAnchor()

virtual IElement iText.Layout.Properties.Margins.FootnoteAnchor.GetFootnoteAnchor ( )
inlinevirtual

Gets layout element iText.Layout.Element.IElement representing footnote anchor.

Returns

iText.Layout.Element.IElement representing footnote anchor (can be iText.Layout.Element.Text or iText.Layout.Element.Image )

◆ MakeNewRenderer()

override IRenderer iText.Layout.Properties.Margins.FootnoteAnchor.MakeNewRenderer ( )
inlinepackagevirtual

Creates a new renderer instance.

Returns

Creates a new renderer instance.

Implements iText.Layout.Element.AbstractElement< iText.Layout.Properties.Margins.FootnoteAnchor >.

◆ SetFootnoteAnchor() [1/2]

virtual iText.Layout.Properties.Margins.FootnoteAnchor iText.Layout.Properties.Margins.FootnoteAnchor.SetFootnoteAnchor ( Image  footnoteAnchor )
inlinevirtual

Sets iText.Layout.Element.Image layout element representing footnote anchor.

Parameters
footnoteAnchor

iText.Layout.Element.Image layout element representing footnote anchor

Returns
this same FootnoteAnchor instance

◆ SetFootnoteAnchor() [2/2]

virtual iText.Layout.Properties.Margins.FootnoteAnchor iText.Layout.Properties.Margins.FootnoteAnchor.SetFootnoteAnchor ( Text  footnoteAnchor )
inlinevirtual

Sets iText.Layout.Element.Text layout element representing footnote anchor.

Parameters
footnoteAnchor

iText.Layout.Element.Text layout element representing footnote anchor

Returns
this same FootnoteAnchor instance