Struct MasterPage 

pub struct MasterPage {
    pub name: String,
    pub display_name: Option<String>,
    pub page_size: Option<PageSize>,
    pub orientation: Option<Orientation>,
    pub margins: Option<Margins>,
    pub header: Option<MasterPageRegion>,
    pub footer: Option<MasterPageRegion>,
    pub background_elements: Vec<MasterPageElement>,
    pub foreground_elements: Vec<MasterPageElement>,
    pub placeholders: HashMap<String, PlaceholderDefinition>,
    pub based_on: Option<String>,
}

A master page template that can be applied to document pages.

Master pages define reusable layouts including headers, footers, background elements, and placeholders for dynamic content.

Fields

name: String

Unique identifier for this master page.

display_name: Option<String>

Human-readable display name.

page_size: Option<PageSize>

Page size (overrides document default if specified).

orientation: Option<Orientation>

Page orientation (overrides document default if specified).

margins: Option<Margins>

Page margins.

header: Option<MasterPageRegion>

Header region definition.

footer: Option<MasterPageRegion>

Footer region definition.

background_elements: Vec<MasterPageElement>

Background elements (rendered behind content).

foreground_elements: Vec<MasterPageElement>

Foreground elements (rendered above content).

placeholders: HashMap<String, PlaceholderDefinition>

Placeholders for dynamic content insertion.

based_on: Option<String>

Parent master page to inherit from.

Implementations

impl MasterPage

pub fn new(name: impl Into<String>) -> Self

Create a new master page with the given name.

pub fn with_display_name(self, name: impl Into<String>) -> Self

Set the display name.

pub fn with_page_size(self, size: PageSize) -> Self

Set the page size.

pub fn with_orientation(self, orientation: Orientation) -> Self

Set the page orientation.

pub fn with_margins(self, margins: Margins) -> Self

Set the margins.

pub fn with_header(self, content: impl Into<String>) -> Self

Add a simple text header.

pub fn with_header_region(self, region: MasterPageRegion) -> Self

Add a header region.

pub fn with_footer(self, content: impl Into<String>) -> Self

Add a simple text footer.

pub fn with_footer_region(self, region: MasterPageRegion) -> Self

Add a footer region.

pub fn with_background_element(self, element: MasterPageElement) -> Self

Add a background element.

pub fn with_foreground_element(self, element: MasterPageElement) -> Self

Add a foreground element.

pub fn based_on(self, parent: impl Into<String>) -> Self

Set the parent master page.

pub fn default_master() -> Self

Create a standard “default” master page.

pub fn odd_page() -> Self

Create a master page for odd (right-hand) pages.

pub fn even_page() -> Self

Create a master page for even (left-hand) pages.

pub fn title_page() -> Self

Create a master page for title/cover pages.

Trait Implementations

impl Clone for MasterPage

fn clone(&self) -> MasterPage

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MasterPage

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MasterPage

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for MasterPage

fn eq(&self, other: &MasterPage) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for MasterPage

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MasterPage