Skip to main content

PageBandCollection Class

Definition​

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

The page bands a document owns, as elements: a view over the text document's Avalonia.Controls.Documents.TextModel.TextDocument.PageBands, which owns the bands, materializing a Avalonia.Controls.Documents.PageBand element per band on demand. It follows the contract of the block collection: the document becomes a band's logical parent the moment it is added; while the document has no text document the band waits pending, and it joins the text document when that is initialized, before the pending blocks materialize; once the text document exists a band joins it at once. Removing a band releases owner, logical parent and undo and clears every section reference to it. Ownership is exclusive: a band owned by another document is refused until it is removed there. The first band with a given role and rule is the one the rule places.

public class PageBandCollection

Inheritance: object -> PageBandCollection

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

Methods​

NameDescription
AddNo summary available.
ClearNo summary available.
ContainsNo summary available.
CopyToNo summary available.
Find (2 overloads)The first band with role and rule: the one the rule places.
GetEnumeratorNo summary available.
IndexOfNo summary available.
InsertNo summary available.
RemoveNo summary available.
RemoveAtNo summary available.

Add Method​

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

Parameters​

item Avalonia.Controls.Documents.PageBand

Clear Method​

public void Clear()

Contains Method​

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

Parameters​

item Avalonia.Controls.Documents.PageBand

Returns​

bool

CopyTo Method​

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

Parameters​

array Avalonia.Controls.Documents.PageBand[]

arrayIndex int

Find overloads​

Find Method​

The first band with role and rule: the one the rule places.

public Avalonia.Controls.Documents.PageBand Find(Avalonia.Controls.Documents.PageBandRole role, Avalonia.Controls.Documents.PageBandRule rule)
Parameters​

role Avalonia.Controls.Documents.PageBandRole

rule Avalonia.Controls.Documents.PageBandRule

Returns​

Avalonia.Controls.Documents.PageBand

Find Method​

The band with id, or null: what a section's reference names.

public Avalonia.Controls.Documents.PageBand Find(Guid id)
Parameters​

id Guid

Returns​

Avalonia.Controls.Documents.PageBand

GetEnumerator Method​

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

Returns​

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

IndexOf Method​

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

Parameters​

item Avalonia.Controls.Documents.PageBand

Returns​

int

Insert Method​

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

Parameters​

index int

item Avalonia.Controls.Documents.PageBand

Remove Method​

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

Parameters​

item Avalonia.Controls.Documents.PageBand

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.PageBand Item { get; set; }