This class is the default entry point for XML signatures and can be used for validating an existing signed office document and signing a office document.

Validating a signed office document

            OPCPackage pkg = OPCPackage.open(..., PackageAccess.READ);
            SignatureConfig sic = new SignatureConfig();
            sic.setOpcPackage(pkg);
            SignatureInfo si = new SignatureInfo();
            si.setSignatureConfig(sic);
            boolean isValid = si.validate();
            ...
            

Signing an office document

            // loading the keystore - pkcs12 is used here, but of course jks & co are also valid
            // the keystore needs to contain a private key and it's certificate having a
            // 'digitalSignature' key usage
            char password[] = "test".toCharArray();
            File file = new File("test.pfx");
            KeyStore keystore = KeyStore.getInstance("PKCS12");
            FileInputStream fis = new FileInputStream(file);
            keystore.load(fis, password);
            fis.close();
            
            // extracting private key and certificate
            String alias = "xyz"; // alias of the keystore entry
            Key key = keystore.getKey(alias, password);
            X509Certificate x509 = (X509Certificate)keystore.getCertificate(alias);
            
            // filling the SignatureConfig entries (minimum fields, more options are available ...)
            SignatureConfig signatureConfig = new SignatureConfig();
            signatureConfig.setKey(keyPair.getPrivate());
            signatureConfig.setSigningCertificateChain(Collections.singletonList(x509));
            OPCPackage pkg = OPCPackage.open(..., PackageAccess.READ_WRITE);
            signatureConfig.setOpcPackage(pkg);
            
            // adding the signature document to the package
            SignatureInfo si = new SignatureInfo();
            si.setSignatureConfig(signatureConfig);
            si.confirmSignature();
            // optionally verify the generated signature
            boolean b = si.verifySignature();
            assert (b);
            // write the changes back to disc
            pkg.close();
            

Implementation notes:

Although there's a XML signature implementation in the Oracle JDKs 6 and higher, compatibility with IBM JDKs is also in focus (... but maybe not thoroughly tested ...). Therefore we are using the Apache Santuario libs (xmlsec) instead of the built-in classes, as the compatibility seems to be provided there.

To use SignatureInfo and its sibling classes, you'll need to have the following libs in the classpath:

• BouncyCastle bcpkix and bcprov (tested against 1.51)
• Apache Santuario "xmlsec" (tested against 2.0.1)
• and slf4j-api (tested against 1.7.7)

Each POIXMLDocumentPart keeps a reference to the underlying a {@link org.apache.poi.openxml4j.opc.PackagePart}.

             protected void commit()  {
               PackagePart part = GetPackagePart();
               Stream out = part.GetStream();
               XmlObject bean = GetXmlBean(); //the "model" which holds Changes in memory
               bean.save(out, DEFAULT_XML_OPTIONS);
               out.close();
             }
              

• all mandatory elements and attributes must be mapped (enable validation to check this)
• no <any> in complex type/element declaration
• no <anyAttribute> attributes declaration
• no recursive structures: recursive structures can't be nested more than one level
• no abstract elements: abstract complex types can be declared but must not be used in elements.
• no mixed content: an element can't contain simple text and child element(s) together
• no <substitutionGroup> in complex type/element declaration

A workbook may contain thousands of cells Containing string (non-numeric) data. Furthermore this data is very likely to be repeated across many rows or columns. The goal of implementing a single string table that is shared across the workbook is to improve performance in opening and saving the file by only Reading and writing the repetitive information once.

Consider for example a workbook summarizing information for cities within various countries. There may be a column for the name of the country, a column for the name of each city in that country, and a column Containing the data for each city. In this case the country name is repetitive, being duplicated in many cells. In many cases the repetition is extensive, and a tremendous savings is realized by making use of a shared string table when saving the workbook. When displaying text in the spreadsheet, the cell table will just contain an index into the string table as the value of a cell, instead of the full string.

The shared string table Contains all the necessary information for displaying the string: the text, formatting properties, and phonetic properties (for East Asian languages).

If the Shared String table already Contains this CT_Rst bean, its index is returned. Otherwise a new entry is aded.

• the value 0 if the row number of this SXSSFRow is equal to the row number of the argument SXSSFRow
• a value less than 0 if the row number of this this SXSSFRow is numerically less than the row number of the argument SXSSFRow
• a value greater than 0 if the row number of this this SXSSFRow is numerically greater than the row number of the argument SXSSFRow

This process can be relatively slow on large sheets, so this should normally only be called once per column, at the end of your processing.

Special note about SXSSF implementation: You must register the columns you wish to track with the SXSSFSheet using {@link #trackColumnForAutoSizing(int)} or {@link #trackAllColumnsForAutoSizing()}. This is needed because the rows needed to compute the column width may have fallen outside the random access window and been flushed to disk. Tracking columns is required even if all rows are in the random access window.

New in POI 3.14 beta 1: auto-sizes columns using cells from current and flushed rows.

This process can be relatively slow on large sheets, so this should normally only be called once per column, at the end of your processing.

Special note about SXSSF implementation: You must register the columns you wish to track with the SXSSFSheet using {@link #trackColumnForAutoSizing(int)} or {@link #trackAllColumnsForAutoSizing()}. This is needed because the rows needed to compute the column width may have fallen outside the random access window and been flushed to disk. Tracking columns is required even if all rows are in the random access window.

New in POI 3.14 beta 1: auto-sizes columns using cells from current and flushed rows.

groupRows requires all rows in the group to be in the current window. This is not always practical. Instead use setRowOutlineLevel to explicitly set the group level. Level 1 is the top level group, followed by 2, etc. It is up to the user to ensure that level 2 groups are correctly nested under level 1, etc.

When a new node is created via createRow() and the total number of unflushed records would exceed the specified value, then the row with the lowest index value is flushed and cannot be accessed via getRow() anymore.

A value of -1 indicates unlimited access. In this case all records that have not been flushed by a call to flush() are available for random access.

A value of 0 is not allowed because it would flush any newly created row without having a chance to specify any cells.

There are three use-cases to use SXSSFWorkbook(XSSFWorkbook) :

1. Append new sheets to existing workbooks. You can open existing workbook from a file or create on the fly with XSSF.
2. Append rows to existing sheets. The row number MUST be greater than max(rownum) in the template sheet.
3. Use existing workbook as a template and re-use global objects such as cell styles, formats, images, etc.

• Access initial cells and rows in the template. After constructing SXSSFWorkbook(XSSFWorkbook) all internal windows are empty and SXSSFSheet@getRow and SXSSFRow#getCell return null.
• Override existing cells and rows. The API silently allows that but the output file is invalid and Excel cannot read it.

When a new node is created via createRow() and the total number of unflushed records would exceed the specified value, then the row with the lowest index value is flushed and cannot be accessed via getRow() anymore.

A value of -1 indicates unlimited access. In this case all records that have not been flushed by a call to flush() are available for random access.

A value of 0 is not allowed because it would flush any newly created row without having a chance to specify any cells.

When a new node is created via createRow() and the total number of unflushed records would exceed the specified value, then the row with the lowest index value is flushed and cannot be accessed via getRow() anymore.

A value of -1 indicates unlimited access. In this case all records that have not been flushed by a call to flush() are available for random access.

A value of 0 is not allowed because it would flush any newly created row without having a chance to specify any cells.

When a new node is created via createRow() and the total number of unflushed records would exceed the specified value, then the row with the lowest index value is flushed and cannot be accessed via getRow() anymore.

A value of -1 indicates unlimited access. In this case all records that have not been flushed by a call to flush() are available for random access.

A value of 0 is not allowed because it would flush any newly created row without having a chance to specify any cells.

SXSSF writes sheet data in temporary files (a temp file per-sheet) and the size of these temp files can grow to to a very large size, e.g. for a 20 MB csv data the size of the temp xml file become few GB large. If the "compress" flag is set to true then the temporary XML is gzipped.

Please note the the "compress" option may cause performance penalty.

The idea is to parse every formula and render it back to string with the updated sheet name. This is done by parsing into Ptgs, looking for ones with sheet references in them, and changing those

Autofit specifies that a shape should be auto-fit to fully contain the text described within it. Auto-fitting is when text within a shape is scaled in order to contain all the text inside

Example: Consider the situation where a user is building a diagram and needs to have the text for each shape that they are using stay within the bounds of the shape. An easy way this might be done is by using NORMAL autofit

Example: Consider the situation where a user is building a diagram and needs to have the text for each shape that they are using stay within the bounds of the shape. An easy way this might be done is by using SHAPE autofit

Cells can be numeric, formula-based or string-based (text). The cell type specifies this. String cells cannot conatin numbers and numeric cells cannot contain strings (at least according to our model). Client apps should do the conversions themselves. Formula cells have the formula string, as well as the formula result, which can be numeric or string.

Cells should have their number (0 based) before being Added to a row. Only cells that have values should be Added.

For strings, numbers, and errors, we throw an exception. For blank cells we return a false.

For strings we throw an exception. For blank cells we return a 0. For formulas or error cells we return the precalculated value;

For numeric cells we throw an exception. For blank cells we return an empty string. For formulaCells that are not string Formulas, we throw an exception

For numeric cells we throw an exception. For blank cells we return an empty string. For formula cells we return the pre-calculated value if a string, otherwise an exception

Note, this method only Sets the formula string and does not calculate the formula value. To Set the precalculated value use {@link #setCellValue(double)} or {@link #setCellValue(String)}

If the cell Contains a string, then this value is an index into the shared string table, pointing to the actual string value. Otherwise, the value of the cell is expressed directly in this element. Cells Containing formulas express the last calculated result of the formula in this element.

Usually the caller is calling SetCellType() with the intention of calling SetCellValue(bool) straight afterwards. This method only exists to give the cell a somewhat reasonable value until the SetCellValue() call (if at all). TODO - perhaps a method like SetCellTypeAndValue(int, Object) should be introduced to avoid this The purpose of this method is to validate the cell state prior to modification @see #NotifyArrayFormulaChanging()

Note - many cells are actually Filled with a foreground Fill, not a background fill - see {@link #getFillForegroundColor()}

Many cells are Filled with this, instead of a background color ({@link #getFillBackgroundColor()})

Chart sheet is a special kind of Sheet that Contains only chart and no data.

If tint is supplied, then it is applied to the RGB value of the ctColor to determine the final ctColor applied.

The tint value is stored as a double from -1.0 .. 1.0, where -1.0 means 100% darken and 1.0 means 100% lighten. Also, 0.0 means no Change.

In loading the RGB value, it is Converted to HLS where HLS values are (0..HLSMAX), where HLSMAX is currently 255.

             If (tint < 0)
             Lum' = Lum * (1.0 + tint)
            
             For example: Lum = 200; tint = -0.5; Darken 50%
             Lum' = 200 * (0.5) => 100
             For example: Lum = 200; tint = -1.0; Darken 100% (make black)
             Lum' = 200 * (1.0-1.0) => 0
             If (tint > 0)
             Lum' = Lum * (1.0-tint) + (HLSMAX - HLSMAX * (1.0-tint))
             For example: Lum = 100; tint = 0.75; Lighten 75%
            
             Lum' = 100 * (1-.75) + (HLSMAX - HLSMAX*(1-.75))
             = 100 * .25 + (255 - 255 * .25)
             = 25 + (255 - 63) = 25 + 192 = 217
             For example: Lum = 100; tint = 1.0; Lighten 100% (make white)
             Lum' = 100 * (1-1) + (HLSMAX - HLSMAX*(1-1))
             = 100 * 0 + (255 - 255 * 0)
             = 0 + (255 - 0) = 255
             

MUST be a constant from {@link NPOI.ss.usermodel.ComparisonOperator}

If the condition type is {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS}, this field is the first operand of the comparison. If type is {@link ConditionalFormattingRule#CONDITION_TYPE_FORMULA}, this formula is used to determine if the conditional formatting is applied.

If comparison type is {@link ConditionalFormattingRule#CONDITION_TYPE_FORMULA} the formula MUST be a Boolean function

Even page header value. Corresponds to even printed pages. Even page(s) in the sheet may not be printed, for example, if the print area is specified to be a range such that it falls outside an even page's scope. If no even header is specified, then odd header value is assumed for even page headers.

For performance reasons, this class keeps a cache of all previously calculated intermediate cell values. Be sure to call {@link #ClearAllCachedResultValues()} if any workbook cells are Changed between calls to Evaluate~ methods on this class. @author Amol S. Deshmukh < amolweb at ya hoo dot com > @author Josh Micich @param stabilityClassifier used to optimise caching performance. Pass null for the (conservative) assumption that any cell may have its defInition Changed After Evaluation begins. @param udfFinder pass null for default (AnalysisToolPak only) Loops over all cells in all sheets of the supplied workbook. For cells that contain formulas, their formulas are Evaluated, and the results are saved. These cells remain as formula cells. For cells that do not contain formulas, no Changes are made. This is a helpful wrapper around looping over all cells, and calling EvaluateFormulaCell on each one. Loops over all cells in all sheets of the supplied workbook. For cells that contain formulas, their formulas are Evaluated, and the results are saved. These cells remain as formula cells. For cells that do not contain formulas, no Changes are made. This is a helpful wrapper around looping over all cells, and calling EvaluateFormulaCell on each one. Turns a XSSFCell into a XSSFEvaluationCell Represents DrawingML GraphicalObjectFrame. @author Roman Kashitsyn Construct a new XSSFGraphicFrame object. @param Drawing the XSSFDrawing that owns this frame @param ctGraphicFrame the XML bean that stores this frame content Initialize default structure of a new graphic frame Sets the frame macro. Returns the frame name. @return name of the frame Returns the frame anchor. @return the anchor this frame is attached to Assign a DrawingML chart to the graphic frame. Gets the frame id. High level representation for Icon / Multi-State Formatting component of Conditional Formatting Settings Always . You cannot change text of a line break. This class : the Map element (Open Office XML Part 4: chapter 3.16.2) This element Contains all of the properties related to the XML map, and the behaviors expected during data refresh operations. @author Roberto Manicardi @return the list of Single Xml Cells that provide a map rule to this mapping. @return the list of all Tables that provide a map rule to this mapping Represents a defined named range in a SpreadsheetML workbook.

Defined names are descriptive text that is used to represents a cell, range of cells, formula, or constant value. Use easy-to-understand names, such as Products, to refer to hard to understand ranges, such as Sales!C20:C30.

               XSSFWorkbook wb = new XSSFWorkbook();
               XSSFSheet sh = wb.CreateSheet("Sheet1");
            
               //applies to the entire workbook
               XSSFName name1 = wb.CreateName();
               name1.SetNameName("FMLA");
               name1.SetRefersToFormula("Sheet1!$B$3");
            
               //applies to Sheet1
               XSSFName name2 = wb.CreateName();
               name2.SetNameName("SheetLevelName");
               name2.SetComment("This name is scoped to Sheet1");
               name2.SetLocalSheetId(0);
               name2.SetRefersToFormula("Sheet1!$B$3");
            
             

Please note, that this method works correctly only for workbooks with the default font size (Calibri 11pt for .xlsx). If the default font is Changed the resized image can be streched vertically or horizontally.

Please note, that this method works correctly only for workbooks with the default font size (Calibri 11pt for .xlsx). If the default font is changed the resized image can be streched vertically or horizontally.

resize(1.0,1.0) keeps the original size,
resize(0.5,0.5) resize to 50% of the original,
resize(2.0,2.0) resizes to 200% of the original.
resize({@link Double#MAX_VALUE},{@link Double#MAX_VALUE}) resizes to the dimension of the embedded image.

Most strings in a workbook have formatting applied at the cell level, that is, the entire string in the cell has the same formatting applied. In these cases, the formatting for the cell is stored in the styles part, and the string for the cell can be shared across the workbook. The following code illustrates the example.

                 cell1.SetCellValue(new XSSFRichTextString("Apache POI"));
                 cell2.SetCellValue(new XSSFRichTextString("Apache POI"));
                 cell3.SetCellValue(new XSSFRichTextString("Apache POI"));
             

Some strings in the workbook may have formatting applied at a level that is more granular than the cell level. For instance, specific characters within the string may be bolded, have coloring, italicizing, etc. In these cases, the formatting is stored along with the text in the string table, and is treated as a unique entry in the workbook. The following xml and code snippet illustrate this.

                 XSSFRichTextString s1 = new XSSFRichTextString("Apache POI");
                 s1.ApplyFont(boldArial);
                 cell1.SetCellValue(s1);
            
                 XSSFRichTextString s2 = new XSSFRichTextString("Apache POI");
                 s2.ApplyFont(italicCourier);
                 cell2.SetCellValue(s2);
             

Example: The Unicode character 0D is invalid in an XML 1.0 document, so it shall be escaped as _x000D_.

             for(Cell cell : row){
                 ...
             }
             

• the value 0 if the row number of this XSSFRow is equal to the row number of the argument XSSFRow
• a value less than 0 if the row number of this this XSSFRow is numerically less than the row number of the argument XSSFRow
• a value greater than 0 if the row number of this this XSSFRow is numerically greater than the row number of the argument XSSFRow

             short minColIx = row.GetFirstCellNum();
             short maxColIx = row.GetLastCellNum();
             for(short colIx=minColIx; colIx<maxColIx; colIx++) {
               XSSFCell cell = row.GetCell(colIx);
               if(cell == null) {
                 continue;
               }
               //... do something with cell
             }
             

Sheets are the central structures within a workbook, and are where a user does most of his spreadsheet work. The most common type of sheet is the worksheet, which is represented as a grid of cells. Worksheet cells can contain text, numbers, dates, and formulas. Cells can also be formatted.

This process can be relatively slow on large sheets, so this should normally only be called once per column, at the end of your Processing.

If both colSplit and rowSplit are zero then the existing freeze pane is Removed

Note, the returned value is always gerater that {@link #GetDefaultColumnWidth()} because the latter does not include margins. Actual column width measured as the number of characters of the maximum digit width of the numbers 0, 1, 2, ..., 9 as rendered in the normal style's font. There are 4 pixels of margin pAdding (two on each side), plus 1 pixel pAdding for the gridlines.

Please note, that this method works correctly only for workbooks with the default font size (Calibri 11pt for .xlsx).

Note, this value is different from {@link #GetColumnWidth(int)}. The latter is always greater and includes 4 pixels of margin pAdding (two on each side), plus 1 pixel pAdding for the gridlines.

When true a summary row is inserted below the detailed data being summarized and a new outline level is established on that row.

When false a summary row is inserted above the detailed data being summarized and a new outline level is established on that row.

When true a summary column is inserted to the right of the detailed data being summarized and a new outline level is established on that column.

When false a summary column is inserted to the left of the detailed data being summarized and a new outline level is established on that column.

Row heading are the row numbers to the side of the sheet

Column heading are the letters or numbers that appear above the columns of the sheet

* The maximum column width for an individual cell is 255 characters. * This value represents the number of characters that can be displayed * in a cell that is formatted with the standard font (first font in the workbook). *

* Character width is defined as the maximum digit width * of the numbers 0, 1, 2, ... 9 as rendered * using the default font (first font in the workbook). *
* Unless you are using a very special font, the default character is '0' (zero), * this is true for Arial (default font font in HSSF) and Calibri (default font in XSSF) *

* Please note, that the width set by this method includes 4 pixels of margin pAdding (two on each side), * plus 1 pixel pAdding for the gridlines (Section 3.3.1.12 of the OOXML spec). * This results is a slightly less value of visible characters than passed to this method (approx. 1/2 of a character). *

* To compute the actual number of visible characters, * Excel uses the following formula (Section 3.3.1.12 of the OOXML spec): *

Using the Calibri font as an example, the maximum digit width of 11 point font size is 7 pixels (at 96 dpi). * If you set a column width to be eight characters wide, e.g. SetColumnWidth(columnIndex, 8*256), * then the actual value of visible characters (the value Shown in Excel) is derived from the following equation: * TRuncate([numChars*7+5]/7*256)/256 = 8; * * * which gives 7.29. *

             10 - 10%
             20 - 20%
             ...
             100 - 100%
             ...
             400 - 400%
             

Additionally Shifts merged regions that are completely defined in these rows (ie. merged 2 cells on a row to be Shifted).

Additionally Shifts merged regions that are completely defined in these rows (ie. merged 2 cells on a row to be Shifted).

When only 1 sheet is selected and active, this value should be in synch with the activeTab value. In case of a conflict, the Start Part Setting wins and Sets the active sheet tab.

TODO - formulas Containing cell references are currently not Parsed properly @param comparisonOperation - a constant value from {@link NPOI.hssf.record.CFRuleRecord.ComparisonOperator}:

• BETWEEN
• NOT_BETWEEN
• EQUAL
• NOT_EQUAL
• GT
• LT
• GE
• LE

Note that the closest properties object to the text is used, therefore if there is a conflict between the text paragraph properties and the list style properties for this level then the text paragraph properties will take precedence.

The size is specified using a percentage. Positive values indicate superscript, negative values indicate subscript.

In Excel 2007 VML Drawings are used to describe properties of cell comments, although the spec says that VML is deprecated:

The VML format is a legacy format originally introduced with Office 2000 and is included and fully defined in this Standard for backwards compatibility reasons. The DrawingML format is a newer and richer format Created with the goal of eventually replacing any uses of VML in the Office Open XML formats. VML should be considered a deprecated format included in Office Open XML for legacy reasons only and new applications that need a file format for Drawings are strongly encouraged to use preferentially DrawingML

Warning - Excel is known to Put invalid XML into these files! For example, >br< without being closed or escaped crops up.

                  OPCPackage pkg = OPCPackage.open(path);
                  XSSFWorkbook wb = new XSSFWorkbook(pkg);
                  // work with the wb object
                  ......
                  pkg.close(); // gracefully closes the underlying zip file
              

Note that Excel allows sheet names up to 31 chars in length but other applications (such as OpenOffice) allow more. Some versions of Excel crash with names longer than 31 chars, others - tRuncate such names to 31 character.

POI's SpreadsheetAPI silently tRuncates the input argument to 31 characters. Example:

                 Sheet sheet = workbook.CreateSheet("My very long sheet name which is longer than 31 chars"); // will be tRuncated
                 assert 31 == sheet.SheetName.Length;
                 assert "My very long sheet name which i" == sheet.SheetName;
                 

Sheet name MUST be unique in the workbook and MUST NOT contain the any of the following characters:

• 0x0000
• 0x0003
• colon (:)
• backslash (\)
• asterisk (*)
• question mark (?)
• forward slash (/)
• opening square bracket ([)
• closing square bracket (])

See {@link org.apache.poi.ss.util.WorkbookUtil#createSafeSheetName(String nameProposal)} for a safe way to create valid names

             XSSFWorkbook wb = new XSSFWorkbook(package);
             for(XSSFSheet sheet : wb){
            
             }
             

Care must be taken if the Removed sheet is the currently active or only selected sheet in the workbook. There are a few situations when Excel must have a selection and/or active sheet. (For example when printing - see Bug 40414).
This method Makes sure that if the Removed sheet was active, another sheet will become active in its place. Furthermore, if the Removed sheet was the only selected sheet, another sheet will become selected. The newly active/selected sheet will have the same index, or one less if the Removed sheet was the last in the workbook. @param index of the sheet (0-based) Gracefully remove references to the sheet being deleted @param index the 0-based index of the sheet to delete Retrieves the current policy on what to do when Getting missing or blank cells from a row. The default is to return blank and null cells. {@link MissingCellPolicy} Validate sheet index @param index the index to validate @throws ArgumentException if the index is out of range (index < 0 || index >= NumberOfSheets). Gets the first tab that is displayed in the list of tabs in excel. @return integer that Contains the index to the active sheet in this book view. For the Convenience of Java Programmers maintaining pointers. @see #setPrintArea(int, String) @param sheetIndex Zero-based sheet index (0 = First Sheet) @param startColumn Column to begin printarea @param endColumn Column to end the printarea @param startRow Row to begin the printarea @param endRow Row to end the printarea Generates a NameRecord to represent a built-in region @return a new NameRecord @throws ArgumentException if sheetNumber is invalid @throws POIXMLException if such a name already exists in the workbook We only Set one sheet as selected for compatibility with HSSF. Set the sheet name. @param sheetIndex sheet number (0 based) @param sheetname the new sheet name @throws ArgumentException if the name is null or invalid or workbook already Contains a sheet with this name @see {@link #CreateSheet(String)} @see {@link NPOI.ss.util.WorkbookUtil#CreateSafeSheetName(String nameProposal)} for a safe way to create valid names Sets the order of appearance for a given sheet. @param sheetname the name of the sheet to reorder @param pos the position that we want to insert the sheet into (0 based) marshal named ranges from the {@link #namedRanges} collection to the underlying CT_Workbook bean

Note that a sheet could instead be Set to be very hidden, which is different ({@link #isSheetVeryHidden(int)})

This is different from the normal hidden status ({@link #isSheetHidden(int)})

Calling setSheetHidden(sheetIndex, true) is equivalent to setSheetHidden(sheetIndex, Workbook.SHEET_STATE_HIDDEN).
Calling setSheetHidden(sheetIndex, false) is equivalent to setSheetHidden(sheetIndex, Workbook.SHEET_STATE_VISIBLE).

• 0 - visible.
• 1 - hidden.
• 2 - very hidden.

The calculation chain object specifies the order in which the cells in a workbook were last calculated

The external links table specifies details of named ranges etc * that are referenced from other workbooks, along with the last seen * values of what they point to.

Note that Excel uses index 0 for the current workbook, so the first * External Links in a formula would be '[1]Foo' which corresponds to * entry 0 in this list.

The default instance : the built-in functions with the Excel Analysis Tool Pack. To Set / Evaluate custom functions you need to register them as follows:

Typically you want to force formula recalculation when you modify cell formulas or values of a workbook previously Created by Excel. When Set to true, this flag will tell Excel that it needs to recalculate all formulas in the workbook the next time the file is opened.

Note, that recalculation updates cached formula results and, thus, modifies the workbook. Depending on the version, Excel may prompt you with "Do you want to save the Changes in filename?" on close.

WARNING - APIs expected to change rapidly.

These classes have so far been built only for Read-only Processing. @return first SDT Title @return first SDT Tag @return the content object @return null @return document part @return partType @return element type

9 Jan 2010

// TODO insert Javadoc here!

• Line borders: which specify a pattern to be used when Drawing a line around the specified object.
• Art borders: which specify a repeated image to be used when Drawing a border around the specified object. Line borders may be specified on any object which allows a border, however, art borders may only be used as a border at the page level - the borders under the pgBorders element

if the border is on the left or right, no border is displayed.

• If this line is broken into multiple regions (a floating object in the center of the page has text wrapping on both sides:
  • If this is the leftmost region of text flow on this line, advance the text to the next position on the line
  • Otherwise, treat this as a text wrapping break of type all.
• If this line is not broken into multiple regions, then treat this break as a text wrapping break of type none.

If the current section is not divided into columns, or the column break occurs in the last column on the current page when displayed, then the restart location for text shall be the next page in the document.

WARNING - APIs expected to change rapidly Interface for anything that can be within an STD: {@link XWPFRun}, {@link XWPFTable}, {@link XWPFParagraph}, {@link XWPFSDT} etc Specifies the logic which shall be used to calculate the line spacing of the parent object when it is displayed in the document. @author Gisella Bronzetti Specifies that the line spacing of the parent object shall be automatically determined by the size of its contents, with no predetermined minimum or maximum size. Specifies that the height of the line shall be exactly the value specified, regardless of the size of the contents If the contents are too large for the specified height, then they shall be clipped as necessary. Specifies that the height of the line shall be at least the value specified, but may be expanded to fit its content as needed. Specifies all types of alignment which are available to be applied to objects in a WordProcessingML document @author Yegor Kozlov * postion of a character in a paragrapho * 1st RunPositon * 2nd TextPosition * 3rd CharacterPosition * * Specifies all types of vertical alignment which are available to be applied to of all text on each line displayed within a paragraph. @author Gisella Bronzetti Specifies that all text in the parent object shall be aligned to the top of each character when displayed Specifies that all text in the parent object shall be aligned to the center of each character when displayed. Specifies that all text in the parent object shall be aligned to the baseline of each character when displayed. Specifies that all text in the parent object shall be aligned to the bottom of each character when displayed. Specifies that all text in the parent object shall be aligned automatically when displayed. saves the begin and end position of a text in a Paragraph

High(ish) level class for working with .docx files.

This class tries to hide some of the complexity of the underlying file format, but as it's not a mature and stable API yet, certain parts of the XML structure come through. You'll therefore almost certainly need to refer to the OOXML specifications from http://www.ecma-international.org/publications/standards/Ecma-376.htm at some point in your use.

                 <w:settings  ... >
                     <w:documentProtection w:edit="readOnly" w:enforcement="1"/>
             

                <w:settings  ... >
                    <w:documentProtection w:edit="readOnly" w:enforcement="1"/>
            

                <w:settings  ... >
                    <w:documentProtection w:edit="forms" w:enforcement="1"/>
            

                <w:settings  ... >
                    <w:documentProtection w:edit="comments" w:enforcement="1"/>
            

                <w:settings  ... >
                    <w:documentProtection w:edit="trackedChanges" w:enforcement="1"/>
            

                <w:settings  ... >
                    <w:documentProtection w:edit="readOnly" w:enforcement="1"/>
            

                <w:settings  ... >
                    <w:documentProtection w:edit="forms" w:enforcement="1"/>
            

                <w:settings  ... >
                    <w:documentProtection w:edit="comments" w:enforcement="1"/>
            

                <w:settings  ... >
                    <w:documentProtection w:edit="trackedChanges" w:enforcement="1"/>
            

• Causing Word to ask on open: "This document contains fields that may refer to other files. Do you want to update the fields in this document?" (if "Update automatic links at open" is enabled)
• Flag is removed after saving with changes in Word

A Paragraph within a Document, Table, Header etc.

A paragraph has a lot of styling information, but the actual text (possibly along with more styling) is held on the child {@link XWPFRun}s.

If this element is not Set on a given paragraph, its value is determined by the Setting previously Set at any level of the style hierarchy (i.e. that previous Setting remains unChanged). If this Setting is never specified in the style hierarchy, then no alignment is applied to the paragraph.

If the line height (before any Added spacing) is larger than one or more characters on the line, all characters will be aligned to each other as specified by this element.

If this element is omitted on a given paragraph, its value is determined by the Setting previously Set at any level of the style hierarchy (i.e. that previous Setting remains unChanged). If this Setting is never specified in the style hierarchy, then the vertical alignment of all characters on the line shall be automatically determined by the consumer.

If this element is omitted on a given paragraph, its value is determined by the Setting previously Set at any level of the style hierarchy (i.e. that previous Setting remains unChanged). If this Setting is never specified in the style hierarchy, then this property shall not be applied. Since the paragraph is specified to start on a new page, it begins page two even though it could have fit on page one.

If this attribute is omitted, its value shall be assumed to be zero. Negative values are defined such that the text is Moved past the text margin, positive values Move the text inside the text margin.

If this attribute is omitted, its value shall be assumed to be zero. Negative values are defined such that the text is Moved past the text margin, positive values Move the text inside the text margin.

Note, that this call might be expensive since all the picture data is copied into a temporary byte array. You can grab the picture data directly from the underlying package part as follows:
InputStream is1 = GetPackagePart().InputStream;

This formatting property is a toggle property, which specifies that its behavior differs between its use within a style defInition and its use as direct formatting. When used as part of a style defInition, Setting this property shall toggle the current state of that property as specified up to this point in the hierarchy (i.e. applied to not applied, and vice versa). Setting it to false (or an equivalent) shall result in the current Setting remaining unChanged. However, when used as direct formatting, Setting this property to true or false shall Set the absolute state of the resulting property.

If this element is not present, the default value is to leave the formatting applied at previous level in the style hierarchy. If this element is never applied in the style hierarchy, then bold shall not be applied to non-complex script characters.

This formatting property is a toggle property, which specifies that its behavior differs between its use within a style defInition and its use as direct formatting. When used as part of a style defInition, Setting this property shall toggle the current state of that property as specified up to this point in the hierarchy (i.e. applied to not applied, and vice versa). Setting it to false (or an equivalent) shall result in the current Setting remaining unChanged. However, when used as direct formatting, Setting this property to true or false shall Set the absolute state of the resulting property.

If this element is not present, the default value is to leave the formatting applied at previous level in the style hierarchy. If this element is never applied in the style hierarchy, then strikethrough shall not be applied to the contents of this run.

The behavior of this break character (the location where text shall be restarted After this break) shall be determined by its type values.

The behavior of this break character (the location where text shall be restarted After this break) shall be determined by its type (in this case is BreakType.TEXT_WRAPPING as default) and clear attribute values.

These can contain one or more cells or other SDTs within them.

WARNING - APIs expected to change rapidly Experimental class to offer rudimentary Read-only Processing of of the contentblock of an SDT/ContentControl. WARNING - APIs expected to change rapidly Experimental class to offer rudimentary Read-only Processing of of the XWPFSDTCellContent.

WARNING - APIs expected to change rapidly In the zoom tag inside Settings.xml file
it Sets the value of zoom @return percentage as an integer of zoom level

sample snippet from settings.xml

                 <w:settings  ... >
                     <w:documentProtection w:edit="readOnly" w:enforcement="1"/>
             

                <w:settings  ... >
                    <w:documentProtection w:edit="readOnly" w:enforcement="1"/>
            

                <w:settings  ... >
                    <w:documentProtection w:edit="[passed editValue]" w:enforcement="1"/>
            

• Causing Word to ask on open: "This document contains fields that may refer to other files. Do you want to update the fields in this document?" (if "Update automatic links at open" is enabled)
• Flag is removed after saving with changes in Word

Sketch of XWPFTable class. Only table's text is being hold.

Specifies the contents of a table present in the document. A table is a set of paragraphs (and other block-level content) arranged in rows and columns.