{"id":2334,"date":"2026-09-27T16:00:01","date_gmt":"2026-09-27T08:00:01","guid":{"rendered":"https:\/\/xlwings.net\/blog\/?p=2334"},"modified":"2026-03-28T13:16:33","modified_gmt":"2026-03-28T13:16:33","slug":"how-to-use-worksheetpagesetup-in-the-xlwings-api-way","status":"publish","type":"post","link":"https:\/\/xlwings.net\/blog\/how-to-use-worksheetpagesetup-in-the-xlwings-api-way\/","title":{"rendered":"How to use Worksheet.PageSetup in the xlwings API way"},"content":{"rendered":"\n

The PageSetup member of the Worksheet object in xlwings provides comprehensive control over printing settings, allowing users to configure page layout, margins, orientation, scaling, headers, footers, and other print-related properties programmatically. This is essential for generating professional reports and ensuring printed documents match specific formatting requirements. Through xlwings, you can access these settings using the api<\/code> property to interact with the underlying Excel object model, enabling automation of print preparation tasks directly from Python.<\/p>\n\n\n\n

Functionality:<\/strong>
The PageSetup object is used to manage all aspects of page setup for printing a worksheet. Key functionalities include setting page orientation (portrait or landscape), adjusting margins (top, bottom, left, right, header, footer), defining paper size, scaling printouts (by percentage or to fit a certain number of pages), and configuring headers and footers with text, page numbers, dates, or other elements. It also allows control over print titles, gridlines, and comments.<\/p>\n\n\n\n

Syntax:<\/strong>
In xlwings, you access the PageSetup member via the worksheet object’s api<\/code> property. The general syntax is:<\/p>\n\n\n\n

worksheet.api.PageSetup.PropertyName\nworksheet.api.PageSetup.MethodName(Arguments)<\/code><\/pre>\n\n\n\n
Where worksheet<\/code> is an xlwings Worksheet object. Properties can be get or set, while methods perform actions. Common properties and methods include:<\/p>\n\n\n\n
    \n
  • Properties:<\/strong> Orientation<\/code>, Zoom<\/code>, FitToPagesTall<\/code>, FitToPagesWide<\/code>, TopMargin<\/code>, BottomMargin<\/code>, LeftMargin<\/code>, RightMargin<\/code>, HeaderMargin<\/code>, FooterMargin<\/code>, PaperSize<\/code>, PrintTitleRows<\/code>, PrintTitleColumns<\/code>, PrintGridlines<\/code>, PrintHeadings<\/code>, LeftHeader<\/code>, CenterHeader<\/code>, RightHeader<\/code>, LeftFooter<\/code>, CenterFooter<\/code>, RightFooter<\/code>.<\/li>\n\n\n\n
  • Methods:<\/strong> PrintPreview()<\/code>, PrintOut()<\/code>.<\/li>\n<\/ul>\n\n\n\n
    Parameters for methods like PrintOut()<\/code> typically include: From<\/code>, To<\/code>, Copies<\/code>, Preview<\/code>, ActivePrinter<\/code>, PrintToFile<\/code>, Collate<\/code>, PrToFileName<\/code>. These can be specified as keyword arguments. Property values are often integers or strings; for example, Orientation<\/code> can be set to 1<\/code> for portrait or 2<\/code> for landscape, and margins are in points.<\/p>\n\n\n\n
    Examples:<\/strong>
    Here are xlwings API code instances demonstrating the use of PageSetup:<\/p>\n\n\n\n
      \n
    1. Setting Page Orientation and Scaling:<\/strong><\/li>\n<\/ol>\n\n\n\n
      import xlwings as xw\nwb = xw.Book('example.xlsx')\nsheet = wb.sheets['Sheet1']\n\n# Set landscape orientation\nsheet.api.PageSetup.Orientation = 2 # 2 for landscape, 1 for portrait\n\n# Set zoom to 80%\nsheet.api.PageSetup.Zoom = 80\n\n# Scale to fit to 1 page wide and 1 page tall\nsheet.api.PageSetup.FitToPagesTall = 1\nsheet.api.PageSetup.FitToPagesWide = 1<\/code><\/pre>\n\n\n\n
        \n
      1. Adjusting Margins:<\/strong><\/li>\n<\/ol>\n\n\n\n
        # Set margins in points (1 point = 1\/72 inch)\nsheet.api.PageSetup.TopMargin = 50\nsheet.api.PageSetup.BottomMargin = 50\nsheet.api.PageSetup.LeftMargin = 70\nsheet.api.PageSetup.RightMargin = 70\nsheet.api.PageSetup.HeaderMargin = 30\nsheet.api.PageSetup.FooterMargin = 30<\/code><\/pre>\n\n\n\n
          \n
        1. Configuring Headers and Footers:<\/strong><\/li>\n<\/ol>\n\n\n\n
          # Set header and footer text\nsheet.api.PageSetup.LeftHeader = \"&LReport Date: &D\"\nsheet.api.PageSetup.CenterHeader = \"&CSales Data\"\nsheet.api.PageSetup.RightHeader = \"&RPage &P of &N\"\nsheet.api.PageSetup.LeftFooter = \"&LConfidential\"\nsheet.api.PageSetup.CenterFooter = \"&C&F\"\nsheet.api.PageSetup.RightFooter = \"&RPrinted at &T\"<\/code><\/pre>\n\n\n\n
          Here, &L<\/code>, &C<\/code>, &R<\/code> align left, center, right; &D<\/code> is current date, &T<\/code> is current time, &P<\/code> is page number, &N<\/code> is total pages, &F<\/code> is file name.<\/p>\n\n\n\n
            \n
          1. Setting Print Titles and Gridlines:<\/strong><\/li>\n<\/ol>\n\n\n\n
            # Set rows 1:1 as print titles\nsheet.api.PageSetup.PrintTitleRows = \"$1:$1\"\n\n# Print gridlines\nsheet.api.PageSetup.PrintGridlines = True\n\n# Print row and column headings\nsheet.api.PageSetup.PrintHeadings = True<\/code><\/pre>\n\n\n\n
              \n
            1. Printing the Worksheet:<\/strong><\/li>\n<\/ol>\n\n\n\n
              # Preview print\nsheet.api.PageSetup.PrintPreview()\n\n# Print directly (optional parameters)\nsheet.api.PageSetup.PrintOut(From=1, To=1, Copies=2, Preview=False, Collate=True)<\/code><\/pre>\n\n\n\n
              <\/p>\n","protected":false},"excerpt":{"rendered":"
              The PageSetup member of the Worksheet object in xlwings provides comprehensive control over printing…<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[25],"tags":[],"class_list":["post-2334","post","type-post","status-publish","format-standard","hentry","category-xlwings-api-reference"],"_links":{"self":[{"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/posts\/2334","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/comments?post=2334"}],"version-history":[{"count":1,"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/posts\/2334\/revisions"}],"predecessor-version":[{"id":3556,"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/posts\/2334\/revisions\/3556"}],"wp:attachment":[{"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/media?parent=2334"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/categories?post=2334"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/xlwings.net\/blog\/wp-json\/wp\/v2\/tags?post=2334"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}