QueryTableField Class

QueryTable Field.When the object is serialized out as xml, its qualified name is x:queryTableField.

Inheritance Hierarchy

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

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

Syntax

'Declaration
<ChildElementInfoAttribute(GetType(ExtensionList))> _
Public Class QueryTableField _
    Inherits OpenXmlCompositeElement
'Usage
Dim instance As QueryTableField
[ChildElementInfoAttribute(typeof(ExtensionList))]
public class QueryTableField : OpenXmlCompositeElement

Remarks

The following table lists the possible child types:

  • ExtensionList <x:extLst>

[ISO/IEC 29500-1 1st Edition]

18.12.4 queryTableField (QueryTable Field)

This element holds the properties related to a specific field or column in a query table.

Parent Elements

queryTableFields (§18.12.5)

Child Elements

Subclause

extLst (Future Feature Data Storage Area)

§18.2.10

Attributes

Description

clipped (Clipped Column)

Specifies whether this field/column is currently clipped and thus not visible in the worksheet.

[Note: this state might occur for example when a query table is defined near the edge of a worksheet or other object in the spreadsheet that can't be overwritten with external data. In this case some of the fields are displayed, but not all of them. end note]

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

dataBound (Data Bound Column)

Specifies whether this column is a user-defined column or comes from the external data query. User defined columns shall be preserved during data refresh operations. User-defined columns are only supported on query tables that are attached to table objects.

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

fillFormulas (Fill This Formula On Refresh)

Specifies whether the formula in this field/column should be filled down on data refresh.

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

id (Field Id)

Specifies the unique identifier of the query table field.

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

name (Name)

Specifies the unique name of the query table field.

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

rowNumbers (Row Numbers)

true if this column contains the row numbers for the records returned.

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

tableColumnId (Table Column Id)

Specifies the unique identifier for the table column if the query table is attached to a table object rather than just a range in the sheet.

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

[Note: The W3C XML Schema definition of this element’s content model (CT_QueryTableField) 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

QueryTableField Members

DocumentFormat.OpenXml.Spreadsheet Namespace