LibXL C++ API reference version 5.2.0
- Index Book Sheet Format Font AutoFilter FilterColumn RichString FormControl ConditionalFormatting ConditionalFormat CoreProperties Table ### ConditionalFormat class reference Font* font() Returns the pointer to the current used font for this conditional format. NumFormat numFormat() const Returns the number format identifier. void setNumFormat(NumFormat numFormat) Sets the number format identifier. The identifier must be a valid built-in number format identifier:
  Constant | Description | Example
  NUMFORMAT_GENERAL | general format |
  NUMFORMAT_NUMBER | general number | 1000
  NUMFORMAT_NUMBER_D2 | number with decimal point | 1000.00
  NUMFORMAT_NUMBER_SEP | number with thousands separator | 100,000
  NUMFORMAT_NUMBER_SEP_D2 | number with decimal point and thousands separator | 100,000.00
  NUMFORMAT_CURRENCY_NEGBRA | monetary value, negative in brackets | (1000$)
  NUMFORMAT_CURRENCY_NEGBRARED | monetary value, negative is red in brackets | (1000$)
  NUMFORMAT_CURRENCY_D2_NEGBRA | monetary value with decimal point, negative in brackets | ($1000.00)
  NUMFORMAT_CURRENCY_D2_NEGBRARED | monetary value with decimal point, negative is red in brackets | ($1000.00)
  NUMFORMAT_PERCENT | percent value, multiply the cell value by 100 | 75%
  NUMFORMAT_PERCENT_D2 | percent value with decimal point, multiply the cell value by 100 | 75.00%
  NUMFORMAT_SCIENTIFIC_D2 | scientific value with E character and decimal point | 10.00E+1
  NUMFORMAT_FRACTION_ONEDIG | fraction value, one digit | 10 1/2
  NUMFORMAT_FRACTION_TWODIG | fraction value, two digits | 10 23/95
  NUMFORMAT_DATE | date value, depends on OS settings | 3/11/2009
  NUMFORMAT_CUSTOM_D_MON_YY | custom date value | 11-Mar-09
  NUMFORMAT_CUSTOM_D_MON | custom date value | 11-Mar
  NUMFORMAT_CUSTOM_MON_YY | custom date value | Mar-09
  NUMFORMAT_CUSTOM_HMM_AM | custom date value | 8:30 AM
  NUMFORMAT_CUSTOM_HMMSS_AM | custom date value | 8:30:00 AM
  NUMFORMAT_CUSTOM_HMM | custom date value | 8:30
  NUMFORMAT_CUSTOM_HMMSS | custom date value | 8:30:00
  NUMFORMAT_CUSTOM_MDYYYY_HMM | custom datetime value | 3/11/2009 8:30
  NUMFORMAT_NUMBER_SEP_NEGBRA | number with thousands separator, negative in brackets | (4,000)
  NUMFORMAT_NUMBER_SEP_NEGBRARED | number with thousands separator, negative is red in brackets | (4,000)
  NUMFORMAT_NUMBER_D2_SEP_NEGBRA | number with thousands separator and decimal point, negative in brackets | (4,000.00)
  NUMFORMAT_NUMBER_D2_SEP_NEGBRARED | number with thousands separator and decimal point, negative is red in brackets | (4,000.00)
  NUMFORMAT_ACCOUNT | account value | 5,000
  NUMFORMAT_ACCOUNTCUR | account value with currency symbol |
  $ | 5,000
  NUMFORMAT_ACCOUNT_D2 | account value with decimal point | 5,000.00
  NUMFORMAT_ACCOUNT_D2_CUR | account value with currency symbol and decimal point |
  $ | 5,000.00
  NUMFORMAT_CUSTOM_MMSS | custom time value | 30:55
  NUMFORMAT_CUSTOM_H0MMSS | custom time value | 20:30:55
  NUMFORMAT_CUSTOM_MMSS0 | custom time value | 30:55.0
  NUMFORMAT_CUSTOM_000P0E_PLUS0 | custom value | 15.2E+3
  NUMFORMAT_TEXT | text value | any text
- const wchar_t* customNumFormat() const Returns a custom format string for this conditional format. See custom format string guidelines. void setCustomNumFormat(const wchar_t* customNumFormat) Sets a custom number format for this conditional format. The format string customNumFormat indicates how to format and render the numeric value of a cell. See custom format strings guidelines. void setBorder(BorderStyle style = BORDERSTYLE_THIN) Sets the border style.
  BorderStyle value | View
  BORDERSTYLE_NONE |
  BORDERSTYLE_THIN |
  BORDERSTYLE_MEDIUM |
  BORDERSTYLE_DASHED |
  BORDERSTYLE_DOTTED |
  BORDERSTYLE_THICK |
  BORDERSTYLE_DOUBLE |
  BORDERSTYLE_HAIR |
  BORDERSTYLE_MEDIUMDASHED |
  BORDERSTYLE_DASHDOT |
  BORDERSTYLE_MEDIUMDASHDOT |
  BORDERSTYLE_DASHDOTDOT |
  BORDERSTYLE_MEDIUMDASHDOTDOT |
  BORDERSTYLE_SLANTDASHDOT |
- void setBorderColor(Color color) Sets the border color. BorderStyle borderLeft() const Returns the left border style. void setBorderLeft(BorderStyle style = BORDERSTYLE_THIN) Sets the left border style. BorderStyle borderRight() const Returns the right border style. void setBorderRight(BorderStyle style = BORDERSTYLE_THIN) Sets the right border style. BorderStyle borderTop() const Returns the top border style. void setBorderTop(BorderStyle style = BORDERSTYLE_THIN) Sets the top border style. BorderStyle borderBottom() const Returns the bottom border style. void setBorderBottom(BorderStyle style = BORDERSTYLE_THIN) Sets the bottom border style. Color borderLeftColor() const Returns the color of the left border. void setBorderLeftColor(Color color) Sets the color of the left border. Color borderRightColor() const Returns the color of the right border. void setBorderRightColor(Color color) Sets the color of the right border. Color borderTopColor() const Returns the color of the top border. void setBorderTopColor(Color color) Sets the color of the top border. Color borderBottomColor() const Returns the color of the bottom border. void setBorderBottomColor(Color color) Sets the color of the bottom border. FillPattern fillPattern() const Returns the fill pattern. void setFillPattern(FillPattern pattern) Sets the fill pattern.
  FillPattern value | View
  FILLPATTERN_NONE |
  FILLPATTERN_SOLID |
  FILLPATTERN_GRAY50 |
  FILLPATTERN_GRAY75 |
  FILLPATTERN_GRAY25 |
  FILLPATTERN_HORSTRIPE |
  FILLPATTERN_VERSTRIPE |
  FILLPATTERN_REVDIAGSTRIPE |
  FILLPATTERN_DIAGSTRIPE |
  FILLPATTERN_DIAGCROSSHATCH |
  FILLPATTERN_THICKDIAGCROSSHATCH |
  FILLPATTERN_THINHORSTRIPE |
  FILLPATTERN_THINVERSTRIPE |
  FILLPATTERN_THINREVDIAGSTRIPE |
  FILLPATTERN_THINDIAGSTRIPE |
  FILLPATTERN_THINHORCROSSHATCH |
  FILLPATTERN_THINDIAGCROSSHATCH |
  FILLPATTERN_GRAY12P5 |
  FILLPATTERN_GRAY6P25 |
Color patternForegroundColor() const Returns the foreground color of the fill pattern. void setPatternForegroundColor(Color color) Sets the foreground color of the fill pattern. Color patternBackgroundColor() const Returns the background color of the fill pattern. void setPatternBackgroundColor(Color color) Sets the background color of the fill pattern. Index Book Sheet Format Font AutoFilter FilterColumn RichString FormControl ConditionalFormatting ConditionalFormat CoreProperties Table