Skip to main content

FootnoteCollection Class

Definition​

Assembly:Avalonia.Controls.Documents
Package:Avalonia.Controls.Documents

The footnotes a document owns, as elements, in anchor order: a view over the text document's Avalonia.Controls.Documents.TextModel.TextDocument.Footnotes, which owns the notes, materializing a Avalonia.Controls.Documents.Footnote element per note on demand. It follows the contract of the block collection: the document becomes a note's logical parent the moment it is added; while the document has no text document the note waits pending, and it joins the text document when that is initialized, before the pending blocks materialize; once the text document exists a note joins it at once. Under the anchor-owns-its-note lifecycle the notes come and go with their anchors; a note added here pairs with the anchor carrying its id, or waits for one. Ownership is exclusive, and a nested document (a page band, a note) owns no notes.

public class FootnoteCollection

Inheritance: object -> FootnoteCollection

Implements: ICollection<Footnote>, IEnumerable<Footnote>, IList<Footnote>, IReadOnlyCollection<Footnote>, IReadOnlyList<Footnote>, IEnumerable

Methods​

NameDescription
AddNo summary available.
ClearNo summary available.
ContainsNo summary available.
CopyToNo summary available.
FindThe note with noteId, or null.
GetEnumeratorNo summary available.
IndexOfNo summary available.
InsertNo summary available.
RemoveNo summary available.
RemoveAtNo summary available.

Add Method​

public void Add(Avalonia.Controls.Documents.Footnote item)

Parameters​

item Avalonia.Controls.Documents.Footnote

Clear Method​

public void Clear()

Contains Method​

public bool Contains(Avalonia.Controls.Documents.Footnote item)

Parameters​

item Avalonia.Controls.Documents.Footnote

Returns​

bool

CopyTo Method​

public void CopyTo(Avalonia.Controls.Documents.Footnote[] array, int arrayIndex)

Parameters​

array Avalonia.Controls.Documents.Footnote[]

arrayIndex int

Find Method​

The note with noteId, or null.

public Avalonia.Controls.Documents.Footnote Find(int noteId)

Parameters​

noteId int

Returns​

Avalonia.Controls.Documents.Footnote

GetEnumerator Method​

public System.Collections.Generic.IEnumerator<Avalonia.Controls.Documents.Footnote> GetEnumerator()

Returns​

System.Collections.Generic.IEnumerator<Avalonia.Controls.Documents.Footnote>

IndexOf Method​

public int IndexOf(Avalonia.Controls.Documents.Footnote item)

Parameters​

item Avalonia.Controls.Documents.Footnote

Returns​

int

Insert Method​

public void Insert(int index, Avalonia.Controls.Documents.Footnote item)

Parameters​

index int

item Avalonia.Controls.Documents.Footnote

Remove Method​

public bool Remove(Avalonia.Controls.Documents.Footnote item)

Parameters​

item Avalonia.Controls.Documents.Footnote

Returns​

bool

RemoveAt Method​

public void RemoveAt(int index)

Parameters​

index int

Properties​

NameDescription
CountNo summary available.
IsReadOnlyNo summary available.
ItemNo summary available.

Count Property​

public int Count { get; set; }

IsReadOnly Property​

public bool IsReadOnly { get; set; }

Item Property​

public Avalonia.Controls.Documents.Footnote Item { get; set; }