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 idea is to parse every formula and render it back to string with the updated sheet name. The IFormulaParsingWorkbook passed to the formula Parser is constructed from the old workbook (sheet name is not yet updated) and the FormulaRenderingWorkbook passed to FormulaRenderer#toFormulaString is a custom implementation that returns the new sheet name.

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.

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()

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 - many cells are actually Filled with a foreground Fill, not a background fill - see {@link #getFillForegroundColor()}

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()})

Expressed in degrees. Values range from 0 to 180. The first letter of the text is considered the center-point of the arc.
For 0 - 90, the value represents degrees above horizon. For 91-180 the degrees below the horizon is calculated as:
[degrees below horizon] = 90 - textRotation.

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

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.

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

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.

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 either {@link ConditionalFormattingRule#CONDITION_TYPE_CELL_VALUE_IS} or {@link ConditionalFormattingRule#CONDITION_TYPE_FORMULA}

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. @deprecated (Sep 2009) (reduce overloading) use {@link #Create(XSSFWorkbook, NPOI.ss.formula.IStabilityClassifier, NPOI.ss.formula.udf.UDFFinder)} @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) Should be called whenever there are major Changes (e.g. moving sheets) to input cells in the Evaluated workbook. Failure to call this method After changing cell values will cause incorrect behaviour of the Evaluate~ methods of this class If cell Contains a formula, the formula is Evaluated and returned, else the CellValue simply copies the appropriate cell value from the cell and also its cell type. This method should be preferred over EvaluateInCell() when the call should not modify the contents of the original cell. @param cell If cell Contains formula, it Evaluates the formula, and saves the result of the formula. The cell remains as a formula cell. Else if cell does not contain formula, this method leaves the cell unChanged. Note that the type of the formula result is returned, so you know what kind of value is also stored with the formula.

            int EvaluatedCellType = Evaluator.EvaluateFormulaCell(cell);
            

            int EvaluatedCellType = Evaluator.EvaluateInCell(cell).CellType;
            

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.

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){
                 ...
             }
             

             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
             }
             

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

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 Validate sheet index @param index the index to validate @throws ArgumentException if the index is out of range (index < 0 || index >= NumberOfSheets). 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 Sets the repeating rows and columns for a sheet.

To Set just repeating columns:

              workbook.SetRepeatingRowsAndColumns(0,0,1,-1,-1);
             

              workbook.SetRepeatingRowsAndColumns(0,-1,-1,0,4);
             

              workbook.SetRepeatingRowsAndColumns(0,-1,-1,-1,-1);
             

The default value is false, meaning that the workbook uses the 1900 date system, where 1/1/1900 is the first day in the system..

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 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.

9 Jan 2010

// TODO insert Javadoc here!

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.

8 Jan 2010

// This Interface represents an object, which is able to have a collection of paragraphs and tables this can be XWFPDocument, XWPFHeader, XWPFFooter, XWPFTableCell

                <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

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.

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.

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 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 no between border shall be applied * below identical paragraphs. *

To determine if any two adjoining paragraphs should have a left border which spans the full line height or not, the left border shall be Drawn between the top border or between border at the top (whichever would be rendered for the current paragraph), and the bottom border or between border at the bottom (whichever would be rendered for the current paragraph).

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 no left border shall be applied.

To determine if any two adjoining paragraphs should have a right border which spans the full line height or not, the right border shall be Drawn between the top border or between border at the top (whichever would be rendered for the current paragraph), and the bottom border or between border at the bottom (whichever would be rendered for the current paragraph).

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 no right border shall be applied.

To determine if any two adjoining paragraphs should have a between border or an individual top and bottom border, the Set of borders on the two adjoining paragraphs are Compared. If the border information on those two paragraphs is identical for all possible paragraphs borders, then the between border is displayed. Otherwise, each paragraph shall use its bottom and top border, respectively. If this border specifies a space attribute, that value is ignored - this border is always located at the bottom of each paragraph with an identical following paragraph, taking into account any space After the line pitch.

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 no between border shall be applied between identical paragraphs.

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 the AfterAutoSpacing attribute is also specified, then this attribute value is ignored. If this Setting is never specified in the style hierarchy, then its value shall be zero (if needed)

If the beforeLines attribute or the beforeAutoSpacing attribute is also specified, then this attribute value is ignored.

If the beforeAutoSpacing attribute is also specified, then this attribute value is ignored. If this Setting is never specified in the style hierarchy, then its value shall be zero.

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;

                <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

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. @author Yury Batrakov (batrakov at gmail.com) @author Gregg Morris (gregg dot morris at gmail dot com) - added setStyleID() getRowBandSize(), setRowBandSize() getColBandSize(), setColBandSize() getInsideHBorderType(), getInsideHBorderSize(), getInsideHBorderSpace(), getInsideHBorderColor() getInsideVBorderType(), getInsideVBorderSize(), getInsideVBorderSpace(), getInsideVBorderColor() setInsideHBorder(), setInsideVBorder() getCellMarginTop(), getCellMarginLeft(), getCellMarginBottom(), getCellMarginRight() setCellMargins() @return ctTbl object add a new column for each row in this table create a new XWPFTableRow object with as many cells as the number of columns defined in that moment @return tableRow @param pos - index of the row @return the row at the position specified or null if no rows is defined or if the position is greather than the max size of rows array add a new Row to the table @param row the row which should be Added add a new Row to the table at position pos @param row the row which should be Added inserts a new tablerow @param pos @return the inserted row Remove a row at position pos from the table @param pos position the Row in the Table returns the part of the bodyElement @see NPOI.XWPF.UserModel.IBody#getPart() returns the XWPFRow which belongs to the CTRow row if this row is not existing in the table null will be returned @return text @return width value @return number of rows in table Get the StyleID of the table @return style-ID of the table returns the type of the BodyElement Table @see NPOI.XWPF.UserModel.IBodyElement#getElementType() returns the partType of the bodyPart which owns the bodyElement @see NPOI.XWPF.UserModel.IBody#getPartType() XWPFTableCell class. @author Gregg Morris (gregg dot morris at gmail dot com) - added XWPFVertAlign enum, setColor(), setVerticalAlignment() If a table cell does not include at least one block-level element, then this document shall be considered corrupt Add a Paragraph to this Table Cell @return The paragraph which was Added add a Paragraph to this TableCell @param p the paragaph which has to be Added Removes a paragraph of this tablecell @param pos if there is a corresponding {@link XWPFParagraph} of the parameter ctTable in the paragraphList of this table the method will return this paragraph if there is no corresponding {@link XWPFParagraph} the method will return null @param p is instance of CTP and is searching for an XWPFParagraph @return null if there is no XWPFParagraph with an corresponding CTPparagraph in the paragraphList of this table XWPFParagraph with the correspondig CTP p Set cell color. This sets some associated values; for finer control you may want to access these elements individually. @param rgbStr - the desired cell color, in the hex form "RRGGBB". Get cell color. Note that this method only returns the "fill" value. @return RGB string of cell color Set the vertical alignment of the cell. @param vAlign - the desired alignment enum value Get the vertical alignment of the cell. @return the cell alignment enum value add a new paragraph at position of the cursor @param cursor @return the inserted paragraph verifies that cursor is on the right position @see NPOI.XWPF.UserModel.IBody#getParagraphArray(int) Get the to which the TableCell belongs @see NPOI.XWPF.UserModel.IBody#getPart() Get a table by its CTTbl-Object @see NPOI.XWPF.UserModel.IBody#getTable(org.Openxmlformats.schemas.wordProcessingml.x2006.main.CTTbl) @see NPOI.XWPF.UserModel.IBody#getTableArray(int) inserts an existing XWPFTable to the arrays bodyElements and tables @see NPOI.XWPF.UserModel.IBody#insertTable(int, NPOI.XWPF.UserModel.XWPFTable) Get the TableCell which belongs to the TableCell returns an Iterator with paragraphs and tables @see NPOI.XWPF.UserModel.IBody#getBodyElements() returns a list of paragraphs @see NPOI.XWPF.UserModel.IBody#getPartType() @see NPOI.XWPF.UserModel.IBody#getTables() @author gisellabronzetti @author gregg morris - added removeCell(), setCantSplitRow(), setRepeatHeader() create a new XWPFTableCell and add it to the tableCell-list of this tableRow @return the newly Created XWPFTableCell Adds a new TableCell at the end of this tableRow This element specifies the height of the current table row within the current table. This height shall be used to determine the resulting height of the table row, which may be absolute or relative (depending on its attribute values). If omitted, then the table row shall automatically resize its height to the height required by its contents (the equivalent of an hRule value of auto). @param height This element specifies the height of the current table row within the current table. This height shall be used to determine the resulting height of the table row, which may be absolute or relative (depending on its attribute values). If omitted, then the table row shall automatically resize its height to the height required by its contents (the equivalent of an hRule value of auto). @return height create and return a list of all XWPFTableCell who belongs to this row @return a list of {@link XWPFTableCell} returns the XWPFTableCell which belongs to the CTTC cell if there is no XWPFTableCell which belongs to the parameter CTTc cell null will be returned This attribute controls whether to allow table rows to split across pages. The logic for this attribute is a little unusual: a true value means DON'T allow rows to split, false means allow rows to split. @param split - if true, don't allow rows to be split. If false, allow rows to be split. Return true if the "can't split row" value is true. The logic for this attribute is a little unusual: a TRUE value means DON'T allow rows to split, FALSE means allow rows to split. @return true if rows can't be split, false otherwise. This attribute controls whether to repeat a table's header row at the top of a table split across pages. @param repeat - if TRUE, repeat header row at the top of each page of table; if FALSE, don't repeat header row. Return true if a table's header row should be repeated at the top of a table split across pages. @return true if table's header row should be repeated at the top of each page of table, false otherwise.