Print Settings and Page Setup

This guide explains how to configure print settings and page setup options in UmyaSpreadsheet.

Overview

UmyaSpreadsheet provides various functions to control how your worksheets appear when printed. These include:

• Page orientation (portrait/landscape)
• Paper size
• Page scaling
• Fit-to options
• Page margins
• Headers and footers
• Print centering
• Print area
• Print titles (repeating rows/columns)

Basic Print Setup

Page Orientation

Set and get the page orientation to portrait or landscape:

# Set to landscape orientation
UmyaSpreadsheet.set_page_orientation(spreadsheet, "Sheet1", "landscape")

# Set to portrait orientation
UmyaSpreadsheet.set_page_orientation(spreadsheet, "Sheet1", "portrait")

# Get current orientation
case UmyaSpreadsheet.get_page_orientation(spreadsheet, "Sheet1") do
  {:ok, orientation} -> IO.puts("Current orientation: #{orientation}")  # "landscape" or "portrait"
  {:error, reason} -> IO.puts("Error: #{reason}")
end

Paper Size

Set and get the paper size using standard size codes:

# Set to A4 paper (code 9)
UmyaSpreadsheet.set_paper_size(spreadsheet, "Sheet1", 9)

# Set to US Letter (code 1)
UmyaSpreadsheet.set_paper_size(spreadsheet, "Sheet1", 1)

# Get current paper size
{:ok, paper_size} = UmyaSpreadsheet.get_paper_size(spreadsheet, "Sheet1")
IO.puts("Current paper size code: #{paper_size}")

Common paper size codes:

• 1: Letter (8.5 x 11 in)
• 5: Legal (8.5 x 14 in)
• 9: A4 (210 x 297 mm)
• 10: A3 (297 x 420 mm)

Page Scaling

Scale the content to a percentage of its original size:

# Scale to 75%
UmyaSpreadsheet.set_page_scale(spreadsheet, "Sheet1", 75)

# Get current scale
{:ok, scale} = UmyaSpreadsheet.get_page_scale(spreadsheet, "Sheet1")
IO.puts("Current scale: #{scale}%")  # Example: 75

Valid scale values range from 10 to 400 percent.

Fit-to Options

Make your content fit a specific number of pages:

# Fit to 1 page wide by 1 page tall
UmyaSpreadsheet.set_fit_to_page(spreadsheet, "Sheet1", 1, 1)

# Fit to 1 page wide by however many pages needed vertically (0 means no limit)
UmyaSpreadsheet.set_fit_to_page(spreadsheet, "Sheet1", 1, 0)

# Get current fit-to-page settings
{width, height} = UmyaSpreadsheet.get_fit_to_page(spreadsheet, "Sheet1")
IO.puts("Fit to #{width} page(s) wide by #{height} page(s) tall")

Page Margins

Set the page margins in inches:

# Set margins (top, right, bottom, left)
UmyaSpreadsheet.set_page_margins(spreadsheet, "Sheet1", 1.0, 0.75, 1.0, 0.75)

# Get current margins
{top, right, bottom, left} = UmyaSpreadsheet.get_page_margins(spreadsheet, "Sheet1")
IO.puts("Margins - Top: #{top}, Right: #{right}, Bottom: #{bottom}, Left: #{left}")

Set header and footer margins specifically:

# Set header margin to 0.5 inches and footer margin to 0.5 inches
UmyaSpreadsheet.set_header_footer_margins(spreadsheet, "Sheet1", 0.5, 0.5)

# Get current header/footer margins
{header_margin, footer_margin} = UmyaSpreadsheet.get_header_footer_margins(spreadsheet, "Sheet1")
IO.puts("Header margin: #{header_margin}, Footer margin: #{footer_margin}")

Headers and Footers

Set header content with formatting codes:

# Set a centered, bold header
UmyaSpreadsheet.set_header(spreadsheet, "Sheet1", "&C&\"Arial,Bold\"Confidential Document")

# Get current header
{:ok, header_text} = UmyaSpreadsheet.get_header(spreadsheet, "Sheet1")
IO.puts("Current header: #{header_text}")

Set footer content:

# Set right-aligned page numbers
UmyaSpreadsheet.set_footer(spreadsheet, "Sheet1", "&RPage &P of &N")

# Get current footer
{:ok, footer_text} = UmyaSpreadsheet.get_footer(spreadsheet, "Sheet1")
IO.puts("Current footer: #{footer_text}")

Header/Footer Formatting Codes

• Position codes:

  • &L: Left section
  • &C: Center section
  • &R: Right section

• Font formatting:

  • &"Font,Style": Set font name and style
  • &B: Bold
  • &I: Italic
  • &U: Underline
  • &S: Strikethrough
  • &nn: Font size (where nn is the size)

• Content codes:

  • &P: Current page number
  • &N: Total pages
  • &D: Current date
  • &T: Current time
  • &F: File name
  • &A: Sheet name

Inspecting Print Settings

You can retrieve current print settings to inspect or modify existing spreadsheets:

# Get all current print settings
{:ok, orientation} = UmyaSpreadsheet.get_page_orientation(spreadsheet, "Sheet1")
{:ok, paper_size} = UmyaSpreadsheet.get_paper_size(spreadsheet, "Sheet1")
{:ok, scale} = UmyaSpreadsheet.get_page_scale(spreadsheet, "Sheet1")
{fit_width, fit_height} = UmyaSpreadsheet.get_fit_to_page(spreadsheet, "Sheet1")
{top, right, bottom, left} = UmyaSpreadsheet.get_page_margins(spreadsheet, "Sheet1")
{header_margin, footer_margin} = UmyaSpreadsheet.get_header_footer_margins(spreadsheet, "Sheet1")
{:ok, header} = UmyaSpreadsheet.get_header(spreadsheet, "Sheet1")
{:ok, footer} = UmyaSpreadsheet.get_footer(spreadsheet, "Sheet1")
{h_center, v_center} = UmyaSpreadsheet.get_print_centered(spreadsheet, "Sheet1")
{:ok, print_area} = UmyaSpreadsheet.get_print_area(spreadsheet, "Sheet1")
{title_rows, title_cols} = UmyaSpreadsheet.get_print_titles(spreadsheet, "Sheet1")

IO.puts("Print Settings for Sheet1:")
IO.puts("  Orientation: #{orientation}")
IO.puts("  Paper Size: #{paper_size}")
IO.puts("  Scale: #{scale}%")
IO.puts("  Fit to: #{fit_width} x #{fit_height} pages")
IO.puts("  Margins: T:#{top} R:#{right} B:#{bottom} L:#{left}")
IO.puts("  Header/Footer Margins: #{header_margin} / #{footer_margin}")
IO.puts("  Header: #{header || "None"}")
IO.puts("  Footer: #{footer || "None"}")
IO.puts("  Centered: H:#{h_center} V:#{v_center}")
IO.puts("  Print Area: #{print_area || "All"}")
IO.puts("  Print Titles: Rows:#{title_rows || "None"} Cols:#{title_cols || "None"}")

Print Centering

Center the content on the page:

# Center horizontally only
UmyaSpreadsheet.set_print_centered(spreadsheet, "Sheet1", true, false)

# Center both horizontally and vertically
UmyaSpreadsheet.set_print_centered(spreadsheet, "Sheet1", true, true)

# Get current centering settings
{horizontal, vertical} = UmyaSpreadsheet.get_print_centered(spreadsheet, "Sheet1")
IO.puts("Centered - Horizontal: #{horizontal}, Vertical: #{vertical}")

Print Area

Define a specific area to print:

# Only print cells A1 through H20
UmyaSpreadsheet.set_print_area(spreadsheet, "Sheet1", "A1:H20")

# Get current print area
case UmyaSpreadsheet.get_print_area(spreadsheet, "Sheet1") do
  {:ok, range} -> IO.puts("Print area: #{range}")
  {:error, _} -> IO.puts("No print area defined")
end

Print Titles

Set rows and/or columns to repeat on each printed page:

# Repeat rows 1 and 2 at the top of each page
UmyaSpreadsheet.set_print_titles(spreadsheet, "Sheet1", "1:2", "")

# Repeat columns A and B on each page
UmyaSpreadsheet.set_print_titles(spreadsheet, "Sheet1", "", "A:B")

# Repeat both rows and columns
UmyaSpreadsheet.set_print_titles(spreadsheet, "Sheet1", "1:2", "A:B")

# Get current print titles
{rows, columns} = UmyaSpreadsheet.get_print_titles(spreadsheet, "Sheet1")
case {rows, columns} do
  {nil, nil} -> IO.puts("No print titles defined")
  {rows, nil} -> IO.puts("Print title rows: #{rows}")
  {nil, columns} -> IO.puts("Print title columns: #{columns}")
  {rows, columns} -> IO.puts("Print title rows: #{rows}, columns: #{columns}")
end

Complete Example

Here's a complete example of setting up a worksheet for printing and then inspecting the settings:

{:ok, spreadsheet} = UmyaSpreadsheet.new()

# Configure print settings
UmyaSpreadsheet.set_page_orientation(spreadsheet, "Sheet1", "landscape")
UmyaSpreadsheet.set_paper_size(spreadsheet, "Sheet1", 9)  # A4
UmyaSpreadsheet.set_fit_to_page(spreadsheet, "Sheet1", 1, 0)  # Fit to 1 page wide
UmyaSpreadsheet.set_page_margins(spreadsheet, "Sheet1", 0.75, 0.75, 0.75, 0.75)
UmyaSpreadsheet.set_header(spreadsheet, "Sheet1", "&L&D&R&F")
UmyaSpreadsheet.set_footer(spreadsheet, "Sheet1", "&RPage &P of &N")
UmyaSpreadsheet.set_print_area(spreadsheet, "Sheet1", "A1:G20")
UmyaSpreadsheet.set_print_titles(spreadsheet, "Sheet1", "1:1", "")

# Verify the settings were applied
{:ok, orientation} = UmyaSpreadsheet.get_page_orientation(spreadsheet, "Sheet1")
{:ok, paper_size} = UmyaSpreadsheet.get_paper_size(spreadsheet, "Sheet1")
{fit_width, fit_height} = UmyaSpreadsheet.get_fit_to_page(spreadsheet, "Sheet1")
{:ok, print_area} = UmyaSpreadsheet.get_print_area(spreadsheet, "Sheet1")

IO.puts("Applied settings:")
IO.puts("  Orientation: #{orientation}")      # "landscape"
IO.puts("  Paper size: #{paper_size}")        # 9
IO.puts("  Fit to: #{fit_width}x#{fit_height}") # 1x0
IO.puts("  Print area: #{print_area}")        # "A1:G20"

# Write the file
UmyaSpreadsheet.write(spreadsheet, "print_settings_example.xlsx")