Spread Windows Forms 7.0 Product Documentation
TimePeriod Enumeration
Example  See Also  Support Options
FarPoint.Win.Spread Assembly > FarPoint.Win.Spread Namespace : TimePeriod Enumeration


Glossary Item Box

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

Syntax

Visual Basic (Declaration) 
Public Enum TimePeriod 
   Inherits System.Enum
Visual Basic (Usage)Copy Code
Dim instance As TimePeriod
C# 
public enum TimePeriod : System.Enum 

Members

MemberDescription
Last7DaysIndicates a date in the last seven days.
LastMonthIndicates a date that occurred in the last calendar month.
LastWeekIndicates a date that occurred last week.
NextMonthIndicates a date that occurs in the next calendar month.
NextWeekIndicates a date that occurs next week.
ThisMonthIndicates a date that occurs in this calendar month.
ThisWeekIndicates a date that occurs this week.
TodayIndicates today's date.
TomorrowIndicates tomorrow's date.
YesterdayIndicates yesterday's date.

Example

This example creates a conditional rule.
C#Copy Code
private void Form1_Load(object sender, EventArgs e)
        {
            fpSpread1.Sheets[0].Cells[1, 1].Value = DateTime.Now;
        }

        private void button1_Click(object sender, EventArgs e)
        {
            //Date Occurs CF
            FarPoint.Win.Spread.TimePeriodConditionalFormattingRule time = new FarPoint.Win.Spread.TimePeriodConditionalFormattingRule(FarPoint.Win.Spread.TimePeriod.Last7Days);
            time.TimePeriod = FarPoint.Win.Spread.TimePeriod.Last7Days;
            time.ForeColor = Color.Magenta;
            fpSpread1.ActiveSheet.SetConditionalFormatting(1, 1, time);
        }
VB.NETCopy Code
Private Sub Form1_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

    Private Sub Button1_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Button1.Click
        'Date Occurs CF
        Dim time As New FarPoint.Win.Spread.TimePeriodConditionalFormattingRule(FarPoint.Win.Spread.TimePeriod.Last7Days)
        time.TimePeriod = FarPoint.Win.Spread.TimePeriod.Last7Days
        time.ForeColor = Color.DarkMagenta
        FpSpread1.ActiveSheet.SetConditionalFormatting(1, 1, time)
    End Sub

Inheritance Hierarchy

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

Requirements

Target Platforms: Windows 2000 Professional (SP4), Windows 2000 Server, Windows 2003 Server (SP1), Windows 2008, Windows XP (SP2), Windows Vista, Windows 7, Windows 8

See Also

© 2002-2014 ComponentOne, a division of GrapeCity. All Rights Reserved.