com.aspose.words
Class CellFormat

java.lang.Object
    extended by com.aspose.words.CellFormat

public class CellFormat 
extends java.lang.Object

Represents all formatting for a table cell.

Property Getters/Setters Summary
BorderCollectiongetBorders()
           Gets collection of borders of the cell.
doublegetBottomPadding()
voidsetBottomPadding(double value)
           Returns or sets the amount of space (in points) to add below the contents of cell.
booleangetFitText()
voidsetFitText(boolean value)
           If true, fits text in the cell, compressing each paragraph to the width of the cell.
intgetHorizontalMerge()
voidsetHorizontalMerge(int value)
           Specifies how the cell is merged horizontally with other cells in the row. The value of the property is CellMerge integer constant.
doublegetLeftPadding()
voidsetLeftPadding(double value)
           Returns or sets the amount of space (in points) to add to the left of the contents of cell.
intgetOrientation()
voidsetOrientation(int value)
           Returns or sets the orientation of text in a table cell. The value of the property is TextOrientation integer constant.
doublegetRightPadding()
voidsetRightPadding(double value)
           Returns or sets the amount of space (in points) to add to the right of the contents of cell.
ShadinggetShading()
           Returns a Shading object that refers to the shading formatting for the cell.
doublegetTopPadding()
voidsetTopPadding(double value)
           Returns or sets the amount of space (in points) to add above the contents of cell.
intgetVerticalAlignment()
voidsetVerticalAlignment(int value)
           Returns or sets the vertical alignment of text in the cell. The value of the property is CellVerticalAlignment integer constant.
intgetVerticalMerge()
voidsetVerticalMerge(int value)
           Specifies how the cell is merged with other cells vertically. The value of the property is CellMerge integer constant.
doublegetWidth()
voidsetWidth(double value)
           Returns or sets the width of the cell in points.
booleangetWrapText()
voidsetWrapText(boolean value)
           If true, wrap text for the cell.
 
Method Summary
voidclearFormatting()
           Resets to default cell formatting. Does not change the width of the cell.
java.lang.ObjectfetchInheritedBorderAttr(int key)
          Reserved for internal use.
java.lang.ObjectfetchInheritedShadingAttr(int key)
          Reserved for internal use.
java.lang.ObjectgetDirectBorderAttr(int key)
          Reserved for internal use.
voidsetBorderAttr(int key, java.lang.Object value)
          Reserved for internal use.
 

Property Getters/Setters Detail

getLeftPadding/setLeftPadding

public double getLeftPadding() / public void setLeftPadding(double value)
Returns or sets the amount of space (in points) to add to the left of the contents of cell.

getRightPadding/setRightPadding

public double getRightPadding() / public void setRightPadding(double value)
Returns or sets the amount of space (in points) to add to the right of the contents of cell.

getTopPadding/setTopPadding

public double getTopPadding() / public void setTopPadding(double value)
Returns or sets the amount of space (in points) to add above the contents of cell.

getBottomPadding/setBottomPadding

public double getBottomPadding() / public void setBottomPadding(double value)
Returns or sets the amount of space (in points) to add below the contents of cell.

getBorders

public BorderCollection getBorders()
Gets collection of borders of the cell.

getShading

public Shading getShading()
Returns a Shading object that refers to the shading formatting for the cell.

getVerticalAlignment/setVerticalAlignment

public int getVerticalAlignment() / public void setVerticalAlignment(int value)
Returns or sets the vertical alignment of text in the cell. The value of the property is CellVerticalAlignment integer constant.

getWidth/setWidth

public double getWidth() / public void setWidth(double value)
Returns or sets the width of the cell in points.

getVerticalMerge/setVerticalMerge

public int getVerticalMerge() / public void setVerticalMerge(int value)
Specifies how the cell is merged with other cells vertically. The value of the property is CellMerge integer constant.

Cells can only be merged vertically if their left and right boundaries are identical.

When cells are vertically merged, the display areas of the merged cells are consolidated. The consolidated area is used to display the contents of the first vertically merged cell and all other vertically merged cells must be empty.

Example:

Creates a table with two columns with cells merged vertically in the first column.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

builder.insertCell();
builder.getCellFormat().setVerticalMerge(CellMerge.FIRST);
builder.write("Text in the merged cells.");

builder.insertCell();
builder.getCellFormat().setVerticalMerge(CellMerge.NONE);
builder.write("Text in one cell");
builder.endRow();

builder.insertCell();
// This cell is vertically merged to the cell above and should be empty.
builder.getCellFormat().setVerticalMerge(CellMerge.PREVIOUS);

builder.insertCell();
builder.getCellFormat().setVerticalMerge(CellMerge.NONE);
builder.write("Text in another cell");
builder.endRow();
See Also:
HorizontalMerge

getHorizontalMerge/setHorizontalMerge

public int getHorizontalMerge() / public void setHorizontalMerge(int value)
Specifies how the cell is merged horizontally with other cells in the row. The value of the property is CellMerge integer constant.

Example:

Creates a table with two rows with cells in the first row horizontally merged.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

builder.insertCell();
builder.getCellFormat().setHorizontalMerge(CellMerge.FIRST);
builder.write("Text in the merged cells.");

builder.insertCell();
// This cell is merged to the previous and should be empty.
builder.getCellFormat().setHorizontalMerge(CellMerge.PREVIOUS);
builder.endRow();

builder.insertCell();
builder.getCellFormat().setHorizontalMerge(CellMerge.NONE);
builder.write("Text in one cell.");

builder.insertCell();
builder.write("Text in another cell.");
builder.endRow();
See Also:
VerticalMerge

getOrientation/setOrientation

public int getOrientation() / public void setOrientation(int value)
Returns or sets the orientation of text in a table cell. The value of the property is TextOrientation integer constant.

getFitText/setFitText

public boolean getFitText() / public void setFitText(boolean value)
If true, fits text in the cell, compressing each paragraph to the width of the cell.

getWrapText/setWrapText

public boolean getWrapText() / public void setWrapText(boolean value)
If true, wrap text for the cell.

Method Detail

clearFormatting

public void clearFormatting()
Resets to default cell formatting. Does not change the width of the cell.

getDirectBorderAttr

public java.lang.Object getDirectBorderAttr(int key)
Reserved for internal use.

fetchInheritedBorderAttr

public java.lang.Object fetchInheritedBorderAttr(int key)
                               throws java.lang.Exception
Reserved for internal use.

setBorderAttr

public void setBorderAttr(int key, java.lang.Object value)
Reserved for internal use.

fetchInheritedShadingAttr

public java.lang.Object fetchInheritedShadingAttr(int key)
                                throws java.lang.Exception
Reserved for internal use.

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.