Aspose::Words::Tables::CellFormat class
Contents
[
Hide
]CellFormat class
Represents all formatting for a table cell. To learn more, visit the Working with Tables documentation article.
class CellFormat : public Aspose::Words::IBorderAttrSource,
public Aspose::Words::IShadingAttrSource
Methods
Method | Description |
---|---|
ClearFormatting() | Resets to default cell formatting. Does not change the width of the cell. |
get_Borders() | Gets collection of borders of the cell. |
get_BottomPadding() | Returns or sets the amount of space (in points) to add below the contents of cell. |
get_FitText() | If true, fits text in the cell, compressing each paragraph to the width of the cell. |
get_HideMark() | Returns visibility of cell mark. |
get_HorizontalMerge() | Specifies how the cell is merged horizontally with other cells in the row. |
get_LeftPadding() | Returns or sets the amount of space (in points) to add to the left of the contents of cell. |
get_Orientation() | Returns or sets the orientation of text in a table cell. |
get_PreferredWidth() | Returns or sets the preferred width of the cell. |
get_RightPadding() | Returns or sets the amount of space (in points) to add to the right of the contents of cell. |
get_Shading() | Returns a Shading object that refers to the shading formatting for the cell. |
get_TopPadding() | Returns or sets the amount of space (in points) to add above the contents of cell. |
get_VerticalAlignment() | Returns or sets the vertical alignment of text in the cell. |
get_VerticalMerge() | Specifies how the cell is merged with other cells vertically. |
get_Width() | Gets the width of the cell in points. |
get_WrapText() | If true, wrap text for the cell. |
GetType() const override | |
Is(const System::TypeInfo&) const override | |
set_BottomPadding(double) | Setter for Aspose::Words::Tables::CellFormat::get_BottomPadding. |
set_FitText(bool) | Setter for Aspose::Words::Tables::CellFormat::get_FitText. |
set_HideMark(bool) | Sets visibility of cell mark. |
set_HorizontalMerge(Aspose::Words::Tables::CellMerge) | Setter for Aspose::Words::Tables::CellFormat::get_HorizontalMerge. |
set_LeftPadding(double) | Setter for Aspose::Words::Tables::CellFormat::get_LeftPadding. |
set_Orientation(Aspose::Words::TextOrientation) | Setter for Aspose::Words::Tables::CellFormat::get_Orientation. |
set_PreferredWidth(const System::SharedPtr<Aspose::Words::Tables::PreferredWidth>&) | Setter for Aspose::Words::Tables::CellFormat::get_PreferredWidth. |
set_RightPadding(double) | Setter for Aspose::Words::Tables::CellFormat::get_RightPadding. |
set_TopPadding(double) | Setter for Aspose::Words::Tables::CellFormat::get_TopPadding. |
set_VerticalAlignment(Aspose::Words::Tables::CellVerticalAlignment) | Setter for Aspose::Words::Tables::CellFormat::get_VerticalAlignment. |
set_VerticalMerge(Aspose::Words::Tables::CellMerge) | Setter for Aspose::Words::Tables::CellFormat::get_VerticalMerge. |
set_Width(double) | Setter for Aspose::Words::Tables::CellFormat::get_Width. |
set_WrapText(bool) | Setter for Aspose::Words::Tables::CellFormat::get_WrapText. |
SetPaddings(double, double, double, double) | Sets the amount of space (in points) to add to the left/top/right/bottom of the contents of cell. |
static Type() |
Examples
Shows how to build a table with custom borders.
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
builder->StartTable();
// Setting table formatting options for a document builder
// will apply them to every row and cell that we add with it.
builder->get_ParagraphFormat()->set_Alignment(ParagraphAlignment::Center);
builder->get_CellFormat()->ClearFormatting();
builder->get_CellFormat()->set_Width(150);
builder->get_CellFormat()->set_VerticalAlignment(CellVerticalAlignment::Center);
builder->get_CellFormat()->get_Shading()->set_BackgroundPatternColor(System::Drawing::Color::get_GreenYellow());
builder->get_CellFormat()->set_WrapText(false);
builder->get_CellFormat()->set_FitText(true);
builder->get_RowFormat()->ClearFormatting();
builder->get_RowFormat()->set_HeightRule(HeightRule::Exactly);
builder->get_RowFormat()->set_Height(50);
builder->get_RowFormat()->get_Borders()->set_LineStyle(LineStyle::Engrave3D);
builder->get_RowFormat()->get_Borders()->set_Color(System::Drawing::Color::get_Orange());
builder->InsertCell();
builder->Write(u"Row 1, Col 1");
builder->InsertCell();
builder->Write(u"Row 1, Col 2");
builder->EndRow();
// Changing the formatting will apply it to the current cell,
// and any new cells that we create with the builder afterward.
// This will not affect the cells that we have added previously.
builder->get_CellFormat()->get_Shading()->ClearFormatting();
builder->InsertCell();
builder->Write(u"Row 2, Col 1");
builder->InsertCell();
builder->Write(u"Row 2, Col 2");
builder->EndRow();
// Increase row height to fit the vertical text.
builder->InsertCell();
builder->get_RowFormat()->set_Height(150);
builder->get_CellFormat()->set_Orientation(TextOrientation::Upward);
builder->Write(u"Row 3, Col 1");
builder->InsertCell();
builder->get_CellFormat()->set_Orientation(TextOrientation::Downward);
builder->Write(u"Row 3, Col 2");
builder->EndRow();
builder->EndTable();
doc->Save(ArtifactsDir + u"DocumentBuilder.InsertTable.docx");
Shows how to modify the format of rows and cells in a table.
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
SharedPtr<Table> table = builder->StartTable();
builder->InsertCell();
builder->Write(u"City");
builder->InsertCell();
builder->Write(u"Country");
builder->EndRow();
builder->InsertCell();
builder->Write(u"London");
builder->InsertCell();
builder->Write(u"U.K.");
builder->EndTable();
// Use the first row's "RowFormat" property to modify the formatting
// of the contents of all cells in this row.
SharedPtr<RowFormat> rowFormat = table->get_FirstRow()->get_RowFormat();
rowFormat->set_Height(25);
rowFormat->get_Borders()->idx_get(BorderType::Bottom)->set_Color(System::Drawing::Color::get_Red());
// Use the "CellFormat" property of the first cell in the last row to modify the formatting of that cell's contents.
SharedPtr<CellFormat> cellFormat = table->get_LastRow()->get_FirstCell()->get_CellFormat();
cellFormat->set_Width(100);
cellFormat->get_Shading()->set_BackgroundPatternColor(System::Drawing::Color::get_Orange());
doc->Save(ArtifactsDir + u"Table.RowCellFormat.docx");
Shows how to modify formatting of a table cell.
auto doc = MakeObject<Document>(MyDir + u"Tables.docx");
SharedPtr<Table> table = doc->get_FirstSection()->get_Body()->get_Tables()->idx_get(0);
SharedPtr<Cell> firstCell = table->get_FirstRow()->get_FirstCell();
// Use a cell's "CellFormat" property to set formatting that modifies the appearance of that cell.
firstCell->get_CellFormat()->set_Width(30);
firstCell->get_CellFormat()->set_Orientation(TextOrientation::Downward);
firstCell->get_CellFormat()->get_Shading()->set_ForegroundPatternColor(System::Drawing::Color::get_LightGreen());
doc->Save(ArtifactsDir + u"Table.CellFormat.docx");
See Also
- Namespace Aspose::Words::Tables
- Library Aspose.Words for C++