Aspose::Cells::Pivot::PivotConditionalFormat class
Contents
[
Hide
]PivotConditionalFormat class
Represents a PivotTable Format Condition in PivotFormatCondition Collection.
class PivotConditionalFormat
Methods
| Method | Description |
|---|---|
| AddCellArea(const CellArea& ca) | Adds an area based on pivot table view. |
| AddFieldArea(PivotFieldType axisType, const U16String& fieldName) | Adds an area of pivot field. |
| AddFieldArea(PivotFieldType axisType, const char16_t* fieldName) | Adds an area of pivot field. |
| AddFieldArea(PivotFieldType axisType, const PivotField& field) | Adds an area of pivot field. |
| ApplyTo(int32_t row, int32_t column, PivotConditionFormatScopeType scope) | Applies the conditional format to range. Only for the data region. |
| GetCellAreas() | Gets all cell areas where this conditional format applies to. |
| GetFormatConditions() | Get conditions for the pivot table conditional format . |
| GetPivotAreas() | Gets all pivot areas. |
| GetRuleType() | Get and set rule type for the pivot table condition format . |
| GetScopeType() | Get and set scope type for the pivot table conditional format . |
| IsNull() const | Checks whether the implementation object is nullptr. |
| explicit operator bool() const | operator bool() |
| operator=(const PivotConditionalFormat& src) | operator= |
| PivotConditionalFormat(PivotConditionalFormat_Impl* impl) | Constructs from an implementation object. |
| PivotConditionalFormat(const PivotConditionalFormat& src) | Copy constructor. |
| SetRuleType(PivotConditionFormatRuleType value) | Get and set rule type for the pivot table condition format . |
| SetScopeType(PivotConditionFormatScopeType value) | Get and set scope type for the pivot table conditional format . |
| ~PivotConditionalFormat() | Destructor. |
Fields
| Field | Description |
|---|---|
| _impl | The implementation object. |
Examples
Aspose::Cells::Startup();
Workbook book;
Worksheet sheet = book.GetWorksheets().Get(0);
Cells cells = sheet.GetCells();
cells.Get(0, 0).PutValue(u"fruit");
cells.Get(1, 0).PutValue(u"grape");
cells.Get(2, 0).PutValue(u"blueberry");
cells.Get(3, 0).PutValue(u"kiwi");
cells.Get(4, 0).PutValue(u"cherry");
cells.Get(5, 0).PutValue(u"grape");
cells.Get(6, 0).PutValue(u"blueberry");
cells.Get(7, 0).PutValue(u"kiwi");
cells.Get(8, 0).PutValue(u"cherry");
cells.Get(0, 1).PutValue(u"year");
cells.Get(1, 1).PutValue(2020);
cells.Get(2, 1).PutValue(2020);
cells.Get(3, 1).PutValue(2020);
cells.Get(4, 1).PutValue(2020);
cells.Get(5, 1).PutValue(2021);
cells.Get(6, 1).PutValue(2021);
cells.Get(7, 1).PutValue(2021);
cells.Get(8, 1).PutValue(2021);
cells.Get(0, 2).PutValue(u"amount");
cells.Get(1, 2).PutValue(50);
cells.Get(2, 2).PutValue(60);
cells.Get(3, 2).PutValue(70);
cells.Get(4, 2).PutValue(80);
cells.Get(5, 2).PutValue(90);
cells.Get(6, 2).PutValue(100);
cells.Get(7, 2).PutValue(110);
cells.Get(8, 2).PutValue(120);
PivotTableCollection pivots = sheet.GetPivotTables();
int pivotIndex = pivots.Add(u"=Sheet1!A1:C9", u"A12", u"TestPivotTable");
PivotTable pivot = pivots.Get(pivotIndex);
pivot.AddFieldToArea(PivotFieldType::Row, u"fruit");
pivot.AddFieldToArea(PivotFieldType::Column, u"year");
pivot.AddFieldToArea(PivotFieldType::Data, u"amount");
pivot.SetPivotTableStyleType(PivotTableStyleType::PivotTableStyleMedium10);
//Add PivotFormatCondition
int formatIndex = pivot.GetConditionalFormats().Add();
PivotConditionalFormat pfc = pivot.GetConditionalFormats().Get(formatIndex);
pfc.AddFieldArea(PivotFieldType::Data, pivot.GetDataFields().Get(0));
int idx = pfc.GetFormatConditions().AddCondition(FormatConditionType::CellValue);
FormatCondition fc = pfc.GetFormatConditions().Get(idx);
fc.SetFormula1(u"100");
fc.SetOperator(OperatorType::GreaterOrEqual);
fc.GetStyle().SetBackgroundColor(Color::Red());
pivot.RefreshData();
pivot.CalculateData();
book.Save("out.xlsx");
Aspose::Cells::Cleanup();
See Also
- Namespace Aspose::Cells::Pivot
- Library Aspose.Cells for C++