Word Reports
BackgroundColor Property
Example 



KellermanSoftware.WordReports Namespace > ColumnDefinition Class : BackgroundColor Property
The background color of the column. The default is White
Syntax
Public Property BackgroundColor As Color
Dim instance As ColumnDefinition
Dim value As Color
 
instance.BackgroundColor = value
 
value = instance.BackgroundColor
public Color BackgroundColor {get; set;}
public:
property Color BackgroundColor {
   Color get();
   void set (    Color value);
}
Example
//To run this example code, create a word document called ExampleTemplate.docx with the text [ReplaceMe] in the document
 
WordReportsGenerator generator = new WordReportsGenerator(); //Trial Mode
//WordReportsGenerator generator = new WordReportsGenerator("place user name here", "place license key here"); //License Mode
 
const string sourceDocumentPath = @"Test Documents\ExampleTemplate.docx";
const string outputDocumentPath = "ExampleOutput.docx";
 
using (Document document = generator.DocumentFactory(sourceDocumentPath))
{
    DataTable dataTable = new DataTable();
    dataTable.Columns.Add("FirstName", typeof(string));
    dataTable.Columns.Add("LastName", typeof(string));
    dataTable.Columns.Add("Salary", typeof(decimal));
 
    dataTable.Rows.Add("John", "Smith", 30000M);
    dataTable.Rows.Add("Joe", "Jones", 45000M);
 
    List<ColumnDefinition> columnDefinitions =
new List<ColumnDefinition>
        {
            new ColumnDefinition("LastName"),
            new ColumnDefinition("FirstName"),
            new ColumnDefinition("Salary")
                {
                    BackgroundColor = System.Drawing.Color.Gray
                }
        };
 
    Dictionary<string, ReplacementItem> replacement =
        new Dictionary<string, ReplacementItem>
            {
                {
                    "[ReplaceMe]",
                    new ReplacementItem {Value = dataTable, ColumnDefinitions = columnDefinitions}
                }
            };
 
    generator.Replace(document, replacement);
    generator.SaveDocument(document, outputDocumentPath);
}
'To run this example code, create a word document called ExampleTemplate.docx with the text [ReplaceMe] in the document
 
Dim generator As New WordReportsGenerator() 'Trial Mode
'WordReportsGenerator generator = new WordReportsGenerator("place user name here", "place license key here"); //License Mode
 
Const sourceDocumentPath As String = "Test Documents\ExampleTemplate.docx"
Const outputDocumentPath As String = "ExampleOutput.docx"
 
Using document As Document = generator.DocumentFactory(sourceDocumentPath)
    Dim dataTable As New DataTable()
    dataTable.Columns.Add("FirstName", GetType(String))
    dataTable.Columns.Add("LastName", GetType(String))
    dataTable.Columns.Add("Salary", GetType(Decimal))
 
    dataTable.Rows.Add("John", "Smith", 30000D)
    dataTable.Rows.Add("Joe", "Jones", 45000D)
 
    Dim columnDefinitions As New List(Of ColumnDefinition)() From { _
        New ColumnDefinition("LastName"), _
        New ColumnDefinition("FirstName"), _
        New ColumnDefinition("Salary") With {.BackgroundColor = System.Drawing.Color.Gray} _
    }
 
    Dim replacement As New Dictionary(Of String, ReplacementItem)() From {{ "[ReplaceMe]", New ReplacementItem With {.Value = dataTable, .ColumnDefinitions = columnDefinitions} }}
 
    generator.Replace(document, replacement)
    generator.SaveDocument(document, outputDocumentPath)
End Using
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

See Also

Reference

ColumnDefinition Class
ColumnDefinition Members