Export (0) Print
Expand All

ListObject.DataBoundFormatSettings Property

Gets or sets which FormatSettings of the specified XlRangeAutoFormat are applied to the ListObject control.

Namespace:  Microsoft.Office.Tools.Excel
Assembly:  Microsoft.Office.Tools.Excel (in Microsoft.Office.Tools.Excel.dll)

FormatSettings DataBoundFormatSettings { get; set; }

Property Value

Type: Microsoft.Office.Tools.Excel.FormatSettings
A bitwise combination of the FormatSettings values.

By default, all of the information in the XlRangeAutoFormat style is applied. However, specific items can be removed so that the style is not applied to those items. These items are:

  • Number

  • Font

  • Alignment

  • Border

  • Pattern

  • Width

To apply only selected styles, set DataBoundFormatSettings before the DataBoundFormat property is set. DataBoundFormatSettings will not work if DataBoundFormat is already set.

The following code example creates a DataTable and a ListObject, and binds the ListObject to the DataTable. It then sets the FormatSettings to apply to the ListObject and uses an XlRangeAutoFormat value to supply the format.

This example is for a document-level customization.

private void ListObject_DataBoundFormatSettings()
{
    // Create a new DataSet and DataTable.
    DataSet ds = new DataSet();
    DataTable dt = ds.Tables.Add("Customers");
    dt.Columns.Add(new DataColumn("LastName"));
    dt.Columns.Add(new DataColumn("FirstName"));

    // Add a new row to the DataTable.
    DataRow dr = dt.NewRow();
    dr["LastName"] = "Chan";
    dr["FirstName"] = "Gareth";
    dt.Rows.Add(dr);

    // Create a list object.
    Microsoft.Office.Tools.Excel.ListObject list1 = 
        this.Controls.AddListObject(
        this.Range["A1"], "list1");

    // Bind the list object to the DataTable.
    list1.AutoSetDataBoundColumnHeaders = true;
    list1.SetDataBinding(ds, "Customers", "LastName",
        "FirstName");

    // Specify the format settings that you want to include. 
    // In this example, only the Font and Pattern  
    // settings are applied.
    list1.DataBoundFormatSettings =
        Microsoft.Office.Tools.Excel.FormatSettings.Font |
        Microsoft.Office.Tools.Excel.FormatSettings.Pattern;

    // Add a format to the list object.
    list1.DataBoundFormat = 
        Excel.XlRangeAutoFormat.xlRangeAutoFormatList2;
}

Show:
© 2015 Microsoft