Row Class

Definition

Namespace:

DocumentFormat.OpenXml.Spreadsheet

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Row.

This class is available in Office 2007 and above.

When the object is serialized out as xml, it's qualified name is x:row.

public class Row : DocumentFormat.OpenXml.OpenXmlCompositeElement

type Row = class
    inherit OpenXmlCompositeElement

Public Class Row
Inherits OpenXmlCompositeElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

Row

Examples

The following code example creates a spreadsheet documents, adds a row to the cell table, and writes the number "123" in the cell A1.

using System;  
using DocumentFormat.OpenXml;  
using DocumentFormat.OpenXml.Packaging;  
using DocumentFormat.OpenXml.Spreadsheet;  

namespace RowEx  
{  
    class Program  
    {  
        static void Main(string[] args)  
        {  
            string fileName = @"C:\Users\Public\Documents\RowEx.xlsx";  

            // Create a spreadsheet document by using the file name.  
            SpreadsheetDocument spreadsheetDocument =  
                 SpreadsheetDocument.Create(fileName, SpreadsheetDocumentType.Workbook);  

            // Add a WorkbookPart and Workbook objects.  
            WorkbookPart workbookpart = spreadsheetDocument.AddWorkbookPart();  
            workbookpart.Workbook = new Workbook();  

            // Add a WorksheetPart.  
            WorksheetPart worksheetPart = workbookpart.AddNewPart<WorksheetPart>();  

            // Create Worksheet and SheetData objects.  
            worksheetPart.Worksheet = new Worksheet(new SheetData());  

            // Add a Sheets object.  
            Sheets sheets = spreadsheetDocument.WorkbookPart.Workbook  
                .AppendChild<Sheets>(new Sheets());  

            // Append the new worksheet named "mySheet" and associate it   
            // with the workbook.  
            Sheet sheet = new Sheet()  
            {  
                Id = spreadsheetDocument.WorkbookPart  
                    .GetIdOfPart(worksheetPart),  
                SheetId = 1,  
                Name = "mySheet"  
            };  
            sheets.Append(sheet);  

            // Get the sheetData cell table.  
            SheetData sheetData = worksheetPart.Worksheet.GetFirstChild<SheetData>();  

            // Add a row to the cell table.  
            Row row;  
            row = new Row() { RowIndex = 1 };  
            sheetData.Append(row);  

            // Add the cell to the cell table at A1.  
            Cell refCell = null;  
            Cell newCell = new Cell() { CellReference = "A1" };  
            row.InsertBefore(newCell, refCell);  

            // Set the cell value to be a numeric value of 123.  
            newCell.CellValue = new CellValue("123");  
            newCell.DataType = new EnumValue<CellValues>(CellValues.Number);  

            // Close the document.  
            spreadsheetDocument.Close();  

            Console.WriteLine("All done. Press a key");  
            Console.ReadKey();  
        }  
    }  
}  

Imports System  
Imports DocumentFormat.OpenXml  
Imports DocumentFormat.OpenXml.Packaging  
Imports DocumentFormat.OpenXml.Spreadsheet  

Module Module1  

    Sub Main(ByVal args As String())  
        Dim fileName As String = "C:\Users\Public\Documents\RowEx.xlsx"  

        ' Create a spreadsheet document by using the file name.  
        Dim spreadsheetDocument As SpreadsheetDocument = _  
            spreadsheetDocument.Create(fileName, SpreadsheetDocumentType.Workbook)  

        ' Add a WorkbookPart and Workbook objects.  
        Dim workbookpart As WorkbookPart = spreadsheetDocument.AddWorkbookPart()  
        workbookpart.Workbook = New Workbook()  

        ' Add a WorksheetPart.  
        Dim worksheetPart As WorksheetPart = _  
            workbookpart.AddNewPart(Of WorksheetPart)()  

        ' Create Worksheet and SheetData objects.  
        worksheetPart.Worksheet = New Worksheet(New SheetData())  

        ' Add a Sheets object.  
        Dim sheets As Sheets = _  
            spreadsheetDocument.WorkbookPart.Workbook.AppendChild(Of Sheets)(New Sheets())  

        ' Append the new worksheet named "mySheet" and associate it   
        ' with the workbook.  
        Dim sheet As New Sheet() With { _  
         .Id = SpreadsheetDocument.WorkbookPart.GetIdOfPart(worksheetPart), _  
         .SheetId = 1, _  
         .Name = "mySheet" _  
        }  
        sheets.Append(sheet)  

        ' Get the sheetData cell table.  
        Dim sheetData As SheetData = _  
            worksheetPart.Worksheet.GetFirstChild(Of SheetData)()  

        ' Add a row to the cell table.  
        Dim row As Row  
        row = New Row() With { _  
         .RowIndex = 1 _  
        }  
        sheetData.Append(row)  

        ' Add the cell to the cell table at A1.  
        Dim refCell As Cell = Nothing  
        Dim newCell As New Cell() With { _  
         .CellReference = "A1" _  
        }  
        row.InsertBefore(newCell, refCell)  

        ' Set the cell value to be a numeric value of 123.  
        newCell.CellValue = New CellValue("123")  
        newCell.DataType = New EnumValue(Of CellValues)(CellValues.Number)  

        ' Close the document.  
        spreadsheetDocument.Close()  

        Console.WriteLine("All done. Press a key")  
        Console.ReadKey()  
    End Sub  
End Module  

Remarks

[ISO/IEC 29500-1 1st Edition]

row (Row)

The element expresses information about an entire row of a worksheet, and contains all cell definitions for a particular row in the worksheet.

[Example:

This row expresses information about row the worksheet, and contains 3 cell definitions.

<row r="2" spans="2:12">  
  <c r="C2" s="1">  
    <f>PMT(B3/12,B4,-B5)</f>  
    <v>672.68336574300008</v>  
  </c>  
  <c r="D2">  
    <v>180</v>  
  </c>  
  <c r="E2">  
    <v>360</v>  
  </c>  
</row>  

end example]

Parent Elements
sheetData (§18.3.1.80)

Child Elements	Subclause
c (Cell)	§18.3.1.4
extLst (Future Feature Data Storage Area)	§18.2.10

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

� ISO/IEC29500: 2008.

Constructors

Row()	Initializes a new instance of the Row class.
Row(IEnumerable<OpenXmlElement>)	Initializes a new instance of the Row class with the specified child elements.
Row(OpenXmlElement[])	Initializes a new instance of the Row class with the specified child elements.
Row(String)	Initializes a new instance of the Row class from outer XML.

Properties

ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
Collapsed	Collapsed Represents the following attribute in the schema: collapsed
CustomFormat	Custom Format Represents the following attribute in the schema: customFormat
CustomHeight	Custom Height Represents the following attribute in the schema: customHeight
DyDescent	dyDescent, this property is only available in Office 2010 and later. Represents the following attribute in the schema: x14ac:dyDescent
ExtendedAttributes	Gets all extended attributes (attributes not defined in the schema) of the current element. (Inherited from OpenXmlElement)
Features	Gets a IFeatureCollection for the current element. This feature collection will be read-only, but will inherit features from its parent part and package if available. (Inherited from OpenXmlElement)
FirstChild	Gets the first child of the current OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
HasAttributes	Gets a value indicating whether the current element has any attributes. (Inherited from OpenXmlElement)
HasChildren	Gets a value that indicates whether the current element has any child elements. (Inherited from OpenXmlCompositeElement)
Height	Row Height Represents the following attribute in the schema: ht
Hidden	Hidden Represents the following attribute in the schema: hidden
InnerText	Gets or sets the concatenated values of the current node and all of its children. (Inherited from OpenXmlCompositeElement)
InnerXml	Gets or sets the markup that represents only the child nodes of the current node. (Inherited from OpenXmlCompositeElement)
LastChild	Gets the last child of the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
LocalName	Gets the local name of the current element. (Inherited from OpenXmlElement)
MCAttributes	Gets or sets the markup compatibility attributes. Returns null if no markup compatibility attributes are defined for the current element. (Inherited from OpenXmlElement)
NamespaceDeclarations	Gets all the namespace declarations defined in the current element. Returns an empty enumerator if there is no namespace declaration. (Inherited from OpenXmlElement)
NamespaceUri	Gets the namespace URI of the current element. (Inherited from OpenXmlElement)
OpenXmlElementContext	Gets the OpenXmlElementContext of the current element. (Inherited from OpenXmlElement)
OuterXml	Gets the markup that represents the current element and all of its child elements. (Inherited from OpenXmlElement)
OutlineLevel	Outline Level Represents the following attribute in the schema: outlineLevel
Parent	Gets the parent element of the current element. (Inherited from OpenXmlElement)
Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
RowIndex	Row Index Represents the following attribute in the schema: r
ShowPhonetic	Show Phonetic Represents the following attribute in the schema: ph
Spans	Spans Represents the following attribute in the schema: spans
StyleIndex	Style Index Represents the following attribute in the schema: s
ThickBot	Thick Bottom Represents the following attribute in the schema: thickBot
ThickTop	Thick Top Border Represents the following attribute in the schema: thickTop
XmlQualifiedName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)
XName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)

Methods

AddAnnotation(Object)	Adds an object to the current OpenXmlElement element's list of annotations. (Inherited from OpenXmlElement)
AddChild(OpenXmlElement, Boolean)	Adds the specified element to the element if it is a known child. This adds the element in the correct location according to the schema. (Inherited from OpenXmlCompositeElement)
AddNamespaceDeclaration(String, String)	Adds a namespace declaration to the current node. (Inherited from OpenXmlElement)
Ancestors()	Enumerates all of the current element's ancestors. (Inherited from OpenXmlElement)
Ancestors<T>()	Enumerates only the current element's ancestors that have the specified type. (Inherited from OpenXmlElement)
Annotation(Type)	Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotation<T>()	Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotations(Type)	Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotations<T>()	Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	Appends each element from a list of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement)
Append(OpenXmlElement[])	Appends each element from an array of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement)
AppendChild<T>(T)	Appends the specified element to the end of the current element's list of child nodes. (Inherited from OpenXmlCompositeElement)
ClearAllAttributes()	Clears all of the attributes, including both known attributes and extended attributes. (Inherited from OpenXmlElement)
Clone()	Creates a duplicate of the current node. (Inherited from OpenXmlElement)
CloneNode(Boolean)	Creates a duplicate of this node.
Descendants()	Enumerates all of the current element's descendants. (Inherited from OpenXmlElement)
Descendants<T>()	Enumerate all of the current element's descendants of type T. (Inherited from OpenXmlElement)
Elements()	Enumerates all of the current element's children. (Inherited from OpenXmlElement)
Elements<T>()	Enumerates only the current element's children that have the specified type. (Inherited from OpenXmlElement)
ElementsAfter()	Enumerates all of the sibling elements that follow the current element and have the same parent as the current element. (Inherited from OpenXmlElement)
ElementsBefore()	Enumerates all of the sibling elements that precede the current element and have the same parent as the current element. (Inherited from OpenXmlElement)
GetAttribute(String, String)	Gets an Open XML attribute with the specified tag name and namespace URI. (Inherited from OpenXmlElement)
GetAttributes()	Gets a list that contains a copy of all the attributes. (Inherited from OpenXmlElement)
GetEnumerator()	Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement)
GetFirstChild<T>()	Finds the first child element in type T. (Inherited from OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	Inserts the specified element immediately after the specified reference element. (Inherited from OpenXmlCompositeElement)
InsertAfterSelf<T>(T)	Inserts the specified element immediately after the current element. (Inherited from OpenXmlElement)
InsertAt<T>(T, Int32)	Inserts the specified element at the specified index of the current element's children. (Inherited from OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	Inserts the specified element immediately before the specified reference element. (Inherited from OpenXmlCompositeElement)
InsertBeforeSelf<T>(T)	Inserts the specified element immediately before the current element. (Inherited from OpenXmlElement)
IsAfter(OpenXmlElement)	Determines if the current element appears after a specified element in document order. (Inherited from OpenXmlElement)
IsBefore(OpenXmlElement)	Determines if the current element appears before a specified element in document order. (Inherited from OpenXmlElement)
LookupNamespace(String)	Resolves the namespace prefix in the context of the current node. (Inherited from OpenXmlElement)
LookupPrefix(String)	Finds the corresponding prefix for a namespace uri in the current element scope. (Inherited from OpenXmlElement)
NextSibling()	Gets the OpenXmlElement element that immediately follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement element. (Inherited from OpenXmlElement)
NextSibling<T>()	Gets the OpenXmlElement element with the specified type that follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement. (Inherited from OpenXmlElement)
PrependChild<T>(T)	Inserts the specified element at the beginning of the current element's list of child nodes. (Inherited from OpenXmlCompositeElement)
PreviousSibling()	Gets the OpenXmlElement element that immediately precedes the current OpenXmlElement element. Returns null (Nothing in Visual Basic ) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement)
PreviousSibling<T>()	Gets the OpenXmlElement element with the specified type that precedes the current OpenXmlElement. Returns null (Nothing in Visual Basic) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement)
Remove()	Removes the current element from its parent. (Inherited from OpenXmlElement)
RemoveAllChildren()	Removes all of the current element's child elements. (Inherited from OpenXmlCompositeElement)
RemoveAllChildren<T>()	Remove all of the current element's child elements that are of type T. (Inherited from OpenXmlElement)
RemoveAnnotations(Type)	Removes the annotations of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
RemoveAnnotations<T>()	Removes the annotations with the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
RemoveAttribute(String, String)	Removes the attribute from the current element. (Inherited from OpenXmlElement)
RemoveChild<T>(T)	Removes the specified child element. (Inherited from OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	Removes the namespace declaration for the specified prefix. Removes nothing if there is no prefix. (Inherited from OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	Replaces one of the current element's child elements with another OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
SetAttribute(OpenXmlAttribute)	Sets an attribute to the specified element. If the attribute is a known attribute, the value of the attribute is set. If the attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	Sets a number of attributes to the element. If an attribute is a known attribute, the value of the attribute is set. If an attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement)
WriteTo(XmlWriter)	Saves the current node to the specified XmlWriter. (Inherited from OpenXmlElement)

Explicit Interface Implementations

IEnumerable.GetEnumerator()	(Inherited from OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement)