Components | All | New | MacOS | Windows | Linux | iOS | ||||
Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old |
XL.ConditionalFormating.AddTopRule
Adds a conditional formatting rule that highlights cells whose values fall in the [top N] or [bottom N] bracket.
Component | Version | macOS | Windows | Linux | Server | iOS SDK |
XL | 14.2 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
MBS( "XL.ConditionalFormating.AddTopRule"; bookRef; ConditionalFormattingRef; ConditionalFormatRef { ; Value; Bottom; Percent; StopIfTrue } ) More
Parameters
Parameter | Description | Example | Flags |
---|---|---|---|
bookRef | The reference to the workbook. Please use XL.LoadBook to load a file. | $ref | |
ConditionalFormattingRef | The reference number for the conditional formatting. | $ConditionalFormatting | |
ConditionalFormatRef | The reference number for the conditional format. The conditional format used for highlighting cells, use the XL.Book.AddConditionalFormat for adding conditional formats. |
$ConditionalFormat | |
Value | Specifies the [top N] or [bottom N] bracket. Default is 0. |
0 | Optional |
Bottom | True for a [bottom N] rule, false for a [top N] rule. Default is false. |
Optional | |
Percent | True for a percent top/bottom rule. Default is false. |
Optional | |
StopIfTrue | If true, no rules with lower priority may be applied over this rule, when this rule is true. Default is false. |
Optional |
Result
Returns OK or error.
Description
Adds a conditional formatting rule that highlights cells whose values fall in the [top N] or [bottom N] bracket.See also
- XL.Book.AddConditionalFormat
- XL.ConditionalFormating.Add2ColorScaleRule
- XL.ConditionalFormating.Add3ColorScaleRule
- XL.ConditionalFormating.AddOpNumRule
- XL.ConditionalFormating.AddOpStrRule
- XL.ConditionalFormating.AddRange
- XL.ConditionalFormating.AddRule
- XL.ConditionalFormating.AddTimePeriodRule
- XL.LoadBook
Created 30th March 2024, last changed 30th March 2024
XL.ConditionalFormating.AddTimePeriodRule - XL.CopyCellValue
