Format Property (CellStyle)

Gets or sets a string that is used to format the textual content of a cell.

Syntax

Visual Basic (Declaration)
Visual Basic (Usage)
C#

<SRCategoryAttribute("Behavior")>
<RefreshPropertiesAttribute(RefreshProperties.Repaint)>
<SRDescriptionAttribute("Indicates a string that is used to format the textual content of a cell. ")>
<EditorAttribute(EditorBaseTypeName="System.Drawing.Design.UITypeEditor, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", EditorTypeName="GrapeCity.Win.MultiRow.Design.CellStyleFormatTypeEditor, GrapeCity.Win.MultiRow, Version=7.20.20141.0, Culture=neutral, PublicKeyToken=0f7a722ee3c2bdd9")>
<DefaultValueAttribute()>
Public Property Format As String

Dim instance As CellStyle
Dim value As String
 
instance.Format = value
 
value = instance.Format

[SRCategory("Behavior")]
[RefreshProperties(RefreshProperties.Repaint)]
[SRDescription("Indicates a string that is used to format the textual content of a cell. ")]
[Editor(EditorBaseTypeName="System.Drawing.Design.UITypeEditor, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", EditorTypeName="GrapeCity.Win.MultiRow.Design.CellStyleFormatTypeEditor, GrapeCity.Win.MultiRow, Version=7.20.20141.0, Culture=neutral, PublicKeyToken=0f7a722ee3c2bdd9")]
[DefaultValue()]
public string Format {get; set;}

Property Value

A System.String value that is used to format the textual content of a cell. The default is a null reference (Nothing in Visual Basic).

Example

The following code example shows how to use this property to customize the cell appearance. This code example is part of a larger example provided for the CellStyle class.

void Form1_Load(object sender, EventArgs e)
        {
            // All cell's will use default cell style.
            gcMultiRow1.RowsDefaultCellStyle.BackColor = Color.Black;
            gcMultiRow1.RowsDefaultCellStyle.ForeColor = Color.White;
            gcMultiRow1.RowsDefaultCellStyle.SelectionBackColor = Color.FromArgb(100, SystemColors.Highlight);
            gcMultiRow1.RowsDefaultCellStyle.TextAlign = MultiRowContentAlignment.MiddleRight;

            // The cell's in alternating Rows
            gcMultiRow1.AlternatingRowsDefaultCellStyle.GradientColors = new Color[] { Color.FromArgb(25, 25, 25), Color.FromArgb(75, 75, 75) };
            gcMultiRow1.AlternatingRowsDefaultCellStyle.GradientDirection = GradientDirection.Backward;
            gcMultiRow1.AlternatingRowsDefaultCellStyle.GradientStyle = GradientStyle.Horizontal;

            // Row header cells
            gcMultiRow1.RowsDefaultHeaderCellStyle.BackColor = Color.FromArgb(75, 75, 75);
            gcMultiRow1.RowsDefaultHeaderCellStyle.ForeColor = Color.White;

            // column header cells.
            gcMultiRow1.ColumnHeadersDefaultHeaderCellStyle.BackColor = Color.FromArgb(75, 75, 75);
            gcMultiRow1.ColumnHeadersDefaultHeaderCellStyle.ForeColor = Color.FromArgb(200, 200, 200);
            gcMultiRow1.ColumnHeadersDefaultHeaderCellStyle.TextAlign = MultiRowContentAlignment.MiddleCenter;
            gcMultiRow1.ColumnHeadersDefaultHeaderCellStyle.UseCompatibleTextRendering = MultiRowTriState.True;
            gcMultiRow1.ColumnHeadersDefaultHeaderCellStyle.TextEffect = TextEffect.SunkenLite;

            // All cells in specific row.
            gcMultiRow1.Rows[0].DefaultCellStyle.PatternColor = Color.Gray;
            gcMultiRow1.Rows[0].DefaultCellStyle.PatternStyle = MultiRowHatchStyle.BackwardDiagonal;
            gcMultiRow1.Rows[0].DefaultCellStyle.Font = new Font(Control.DefaultFont, FontStyle.Underline);

            // Change single cell
            gcMultiRow1[0, 0].Style.UseCompatibleTextRendering = MultiRowTriState.True;
            gcMultiRow1[0, 0].Style.TextAngle = 30;
            gcMultiRow1[0, 0].Style.Format = "#0.00%";
        }

VB.NET

Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs) Handles Me.Load
        ' All cell's will use default cell style.
        gcMultiRow1.RowsDefaultCellStyle.BackColor = Color.Black
        gcMultiRow1.RowsDefaultCellStyle.ForeColor = Color.White
        gcMultiRow1.RowsDefaultCellStyle.SelectionBackColor = Color.FromArgb(100, SystemColors.Highlight)
        gcMultiRow1.RowsDefaultCellStyle.TextAlign = MultiRowContentAlignment.MiddleRight

        ' The cell's in alternating Rows
        gcMultiRow1.AlternatingRowsDefaultCellStyle.GradientColors = New Color() {Color.FromArgb(25, 25, 25), Color.FromArgb(75, 75, 75)}
        gcMultiRow1.AlternatingRowsDefaultCellStyle.GradientDirection = GradientDirection.Backward
        gcMultiRow1.AlternatingRowsDefaultCellStyle.GradientStyle = GradientStyle.Horizontal

        ' Row header cells
        gcMultiRow1.RowsDefaultHeaderCellStyle.BackColor = Color.FromArgb(75, 75, 75)
        gcMultiRow1.RowsDefaultHeaderCellStyle.ForeColor = Color.White

        ' column header cells.
        gcMultiRow1.ColumnHeadersDefaultHeaderCellStyle.BackColor = Color.FromArgb(75, 75, 75)
        gcMultiRow1.ColumnHeadersDefaultHeaderCellStyle.ForeColor = Color.FromArgb(200, 200, 200)
        gcMultiRow1.ColumnHeadersDefaultHeaderCellStyle.TextAlign = MultiRowContentAlignment.MiddleCenter
        gcMultiRow1.ColumnHeadersDefaultHeaderCellStyle.UseCompatibleTextRendering = MultiRowTriState.True
        gcMultiRow1.ColumnHeadersDefaultHeaderCellStyle.TextEffect = TextEffect.SunkenLite

        ' All cells in specific row.
        gcMultiRow1.Rows(0).DefaultCellStyle.PatternColor = Color.Gray
        gcMultiRow1.Rows(0).DefaultCellStyle.PatternStyle = MultiRowHatchStyle.BackwardDiagonal
        gcMultiRow1.Rows(0).DefaultCellStyle.Font = New Font(Control.DefaultFont, FontStyle.Underline)

        ' Change single cell
        gcMultiRow1(0, 0).Style.UseCompatibleTextRendering = MultiRowTriState.True
        gcMultiRow1(0, 0).Style.TextAngle = 30
        gcMultiRow1(0, 0).Style.Format = "#0.00%"
    End Sub

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

CellStyle Class
CellStyle Members