TimePeriod Enumeration

Represents a time period which is used in a date conditional formatting rule. These are dynamic time periods, which change based on the date when the conditional formatting rule is refreshed or applied.

Syntax

Visual Basic
C#

'Declaration
 
Public Enum TimePeriod 
   Inherits System.Enum

'Usage
 
Dim instance As TimePeriod

public enum TimePeriod : System.Enum

Members

Member	Description
Last7Days	Indicates a date in the last seven days.
LastMonth	Indicates a date that occurred in the last calendar month.
LastWeek	Indicates a date that occurred last week.
NextMonth	Indicates a date that occurs in the next calendar month.
NextWeek	Indicates a date that occurs next week.
ThisMonth	Indicates a date that occurs in this calendar month.
ThisWeek	Indicates a date that occurs this week.
Today	Indicates today's date.
Tomorrow	Indicates tomorrow's date.
Yesterday	Indicates yesterday's date.

Example

This example sets the TimePeriod enumeration.

protected void Page_Load(object sender, System.EventArgs e)
                       {
                           FpSpread1.Sheets[0].Cells[1, 1].Value = DateTime.Now;
                       }

protected void Button1_Click(object sender, EventArgs e)
        {
            //Date Occurs CF
            FarPoint.Web.Spread.TimePeriodConditionalFormattingRule time = new FarPoint.Web.Spread.TimePeriodConditionalFormattingRule(FarPoint.Web.Spread.TimePeriod.Last7Days);
            time.TimePeriod = FarPoint.Web.Spread.TimePeriod.Last7Days;
            time.ForeColor = Color.Magenta;
            FpSpread1.ActiveSheetView.SetConditionalFormatting(1, 1, time);
        }

VB.NET

Private Sub Page_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load
            FpSpread1.Sheets(0).Cells(1, 1).Value = Date.Now
        End Sub

Protected Sub Button1_Click(sender As Object, e As EventArgs) Handles Button1.Click
            'Date Occurs CF
            Dim time As New FarPoint.Web.Spread.TimePeriodConditionalFormattingRule(FarPoint.Web.Spread.TimePeriod.Last7Days)
            time.TimePeriod = FarPoint.Web.Spread.TimePeriod.Last7Days
            time.ForeColor = Drawing.Color.DarkMagenta
            FpSpread1.ActiveSheetView.SetConditionalFormatting(1, 1, time)
        End Sub

Inheritance Hierarchy

System.Object
   System.ValueType
      System.Enum
         FarPoint.Web.Spread.TimePeriod

Requirements

Target Platforms: Windows 7, Windows 8, Windows Vista, Windows Server 2000, Windows 2000 Professional, Windows XP Professional, Windows NT 4.0 Workstation, SP6, Windows NT 4.0 Server, SP6

Reference

FarPoint.Web.Spread Namespace