Skip to main content

PageBandReferences Struct

Definition​

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

A section's explicit band references by band identity: the running header and footer, and the first-page header and footer, whose presence is what makes the section's first page special. An identity no band of the document carries binds to nothing, so a section pasted from another document arrives without references.

public struct PageBandReferences

Inheritance: ValueType -> PageBandReferences

Implements: IEquatable<PageBandReferences>

Methods​

NameDescription
Equals (2 overloads)No summary available.
GetHashCodeNo summary available.
ToStringNo summary available.
WithNo summary available.

Equals overloads​

Equals Method​

public bool Equals(Avalonia.Controls.Documents.Serialization.Snapshot.PageBandReferences other)
Parameters​

other Avalonia.Controls.Documents.Serialization.Snapshot.PageBandReferences

Returns​

bool

Equals Method​

public bool Equals(object obj)
Parameters​

obj object

Returns​

bool

GetHashCode Method​

public int GetHashCode()

Returns​

int

ToString Method​

public string ToString()

Returns​

string

With Method​

public Avalonia.Controls.Documents.Serialization.Snapshot.PageBandReferences With(Avalonia.Controls.Documents.PageBandRole role, Avalonia.Controls.Documents.PageBandRule rule, Nullable<Guid> id)

Parameters​

role Avalonia.Controls.Documents.PageBandRole

rule Avalonia.Controls.Documents.PageBandRule

id Nullable<Guid>

Returns​

Avalonia.Controls.Documents.Serialization.Snapshot.PageBandReferences

Properties​

NameDescription
FirstPageFooterThe footer of the section's first page, or null for no special first page.
FirstPageHeaderThe header of the section's first page, or null for no special first page.
FooterThe running footer, or null for the document's default band.
HasFirstPageWhether the section's first page is special: a first-page slot is set.
HeaderThe running header, or null for the document's default band.
IsEmptyWhether no slot is set.
ItemNo summary available.

FirstPageFooter Property​

The footer of the section's first page, or null for no special first page.

public Nullable<Guid> FirstPageFooter { get; set; }

FirstPageHeader Property​

The header of the section's first page, or null for no special first page.

public Nullable<Guid> FirstPageHeader { get; set; }

The running footer, or null for the document's default band.

public Nullable<Guid> Footer { get; set; }

HasFirstPage Property​

Whether the section's first page is special: a first-page slot is set.

public bool HasFirstPage { get; set; }

Header Property​

The running header, or null for the document's default band.

public Nullable<Guid> Header { get; set; }

IsEmpty Property​

Whether no slot is set.

public bool IsEmpty { get; set; }

Item Property​

public Nullable<Guid> Item { get; set; }

Fields​

NameDescription
SlotsThe four slots in the order the indexer and Avalonia.Controls.Documents.Serialization.Snapshot.PageBandReferences.With(Avalonia.Controls.Documents.PageBandRole,Avalonia.Controls.Documents.PageBandRule,Nullable{Guid}) address them: the running band per role, then the first-page band per role. Enumerate this to walk every reference a section can hold. A section addresses bands by Avalonia.Controls.Documents.PageBandRule.Default and Avalonia.Controls.Documents.PageBandRule.FirstPage only; the document-level pool carries the other rules.

Slots Field​

The four slots in the order the indexer and Avalonia.Controls.Documents.Serialization.Snapshot.PageBandReferences.With(Avalonia.Controls.Documents.PageBandRole,Avalonia.Controls.Documents.PageBandRule,Nullable{Guid}) address them: the running band per role, then the first-page band per role. Enumerate this to walk every reference a section can hold. A section addresses bands by Avalonia.Controls.Documents.PageBandRule.Default and Avalonia.Controls.Documents.PageBandRule.FirstPage only; the document-level pool carries the other rules.

public ValueTuple<Avalonia.Controls.Documents.PageBandRole, Avalonia.Controls.Documents.PageBandRule>[] Slots