[]
        
(Showing Draft Content)

TableStyleElementType

Enum Class TableStyleElementType

java.lang.Object
java.lang.Enum<TableStyleElementType>
com.grapecity.documents.excel.TableStyleElementType
All Implemented Interfaces:
Serializable, Comparable<TableStyleElementType>, Constable

public enum TableStyleElementType extends Enum<TableStyleElementType>
Specifies the type of a table style element.

Use this enum to identify a specific part of a table, pivot table, slicer, or timeline style, such as the whole table, header row, total row, striped rows, or special selection states. It is typically used with ITableStyleElements.get(TableStyleElementType) to access the corresponding ITableStyleElement.


 ITableStyle tableStyle = workbook.getTableStyles().add("CustomStyle");
 ITableStyleElement headerRow = tableStyle.getTableStyleElements().get(TableStyleElementType.HeaderRow);
 headerRow.getInterior().setColor(Color.GetBlue());
 Color headerColor = headerRow.getInterior().getColor();
 
  • Enum Constant Details

    • WholeTable

      public static final TableStyleElementType WholeTable
      Specifies the whole table area.

      This element is used to define the base formatting applied to the entire table, excluding more specific regions that can be styled separately, such as the header row, total row, or striped areas.

    • HeaderRow

      public static final TableStyleElementType HeaderRow
      Specifies the style element applied to the header row of a table.
    • TotalRow

      public static final TableStyleElementType TotalRow
      Specifies the style element applied to the total row of a table.

      This element represents the row that displays summary or aggregate values at the bottom of a table and is used when defining formatting specifically for that row.

    • GrandTotalRow

      public static final TableStyleElementType GrandTotalRow
      Specifies the grand total row area in a pivot table style.

      This element is used to define the formatting applied to the row that displays grand total values across the pivot table.

    • FirstColumn

      public static final TableStyleElementType FirstColumn
      Specifies the style element for the first column of a table when first-column formatting is enabled.
    • LastColumn

      public static final TableStyleElementType LastColumn
      Specifies the style element for the last column.

      This element represents the formatting applied to the rightmost column when a table or pivot table style is configured to highlight the last column.

    • GrandTotalColumn

      public static final TableStyleElementType GrandTotalColumn
      Specifies the grand total column area in a pivot table style.

      This element is used to apply formatting to the column that displays grand total values in a pivot table.

    • FirstRowStripe

      public static final TableStyleElementType FirstRowStripe
      Specifies the first row stripe formatting element.

      This element defines the style applied to the first band in alternating row stripe patterns for a table or PivotTable style.

    • SecondRowStripe

      public static final TableStyleElementType SecondRowStripe
      Specifies the second row stripe band.
    • FirstColumnStripe

      public static final TableStyleElementType FirstColumnStripe
      Specifies the first banded column stripe element in a table or pivot table style.

      This element defines the formatting applied to the first stripe in an alternating column banding pattern when column stripes are used.

    • SecondColumnStripe

      public static final TableStyleElementType SecondColumnStripe
      Specifies the second column stripe element in a table or pivot table style.

      This element is used to define the formatting applied to the second alternating column band when banded columns are enabled.

    • FirstHeaderCell

      public static final TableStyleElementType FirstHeaderCell
      Specifies the first cell in the header area, used to apply a distinct style to the leading header cell of a table or pivot table.
    • LastHeaderCell

      public static final TableStyleElementType LastHeaderCell
      Specifies the style element for the last cell in a table header row.

      Use this value to identify or customize the formatting applied to the header cell of the last column in a table style.

    • FirstTotalCell

      public static final TableStyleElementType FirstTotalCell
      Specifies the first cell in the total row of a table style.
    • LastTotalCell

      public static final TableStyleElementType LastTotalCell
      Specifies the last cell in the total row of a table.

      This element is used to define the style applied specifically to the rightmost cell in the table's total row, allowing it to differ from the rest of the total row or from FirstTotalCell.

    • FirstSubtotalColumn

      public static final TableStyleElementType FirstSubtotalColumn
      Specifies the table style element that applies formatting to the first subtotal column in a PivotTable.
    • SecondSubtotalColumn

      public static final TableStyleElementType SecondSubtotalColumn
      Specifies the second subtotal column in a PivotTable style.

      This element identifies the style region applied to the second-level subtotal column when a PivotTable displays column subtotals.

    • ThirdSubtotalColumn

      public static final TableStyleElementType ThirdSubtotalColumn
      Specifies the third subtotal column element in a PivotTable style.

      Use this element type to define the formatting applied to the third subtotal column in a PivotTable.

    • FirstSubtotalRow

      public static final TableStyleElementType FirstSubtotalRow
      Specifies the first subtotal row in a PivotTable.
    • SecondSubtotalRow

      public static final TableStyleElementType SecondSubtotalRow
      Specifies the table style element applied to the second subtotal row in a PivotTable.
    • ThirdSubtotalRow

      public static final TableStyleElementType ThirdSubtotalRow
      Specifies the style element for the third subtotal row in a pivot table.
    • BlankRow

      public static final TableStyleElementType BlankRow
      Specifies the style element for a blank row inserted in a PivotTable layout.
    • FirstColumnSubheading

      public static final TableStyleElementType FirstColumnSubheading
      Specifies the style element for the first column subheading level in a PivotTable.
    • SecondColumnSubheading

      public static final TableStyleElementType SecondColumnSubheading
      Specifies the second column subheading in a PivotTable style.
    • ThirdColumnSubheading

      public static final TableStyleElementType ThirdColumnSubheading
      Specifies the third column subheading in a PivotTable.
    • FirstRowSubheading

      public static final TableStyleElementType FirstRowSubheading
      Specifies the style element applied to the first row subheading area in a PivotTable.
    • SecondRowSubheading

      public static final TableStyleElementType SecondRowSubheading
      Specifies the style element applied to the second row subheading area in a PivotTable.
    • ThirdRowSubheading

      public static final TableStyleElementType ThirdRowSubheading
      Specifies the style element for the third row subheading in a PivotTable.
    • PageFieldLabels

      public static final TableStyleElementType PageFieldLabels
      Specifies the table style element that is applied to page field labels in a pivot table.
    • PageFieldValues

      public static final TableStyleElementType PageFieldValues
      Specifies the values area of page fields in a PivotTable.

      This style element applies to the cells that display the current page field values, rather than the page field labels.

    • UnselectedItemWithData

      public static final TableStyleElementType UnselectedItemWithData
      Specifies a slicer item that contains data and is not selected.
    • UnselectedItemWithNoData

      public static final TableStyleElementType UnselectedItemWithNoData
      Specifies the style element for a slicer item that is not selected and does not contain data.

      Use this value to define the appearance of unavailable slicer items in their normal, unselected state.

    • SelectedItemWithData

      public static final TableStyleElementType SelectedItemWithData
      Specifies the style element for a selected slicer item that contains data.
    • SelectedItemWithNoData

      public static final TableStyleElementType SelectedItemWithNoData
      Specifies a selected slicer item that does not contain data.
    • HoveredUnselectedItemWithData

      public static final TableStyleElementType HoveredUnselectedItemWithData
      Specifies a slicer item that contains data and is currently hovered over by the user but not selected.
    • HoveredSelectedItemWithData

      public static final TableStyleElementType HoveredSelectedItemWithData
      Specifies a selected item, hovered over by the user, that contains data.
    • HoveredUnselectedItemWithNoData

      public static final TableStyleElementType HoveredUnselectedItemWithNoData
      Specifies an item, hovered over by the user, that is not selected and that does not contain data.
    • HoveredSelectedItemWithNoData

      public static final TableStyleElementType HoveredSelectedItemWithNoData
      Specifies a selected item that does not contain data and is currently being hovered over by the user.
    • TimelineSelectionLabel

      public static final TableStyleElementType TimelineSelectionLabel
      Specifies timeline selection label.
    • TimelineTimeLevel

      public static final TableStyleElementType TimelineTimeLevel
      Specifies timeline level.
    • TimelinePeriodLabels1

      public static final TableStyleElementType TimelinePeriodLabels1
      Specifies timeline period label.
    • TimelinePeriodLabels2

      public static final TableStyleElementType TimelinePeriodLabels2
      Specifies additional timeline period label.
    • TimelineSelectedTimeBlock

      public static final TableStyleElementType TimelineSelectedTimeBlock
      Specifies selected timeline time block.
    • TimelineUnselectedTimeBlock

      public static final TableStyleElementType TimelineUnselectedTimeBlock
      Specifies unselected timeline time block.
    • TimelineSelectedTimeBlockSpace

      public static final TableStyleElementType TimelineSelectedTimeBlockSpace
      Specifies selected timeline time block space.
  • Method Details

    • values

      public static TableStyleElementType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static TableStyleElementType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • getValue

      public int getValue()
    • forValue

      public static TableStyleElementType forValue(int value)