XmlColumnProperties Class

  • Article

XML Column Properties.When the object is serialized out as xml, its qualified name is x:xmlColumnPr.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlCompositeElement
      DocumentFormat.OpenXml.Spreadsheet.XmlColumnProperties

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

Syntax

'Declaration
<ChildElementInfoAttribute(GetType(ExtensionList))> _
Public Class XmlColumnProperties _
    Inherits OpenXmlCompositeElement
'Usage
Dim instance As XmlColumnProperties

[ChildElementInfoAttribute(typeof(ExtensionList))]
public class XmlColumnProperties : OpenXmlCompositeElement

Remarks

The following table lists the possible child types:

  • ExtensionList <x:extLst>

[ISO/IEC 29500-1 1st Edition]

18.5.1.7 xmlColumnPr (XML Column Properties)

An element defining the XML column properties for a column. This is only used for tables created from XML mappings.

[Example: Here is a simple example showing a table column that has an xmlColumPr.

<tableColumn id="1" uniqueName="SomeElement" name="SomeElement">
<xmlColumnPr mapId="1" xpath="/xml/foo/element" xmlDataType="string"/>
</tableColumn>

end example]

Parent Elements

tableColumn (§18.5.1.3)

Child Elements

Subclause

extLst (Future Feature Data Storage Area)

§18.2.10

Attributes

Description

denormalized (Denormalized)

A Boolean that indicates whether the contents of the column have been filled down due to flattening. True if it has been filled down (denormilized), false otherwise.

This should be used when an XML mapping parent value has many children, and both the parent and child fields are mapped to their own column in the table.

[Example:

<Order ID="3">
<Item>Milk</Item>
<Item>Bread</Item>
<Item>Cheese</Item>
</Order>

The resulting table in the spreadsheet application would have two columns, the first with the item ID, filled down for each item in the table as follows:

Item ID Item

3 Milk

3 Bread

3 Cheese

end example]

The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

mapId (XML Map Id)

An integer representing the ID of the XML map this table field is associated with.

The XML map is defined in the xml maps part, and the Map element should have the corresponding id.

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

xmlDataType (XML Data Type)

An enumeration indicating which XML data type is used by this column.

The possible values for this attribute are defined by the ST_XmlDataType simple type (§18.18.93).

xpath (XPath)

A string representing the XML path to the element this column is associated with.

The spreadsheet application should support XPath limited to the following

  • The XPath is an absolute path to a simple-content element or attribute

[Example:

"/ns1:root/ns1:row/ns1:column1" is supported if 'column1' is a child-most node, but not "/ns1:root/ns1:row" for the same document since 'row' is not a child.

end example]

  • The XPath does not express axes, but uses the default child axes

[Example:

"/ns1:root/ns1:row" is supported but not "/ns1:root/child::ns1:row

end example]

  • An optional filter can be expressed at the end of the xpath

[Example:

"/ns1:root/ns1:row/ns1:column1[@foo='abc']" is supported but not "/ns1:root/ns1:row[@foo='abc']/ns1:column1"

end example]

  • The filter can only contain a single expression comparing a named attribute to a specific value

  • Filters are only supported on XPaths that resolve to a simple-content element (not attributes)

  • The named attribute shall be defined as an attribute of the simple-content element

  • The attribute name shall be preceded by the short-hand (@) symbol representing the axes 'attribute'

[Example:

"/ns1:root/ns1:row/ns1:column1[@foo='abc']" is supported not "/ns1:root/ns1:row/ns1:column1[attribute::foo='abc']"

end example]

  • An arbitrary amount of white-space can be embedded between filter tokens

[Example:

"/ns1:root/ns1:row/ns1:column1[ @ foo='abc']" is permittedend example]

The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).

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

© ISO/IEC29500: 2008.

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

XmlColumnProperties Members

DocumentFormat.OpenXml.Spreadsheet Namespace