PivotCellFormatWrapper Class

Represents the pivot cell format wrapper

Inheritance
System.Object
PivotCellFormatWrapper
Implements
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Syncfusion.XlsIO.Implementation
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
public class PivotCellFormatWrapper : IInternalPivotCellFormat, IPivotCellFormat

Properties

BackColor

Gets or sets the pattern background color from predefined colors (ExcelKnownColors).

Declaration
public ExcelKnownColors BackColor { get; set; }
Property Value
Type
ExcelKnownColors

BackColorObject

Gets pivot cell format back color object. Read-only.

Declaration
public ColorObject BackColorObject { get; }
Property Value
Type
ColorObject

BackColorRGB

Gets or sets the pattern background color (System.Drawing.Color).

Declaration
public Color BackColorRGB { get; set; }
Property Value
Type
System.Drawing.Color

Bold

True if the bold is present font otherwise, False.

Declaration
public bool Bold { get; set; }
Property Value
Type
System.Boolean

BottomBorderColor

Gets or sets the bottom border color from predefined colors (ExcelKnownColors).

Declaration
public ExcelKnownColors BottomBorderColor { get; set; }
Property Value
Type
ExcelKnownColors

BottomBorderColorObject

Gets pivot cell format bottom border color object. Read-only.

Declaration
public ColorObject BottomBorderColorObject { get; }
Property Value
Type
ColorObject

BottomBorderColorRGB

Gets or sets the bottom color (System.Drawing.Color).

Declaration
public Color BottomBorderColorRGB { get; set; }
Property Value
Type
System.Drawing.Color

BottomBorderStyle

Gets or sets the bottom border line style.

Declaration
public ExcelLineStyle BottomBorderStyle { get; set; }
Property Value
Type
ExcelLineStyle

ColorObject

Gets pivot cell format color object. Read-only.

Declaration
public ColorObject ColorObject { get; }
Property Value
Type
ColorObject

DiagonalBorderColor

Gets or sets the diagonal border color from predefined colors (ExcelKnownColors).

Declaration
public ExcelKnownColors DiagonalBorderColor { get; set; }
Property Value
Type
ExcelKnownColors

DiagonalBorderColorObject

Get/set DiagonalUpBorder color.

Declaration
public ColorObject DiagonalBorderColorObject { get; }
Property Value
Type
ColorObject

DiagonalBorderColorRGB

Gets or sets the diagonal border color (System.Drawing.Color).

Declaration
public Color DiagonalBorderColorRGB { get; set; }
Property Value
Type
System.Drawing.Color

DiagonalBorderStyle

Gets / sets line style of the diagonal border.

Declaration
public ExcelLineStyle DiagonalBorderStyle { get; set; }
Property Value
Type
ExcelLineStyle

FontColor

Gets or sets the font color from predefined colors (ExcelKnownColors).

Declaration
public ExcelKnownColors FontColor { get; set; }
Property Value
Type
ExcelKnownColors

FontColorObject

Gets pivot cell format font color object. Read-only.

Declaration
public ColorObject FontColorObject { get; }
Property Value
Type
ColorObject

FontColorRGB

Gets or sets the pattern background color (System.Drawing.Color).

Declaration
public Color FontColorRGB { get; set; }
Property Value
Type
System.Drawing.Color

FontName

Represent the font Name.

Declaration
public string FontName { get; set; }
Property Value
Type
System.String

FontSize

Represent the font size.

Declaration
public double FontSize { get; set; }
Property Value
Type
System.Double

FormulaHidden

Indicates whether formula is hidden.

Declaration
public bool FormulaHidden { get; set; }
Property Value
Type
System.Boolean

HorizontalAlignment

Horizontal alignment.

Declaration
public ExcelHAlign HorizontalAlignment { get; set; }
Property Value
Type
ExcelHAlign

HorizontalBorderColor

Gets and sets the horizontal border color.

Declaration
public ExcelKnownColors HorizontalBorderColor { get; set; }
Property Value
Type
ExcelKnownColors

HorizontalBorderColorObject

Gets pivot cell format horizontal border color object. Read-only.

Declaration
public ColorObject HorizontalBorderColorObject { get; }
Property Value
Type
ColorObject

HorizontalBorderColorRGB

Gets or sets the Horizontal border color (System.Drawing.Color).

Declaration
public Color HorizontalBorderColorRGB { get; set; }
Property Value
Type
System.Drawing.Color

HorizontalBorderStyle

Gets and sets the Horizontal border line style.

Declaration
public ExcelLineStyle HorizontalBorderStyle { get; set; }
Property Value
Type
ExcelLineStyle

IncludeAlignment

Declaration
public bool IncludeAlignment { get; set; }
Property Value
Type
System.Boolean

IncludeProtection

Flag for cell protection (cell locked and formula hidden).

Declaration
public bool IncludeProtection { get; set; }
Property Value
Type
System.Boolean

IndentLevel

Indent level.

Declaration
public int IndentLevel { get; set; }
Property Value
Type
System.Int32

IsBackgroundColorPresent

True if background color is present. otherwise, False.

Declaration
public bool IsBackgroundColorPresent { get; set; }
Property Value
Type
System.Boolean

IsBorderFormatPresent

True if the pivot cell format contains border formatting. otherwise, False.

Declaration
public bool IsBorderFormatPresent { get; set; }
Property Value
Type
System.Boolean

IsBottomBorderModified

True if bottom border line style and color is modified. otherwise, False.

Declaration
public bool IsBottomBorderModified { get; set; }
Property Value
Type
System.Boolean

IsDiagonalBorderModified

True if diagonal border line style and color is modified. otherwise, False.

Declaration
public bool IsDiagonalBorderModified { get; set; }
Property Value
Type
System.Boolean

IsFontColorPresent

True if the pivot cell format contains font color present. otherwise, Flase.

Declaration
public bool IsFontColorPresent { get; set; }
Property Value
Type
System.Boolean

IsFontFormatPresent

True if the pivot cell format contains font formatting. otherwise, False.

Declaration
public bool IsFontFormatPresent { get; set; }
Property Value
Type
System.Boolean

IsHorizontalBorderModified

True if Horizontal border line style and color is modified. otherwise, False.

Declaration
public bool IsHorizontalBorderModified { get; set; }
Property Value
Type
System.Boolean

IsLeftBorderModified

True if left border line style and color is modified. otherwise, False.

Declaration
public bool IsLeftBorderModified { get; set; }
Property Value
Type
System.Boolean

IsNumberFormatPresent

True if Number format is present. False otherwise.

Declaration
public bool IsNumberFormatPresent { get; set; }
Property Value
Type
System.Boolean

IsPatternColorModified

True if the pivot cell format contains pattern formatting. otherwise, False.

Declaration
public bool IsPatternColorModified { get; set; }
Property Value
Type
System.Boolean

IsPatternFormatPresent

True if the pivot cell format contains pattern format present. otherwise, Flase.

Declaration
public bool IsPatternFormatPresent { get; set; }
Property Value
Type
System.Boolean

IsRightBorderModified

True if right border line style and color is modified. otherwise, False.

Declaration
public bool IsRightBorderModified { get; set; }
Property Value
Type
System.Boolean

IsTopBorderModified

True if top border line style and color is modified. otherwise, False.

Declaration
public bool IsTopBorderModified { get; set; }
Property Value
Type
System.Boolean

IsVerticalBorderModified

True if bottom border line style and color is modified. otherwise, False.

Declaration
public bool IsVerticalBorderModified { get; set; }
Property Value
Type
System.Boolean

Italic

True if the italic is present font otherwise, False.

Declaration
public bool Italic { get; set; }
Property Value
Type
System.Boolean

LeftBorderColor

Gets or sets the left border color from predefined colors (ExcelKnownColors).

Declaration
public ExcelKnownColors LeftBorderColor { get; set; }
Property Value
Type
ExcelKnownColors

LeftBorderColorObject

Gets table style eleement left border color object. Read-only.

Declaration
public ColorObject LeftBorderColorObject { get; }
Property Value
Type
ColorObject

LeftBorderColorRGB

Gets or sets the left border color (System.Drawing.Color).

Declaration
public Color LeftBorderColorRGB { get; set; }
Property Value
Type
System.Drawing.Color

LeftBorderStyle

Gets or sets the left border line style.

Declaration
public ExcelLineStyle LeftBorderStyle { get; set; }
Property Value
Type
ExcelLineStyle

Locked

Indicates whether cell with this XF is locked.

Declaration
public bool Locked { get; set; }
Property Value
Type
System.Boolean

NumberFormat

Gets or sets number format of the conditional format rule.

Declaration
public string NumberFormat { get; set; }
Property Value
Type
System.String

NumberFormatIndex

Gets or sets number format index of the conditional format rule.

Declaration
public ushort NumberFormatIndex { get; set; }
Property Value
Type
System.UInt16

PatternColor

Gets or sets the pattern background color from predefined colors (ExcelKnownColors).

Declaration
public ExcelKnownColors PatternColor { get; set; }
Property Value
Type
ExcelKnownColors

PatternColorRGB

Gets or sets the color (System.Drawing.Color).

Declaration
public Color PatternColorRGB { get; set; }
Property Value
Type
System.Drawing.Color

PatternStyle

Gets or sets the fill pattern style.

Declaration
public ExcelPattern PatternStyle { get; set; }
Property Value
Type
ExcelPattern

ReadingOrder

Text direction, the reading order for far east versions.

Declaration
public ExcelReadingOrderType ReadingOrder { get; set; }
Property Value
Type
ExcelReadingOrderType

RightBorderColor

Gets or sets the top right color from predefined colors (ExcelKnownColors).

Declaration
public ExcelKnownColors RightBorderColor { get; set; }
Property Value
Type
ExcelKnownColors

RightBorderColorObject

Gets pivot cell format right border color object. Read-only.

Declaration
public ColorObject RightBorderColorObject { get; }
Property Value
Type
ColorObject

RightBorderColorRGB

Gets or sets the right border color (System.Drawing.Color).

Declaration
public Color RightBorderColorRGB { get; set; }
Property Value
Type
System.Drawing.Color

RightBorderStyle

Gets or sets the right border line style.

Declaration
public ExcelLineStyle RightBorderStyle { get; set; }
Property Value
Type
ExcelLineStyle

Rotation

Text rotation angle: 0 Not rotated 1-90 1 to 90 degrees counterclockwise 91-180 1 to 90 degrees clockwise 255 Letters are stacked top-to-bottom, but not rotated.

Declaration
public int Rotation { get; set; }
Property Value
Type
System.Int32
Exceptions
Type Condition
System.ArgumentOutOfRangeException

Thrown when value is more than 0xFF.

ShrinkToFit

True- Indicates that the contents are shrunk to fit into cell.

Declaration
public bool ShrinkToFit { get; set; }
Property Value
Type
System.Boolean

StrikeThrough

True if the strike through is present font otherwise, False.

Declaration
public bool StrikeThrough { get; set; }
Property Value
Type
System.Boolean

TopBorderColor

Gets or sets the top border color from predefined colors (ExcelKnownColors).

Declaration
public ExcelKnownColors TopBorderColor { get; set; }
Property Value
Type
ExcelKnownColors

TopBorderColorObject

Gets pivot cell format top border color object. Read-only.

Declaration
public ColorObject TopBorderColorObject { get; }
Property Value
Type
ColorObject

TopBorderColorRGB

Gets or sets the top border color (System.Drawing.Color).

Declaration
public Color TopBorderColorRGB { get; set; }
Property Value
Type
System.Drawing.Color

TopBorderStyle

Gets and sets the top border line style.

Declaration
public ExcelLineStyle TopBorderStyle { get; set; }
Property Value
Type
ExcelLineStyle

Underline

Gets or sets the underline type for the conditional format.

Declaration
public ExcelUnderline Underline { get; set; }
Property Value
Type
ExcelUnderline

VerticalAlignment

Vertical alignment.

Declaration
public ExcelVAlign VerticalAlignment { get; set; }
Property Value
Type
ExcelVAlign

VerticalBorderColor

Gets and sets the vertical border color.

Declaration
public ExcelKnownColors VerticalBorderColor { get; set; }
Property Value
Type
ExcelKnownColors

VerticalBorderColorObject

Gets pivot cell format vertical border color object. Read-only.

Declaration
public ColorObject VerticalBorderColorObject { get; }
Property Value
Type
ColorObject

VerticalBorderColorRGB

Gets or sets the vertical border color (System.Drawing.Color).

Declaration
public Color VerticalBorderColorRGB { get; set; }
Property Value
Type
System.Drawing.Color

VerticalBorderStyle

Gets and sets the vertical border line style.

Declaration
public ExcelLineStyle VerticalBorderStyle { get; set; }
Property Value
Type
ExcelLineStyle

WrapText

True - Indicates that text is wrapped at right border.

Declaration
public bool WrapText { get; set; }
Property Value
Type
System.Boolean

Methods

Clear()

Represent this method remove the pivot cell format in pivot cell format list.

Declaration
public void Clear()

Equals(Object)

Equals the pivot cell format object.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj

pivot cell format object
Returns
Type Description
System.Boolean

True, If two pivot cell format is equal, Otherwise false.
Overrides
System.Object.Equals(System.Object)

Implements