Skip to main content

PageBandSnapshot Class

Definition​

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

A page band in a document snapshot: the band's content as a nested document snapshot, the role and rule that place it, its identity, and an optional name for formats that reference bands by name.

public class PageBandSnapshot

Inheritance: object -> PageBandSnapshot

Constructors​

NameDescription
PageBandSnapshotInitializes a band snapshot.

PageBandSnapshot Constructor​

Initializes a band snapshot.

public PageBandSnapshot(string name, Avalonia.Controls.Documents.Serialization.Snapshot.DocumentSnapshot content, Avalonia.Controls.Documents.PageBandRole role, Avalonia.Controls.Documents.PageBandRule rule, Guid id)

Parameters​

name string

content Avalonia.Controls.Documents.Serialization.Snapshot.DocumentSnapshot

role Avalonia.Controls.Documents.PageBandRole

rule Avalonia.Controls.Documents.PageBandRule

id Guid

Properties​

NameDescription
ContentThe band's content.
IdThe band's identity: what a section's references name, kept by the restored band.
NameThe band's name, when the source format named it; null otherwise.
RoleWhether the band is a header or a footer.
RuleWhich pages the band claims by itself.

Content Property​

The band's content.

public Avalonia.Controls.Documents.Serialization.Snapshot.DocumentSnapshot Content { get; set; }

Id Property​

The band's identity: what a section's references name, kept by the restored band.

public Guid Id { get; set; }

Name Property​

The band's name, when the source format named it; null otherwise.

public string Name { get; set; }

Role Property​

Whether the band is a header or a footer.

public Avalonia.Controls.Documents.PageBandRole Role { get; set; }

Rule Property​

Which pages the band claims by itself.

public Avalonia.Controls.Documents.PageBandRule Rule { get; set; }