---
name: "Excel::Template::Container::Worksheet"
section: "3pm"
platform: "linux"
package: "libexcel-template-perl"
version: "0.34-3"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/Excel::Template::Container::Worksheet"
---

# Excel::Template::Container::Worksheet(3pm)

Excel::Template::Container::Worksheet

## NAME

Excel::Template::Container::Worksheet - Excel::Template::Container::Worksheet

## PURPOSE

To provide a new worksheet.

## NODE NAME

WORKSHEET

## INHERITANCE

Excel::Template::Container

## ATTRIBUTES

- •

  NAME

  This is the name of the worksheet to be added.

- •

  PROTECT

  If the attribute exists, it will mark the worksheet as being protected. Whatever value is set will be used as the password.

  This activates the HIDDEN and LOCKED nodes.

- •

  KEEP\_LEADING\_ZEROS

  This will change the behavior of the worksheet to preserve leading zeros.

- •

  HIDE\_GRIDLINE

  his method is used to hide the gridlines on the screen and printed page.  Gridlines are the lines that divide the cells on a worksheet. Screen and printed gridlines are  turned on by default in an Excel worksheet. If you have defined your own cell  borders you may wish to hide the default gridlines.

  `$worksheet`-\>**hide\_gridlines()**;

  The following values of `$option` are valid:

  ```
      0 : Don't hide gridlines
      1 : Hide printed gridlines only
      2 : Hide screen and printed gridlines
  ```

  If you don't supply an argument or use undef the default option is 1, i.e. only the printed gridlines are hidden.

- •

  LANDSCAPE

  This will set the worksheet's orientation to landscape.

- •

  PORTRAIT

  This will set the worksheet's orientation to portrait.

  While this is the default, it's useful to override the default at times. For example, in the following situation:

  ```
    <workbook landscape="1">
      <worksheet>
        ...
      </worksheet
      <worksheet portrait="1">
        ...
      </worksheet
      <worksheet>
        ...
      </worksheet
    </workbook>
  ```

  In that example, the first and third worksheets will be landscape (inheriting it from the workbook node), but the second worksheet will be portrait.

- •

  AUTOFILTER

  With these attribute, you can add the autofilter to a worksheet. An autofilter is a way of adding drop down lists to the headers of a 2D range of worksheet data.  This is turn allow users to filter the data based on simple criteria so that  some data is shown and some is hidden.

  Example to add an autofilter to a worksheet:\
       \<workbook\>\
         \<worksheet autofilter='A1:D11' /\>\
         \<worksheet autofilter='0, 0, 10, 3' /\>\
       \</workbook\>

## CHILDREN

None

## EFFECTS

None

## DEPENDENCIES

None

## USAGE

```
  <worksheet name="My Taxes">
    ... Children here
  </worksheet>
```

In the above example, the children will be executed in the context of the "My Taxes" worksheet.

## AUTHOR

Rob Kinyon (rob.kinyon@gmail.com)

## SEE ALSO

ROW, CELL, FORMULA