FormatString Property (FilterBarCellType)

Gets or sets the format string used to format the value. Currently, this property is used to format date values from the date picker only.

Syntax

Visual Basic
C#

'Declaration
 
Public Property FormatString As String

'Usage
 
Dim instance As FilterBarCellType
Dim value As String
 
instance.FormatString = value
 
value = instance.FormatString

public string FormatString {get; set;}

Example

This example sets the FormatString property.

FarPoint.Web.Spread.FilterBarCellType ct = new FarPoint.Web.Spread.FilterBarCellType();
ct.MenuType = FarPoint.Web.Spread.FilterMenuType.Date;            
System.Globalization.DateTimeFormatInfo dtformat = new System.Globalization.DateTimeFormatInfo();
dtformat.ShortDatePattern = "yy/MM/dd";
dtformat.ShortTimePattern = "";
dtformat.LongTimePattern = "";
ct.DateTimeFormat = dtformat;
ct.DatePickerMode = FarPoint.Web.Spread.DatePickerMode.Auto;

FarPoint.Web.Spread.FilterBarCellType ct1 = new FarPoint.Web.Spread.FilterBarCellType();
ct1.FormatString = "dd";
ct1.MenuType = FarPoint.Web.Spread.FilterMenuType.Date;
           
FarPoint.Web.Spread.FilterBarCellType ct2 = new FarPoint.Web.Spread.FilterBarCellType();   
ct2.MenuType = FarPoint.Web.Spread.FilterMenuType.Number;

FpSpread1.ActiveSheetView.FilterBar.Cells[0].CellType = ct;
FpSpread1.ActiveSheetView.FilterBar.Cells[0].BackColor = System.Drawing.Color.Red;
FpSpread1.ActiveSheetView.FilterBar.Cells[1].CellType = ct1;
FpSpread1.ActiveSheetView.FilterBar.Cells[1].BackColor = System.Drawing.Color.Aqua;
FpSpread1.ActiveSheetView.FilterBar.Cells[2].CellType = ct2;
FpSpread1.ActiveSheetView.FilterBar.Cells[2].BackColor = System.Drawing.Color.Yellow;
           
FpSpread1.ActiveSheetView.AutoFilterMode = FarPoint.Web.Spread.AutoFilterMode.FilterBar;
FpSpread1.ActiveSheetView.Cells[0, 0].CellType = new FarPoint.Web.Spread.DateTimeCellType();
FpSpread1.ActiveSheetView.Cells[0, 1].CellType = new FarPoint.Web.Spread.DateTimeCellType();
FpSpread1.ActiveSheetView.Cells[0, 2].CellType = new FarPoint.Web.Spread.CurrencyCellType();
FpSpread1.ActiveSheetView.Cells[0, 0].Value = DateTime.Now;
FpSpread1.ActiveSheetView.Cells[0, 1].Value = DateTime.Today;
FpSpread1.ActiveSheetView.Cells[0, 2].Value = 33.34;

VB.NET

Dim ct As New FarPoint.Web.Spread.FilterBarCellType()
ct.MenuType = FarPoint.Web.Spread.FilterMenuType.Date
Dim dtformat As New System.Globalization.DateTimeFormatInfo()
dtformat.ShortDatePattern = "yy/MM/dd"
dtformat.ShortTimePattern = ""
dtformat.LongTimePattern = ""
ct.DateTimeFormat = dtformat
ct.DatePickerMode = FarPoint.Web.Spread.DatePickerMode.Auto

Dim ct1 As New FarPoint.Web.Spread.FilterBarCellType()
ct1.FormatString = "dd"
ct1.MenuType = FarPoint.Web.Spread.FilterMenuType.Date

Dim ct2 As New FarPoint.Web.Spread.FilterBarCellType()
ct2.MenuType = FarPoint.Web.Spread.FilterMenuType.Number

FpSpread1.ActiveSheetView.FilterBar.Cells(0).CellType = ct
FpSpread1.ActiveSheetView.FilterBar.Cells(0).BackColor = System.Drawing.Color.Red
FpSpread1.ActiveSheetView.FilterBar.Cells(1).CellType = ct1
FpSpread1.ActiveSheetView.FilterBar.Cells(1).BackColor = System.Drawing.Color.Aqua
FpSpread1.ActiveSheetView.FilterBar.Cells(2).CellType = ct2
FpSpread1.ActiveSheetView.FilterBar.Cells(2).BackColor = System.Drawing.Color.Yellow
FpSpread1.ActiveSheetView.AutoFilterMode = FarPoint.Web.Spread.AutoFilterMode.FilterBar
FpSpread1.ActiveSheetView.Cells(0, 0).CellType = New FarPoint.Web.Spread.DateTimeCellType()
FpSpread1.ActiveSheetView.Cells(0, 1).CellType = New FarPoint.Web.Spread.DateTimeCellType()
FpSpread1.ActiveSheetView.Cells(0, 2).CellType = New FarPoint.Web.Spread.CurrencyCellType()
FpSpread1.ActiveSheetView.Cells(0, 0).Value = DateTime.Now
FpSpread1.ActiveSheetView.Cells(0, 1).Value = DateTime.Today
FpSpread1.ActiveSheetView.Cells(0, 2).Value = 33.34

Requirements

Target Platforms: Windows 7, Windows 8, Windows 10, Windows Vista, Windows Server 2003, Windows Server 2008, Windows Server 2012, Windows XP Professional

Reference

FilterBarCellType Class
FilterBarCellType Members