ListObject.DataBoundFormatSettings Property

public:
 property Microsoft::Office::Tools::Excel::FormatSettings DataBoundFormatSettings { Microsoft::Office::Tools::Excel::FormatSettings get(); void set(Microsoft::Office::Tools::Excel::FormatSettings value); };

public Microsoft.Office.Tools.Excel.FormatSettings DataBoundFormatSettings { get; set; }

member this.DataBoundFormatSettings : Microsoft.Office.Tools.Excel.FormatSettings with get, set

Public Property DataBoundFormatSettings As FormatSettings

Property Value

A bitwise combination of the FormatSettings values.

Examples

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;
}

Private Sub ListObject_DataBoundFormatSettings()
    ' Create a new DataSet and DataTable.
    Dim ds As New DataSet()
    Dim dt As DataTable = ds.Tables.Add("Customers")
    dt.Columns.Add(New DataColumn("LastName"))
    dt.Columns.Add(New DataColumn("FirstName"))

    ' Add a new row to the DataTable.
    Dim dr As DataRow = dt.NewRow()
    dr("LastName") = "Chan"
    dr("FirstName") = "Gareth"
    dt.Rows.Add(dr)

    ' Create a list object.
    Dim List1 As Microsoft.Office.Tools.Excel.ListObject = _
        Me.Controls.AddListObject(Me.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 Or _
        Microsoft.Office.Tools.Excel.FormatSettings.Pattern

    ' Add a format to the list object.
    List1.DataBoundFormat = _
        Excel.XlRangeAutoFormat.xlRangeAutoFormatList2

End Sub

Remarks

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.

Applies to