officefileapi-devexpress-dot-spreadsheet-dot-conditionalformattingcollection-dot-addtimeperiodconditionalformatting-x28-devexpress-dot-spreadsheet-dot-cellrange-devexpress-dot-spreadsheet-dot-conditionalformattingtimeperiod-x29.md
Applies a "date occurring…" conditional formatting rule.
Namespace : DevExpress.Spreadsheet
Assembly : DevExpress.Spreadsheet.v25.2.Core.dll
NuGet Package : DevExpress.Spreadsheet.Core
TimePeriodConditionalFormatting AddTimePeriodConditionalFormatting(
CellRange range,
ConditionalFormattingTimePeriod timePeriod
)
Function AddTimePeriodConditionalFormatting(
range As CellRange,
timePeriod As ConditionalFormattingTimePeriod
) As TimePeriodConditionalFormatting
| Name | Type | Description |
|---|---|---|
| range | CellRange |
A CellRange object that specifies a range of cells to which the conditional formatting rule is applied.
| | timePeriod | ConditionalFormattingTimePeriod |
One of the ConditionalFormattingTimePeriod enumeration values specifying time periods to be highlighted in a range of cells.
|
| Type | Description |
|---|---|
| TimePeriodConditionalFormatting |
A TimePeriodConditionalFormatting object that represents the specified conditional format.
|
This example demonstrates how to apply a "date occurring…" conditional formatting rule.
To create a new conditional formatting rule represented by the TimePeriodConditionalFormatting object, access the collection of conditional formats from the Worksheet.ConditionalFormattings property and call the ConditionalFormattingCollection.AddTimePeriodConditionalFormatting method. Pass the following parameters:
Specify formatting options to be applied to cells if the condition is true using the ISupportsFormatting.Formatting property of the TimePeriodConditionalFormatting object.
Note
Transparency is not supported in conditional formatting.
To remove the TimePeriodConditionalFormatting object, use the ConditionalFormattingCollection.Remove, ConditionalFormattingCollection.RemoveAt or ConditionalFormattingCollection.Clear methods.
// Create the rule to highlight today's dates in cells B2 through B6.
TimePeriodConditionalFormatting cfRule =
worksheet.ConditionalFormattings.AddTimePeriodConditionalFormatting(worksheet.Range["$B$2:$B$6"], ConditionalFormattingTimePeriod.Today);
// Specify formatting options to be applied to cells if the condition is true.
// Set the background color to pink.
cfRule.Formatting.Fill.BackgroundColor = Color.FromArgb(255, 0xF2, 0xAE, 0xE3);
' Create the rule to highlight today's dates in cells B2 through B6.
Dim cfRule As TimePeriodConditionalFormatting = worksheet.ConditionalFormattings.AddTimePeriodConditionalFormatting(worksheet.Range("$B$2:$B$6"), ConditionalFormattingTimePeriod.Today)
' Specify formatting options to be applied to cells if the condition is true.
' Set the background color to pink.
cfRule.Formatting.Fill.BackgroundColor = Color.FromArgb(255, &HF2, &HAE, &HE3)
The following code snippets (auto-collected from DevExpress Examples) contain references to the AddTimePeriodConditionalFormatting(CellRange, ConditionalFormattingTimePeriod) method.
Note
The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.
TimePeriodConditionalFormatting cfRule =
worksheet.ConditionalFormattings.AddTimePeriodConditionalFormatting(worksheet["$B$2:$B$6"], ConditionalFormattingTimePeriod.Today);
// Specify formatting options to be applied to cells if the condition is true.
TimePeriodConditionalFormatting cfRule =
worksheet.ConditionalFormattings.AddTimePeriodConditionalFormatting(worksheet.Range["$B$2:$B$6"], ConditionalFormattingTimePeriod.Today);
// Specify formatting options to be applied to cells if the condition is true.
TimePeriodConditionalFormatting cfRule =
worksheet.ConditionalFormattings.AddTimePeriodConditionalFormatting(worksheet.Range["$B$2:$B$6"], ConditionalFormattingTimePeriod.Today);
// Specify formatting options to be applied to cells if the condition is true.
' Create the rule to highlight today's dates in cells B2 through B6.
Dim cfRule As TimePeriodConditionalFormatting = worksheet.ConditionalFormattings.AddTimePeriodConditionalFormatting(worksheet("$B$2:$B$6"), ConditionalFormattingTimePeriod.Today)
' Specify formatting options to be applied to cells if the condition is true.
' Create the rule to highlight today's dates in cells B2 through B6.
Dim cfRule As TimePeriodConditionalFormatting = worksheet.ConditionalFormattings.AddTimePeriodConditionalFormatting(worksheet.Range("$B$2:$B$6"), ConditionalFormattingTimePeriod.Today)
' Specify formatting options to be applied to cells if the condition is true.
' Create the rule to highlight today's dates in cells B2 through B6.
Dim cfRule As TimePeriodConditionalFormatting = worksheet.ConditionalFormattings.AddTimePeriodConditionalFormatting(worksheet.Range("$B$2:$B$6"), ConditionalFormattingTimePeriod.Today)
' Specify formatting options to be applied to cells if the condition is true.
See Also
ConditionalFormattingCollection Interface