Column Class

Column Width and Formatting.When the object is serialized out as xml, its qualified name is x:col.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Spreadsheet.Column

Namespace:  DocumentFormat.OpenXml.Spreadsheet
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

Syntax

'Declaration
Public Class Column _
    Inherits OpenXmlLeafElement
'Usage
Dim instance As Column

public class Column : OpenXmlLeafElement

Remarks

[ISO/IEC 29500-1 1st Edition]

18.3.1.13 col (Column Width & Formatting)

Defines column width and column formatting for one or more columns of the worksheet.

[Example:This example shows that column 5 (E) has width and style information applied.

<col min="5" max="5" width="9.140625" style="3"/>

end example]

[Note: The W3C XML Schema definition of this element’s content model (CT_Col) is located in §A.2. end note]

© ISO/IEC29500: 2008.

Examples

The following example opens a spreadsheet document for read-only access. By using the worksheet name and the cell name, it gets the column name and displays it.

using System;
using System.Collections.Generic;
using System.Linq;
using DocumentFormat.OpenXml.Packaging;
using DocumentFormat.OpenXml.Spreadsheet;
using System.Text.RegularExpressions;

namespace ColumnEx
{
    class Program
    {
        // Given a document name, a worksheet name, and a cell name, gets the column of the cell.
        static void Main(string[] args)
        {
            string docName = @"C:\Users\Public\Documents\ColumnEx.xlsx";
            string worksheetName = "Sheet1";
            string cellName = "B2";

            // Open the document as read-only.
            using (SpreadsheetDocument document = SpreadsheetDocument.Open(docName, false))
            {
                IEnumerable<Sheet> sheets =
                    document.WorkbookPart.Workbook.Descendants<Sheet>()
                    .Where(s => s.Name == worksheetName);
                WorksheetPart worksheetPart = (WorksheetPart)document
                    .WorkbookPart.GetPartById(sheets.First().Id);

                // Get the column name for the specified cell.
                // Create a regular expression to match the column name portion of the cell name.
                Regex regex = new Regex("[A-Za-z]+");
                Match match = regex.Match(cellName);
                Console.WriteLine("{0} {1}","The column is:", match.Value);
                Console.ReadKey();
            }
        }
    }
}
//  Output:
// The column is: B

Imports System.Collections.Generic
Imports System.Linq
Imports DocumentFormat.OpenXml.Packaging
Imports DocumentFormat.OpenXml.Spreadsheet
Imports System.Text.RegularExpressions

Module Module1
    ' Given a document name, a worksheet name, and a cell name, gets the column of the cell.
    Sub Main(ByVal args As String())
        Dim docName As String = "C:\Users\Public\Documents\ColumnEx.xlsx"
        Dim worksheetName As String = "Sheet1"
        Dim cellName As String = "B2"

        ' Open the document as read-only.
        Using document As SpreadsheetDocument = SpreadsheetDocument.Open(docName, False)
            Dim sheets As IEnumerable(Of Sheet) = document.WorkbookPart.Workbook.Descendants(Of Sheet)().Where(Function(s) s.Name = worksheetName)
            Dim worksheetPart As WorksheetPart = DirectCast(document.WorkbookPart.GetPartById(sheets.First().Id), WorksheetPart)

            ' Get the column name for the specified cell.
            ' Create a regular expression to match the column name portion of the cell name.
            Dim regex As New Regex("[A-Za-z]+")
            Dim match As Match = regex.Match(cellName)
            Console.WriteLine("{0} {1}", "The column is:", match.Value)
            Console.ReadKey()
        End Using
    End Sub
End Module
' Output:
' The column is: B

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Column Members

DocumentFormat.OpenXml.Spreadsheet Namespace