QueryTable Class

Definition

Namespace:

DocumentFormat.OpenXml.Spreadsheet

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Query Table.

This class is available in Office 2007 and above.

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

public class QueryTable : DocumentFormat.OpenXml.OpenXmlPartRootElement

type QueryTable = class
    inherit OpenXmlPartRootElement

Public Class QueryTable
Inherits OpenXmlPartRootElement

Inheritance

Object

OpenXmlElement

OpenXmlCompositeElement

OpenXmlPartRootElement

QueryTable

Remarks

[ISO/IEC 29500-1 1st Edition]

queryTable (Query Table)

This element specifies all the relevant properties for a query table, one query table element is stored for each query table object in the spreadsheetML document.

Parent Elements
Root element of SpreadsheetML Query Table part

Child Elements	Subclause
extLst (Future Feature Data Storage Area)	§18.2.10
queryTableRefresh (QueryTable Refresh Information)	§18.12.6

Attributes	Description
adjustColumnWidth (Adjust Column Width On Refresh)	Specifies whether to automatically adjust column widths on refresh to fit the data retrieved. true if column widths should be adjusted. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
applyAlignmentFormats (Apply Alignment Formats)	If true apply legacy table autoformat alignment properties. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
applyBorderFormats (Apply Border Formats)	If true apply legacy table autoformat border properties. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
applyFontFormats (Apply Font Formats)	If true apply legacy table autoformat font properties. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
applyNumberFormats (Apply Number Formats)	If true apply legacy table autoformat number format properties. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
applyPatternFormats (Apply Pattern Formats)	If true apply legacy table autoformat pattern properties. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
applyWidthHeightFormats (Apply Width / Height Formats)	If true apply legacy table autoformat width/height properties. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
autoFormatId (Auto Format Id)	Identifies which legacy table autoformat to apply. Annex D contains a listing of the supported PivotTable AutoFormats, example formatting, and a sample workbook with each of those AutoFormats applied. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.
backgroundRefresh (Background Refresh)	Specifies whether or not the query table shall try to refresh data in the background. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
connectionId (Connection Id)	Specifies the ID number of the external data connection to use to refresh data in the query table. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.
disableEdit (Disable Edit)	Specifies whether the connection element used with this query table shall be editable. If true, then the connection is not editable. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
disableRefresh (Disable Refresh)	Specifies whether the query table shall be refreshable. If true, then then query table is not refreshable. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
fillFormulas (Fill Adjacent Formulas)	Specifies whether or not formulas in columns adjacent to the query table should be filled down whenever the query table is refreshed. This is helpful since the number of rows returned by a query table refresh operation can vary. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
firstBackgroundRefresh (First Background Refresh)	Specifies whether or not data has ever been refreshed for this query table. If the very first background data refresh had not completed at the time the file was saved, this attribute is set to true. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
growShrinkType (Grow Shrink Type)	Specifies the type of behavior expected for dealing with a variable number of rows of data in the query table between refresh operations. The meaning of the possible values of this attribute {insertClear, insertDelete, overwriteClear} are explained in detail in the definition of the simple type. The possible values for this attribute are defined by the ST_GrowShrinkType simple type (§18.18.39).
headers (First Row Column Titles)	Specifies whether or not the query table has first row with column titles. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
intermediate (Intermediate)	Specifies whether this query table is in an intermediate state, having been defined but not fully formed and populated with data. In this state, fields and ranges of the query table can be unknown. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
name (QueryTable Name)	Specifies the name of the query table. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19).
preserveFormatting (Preserve Formatting On Refresh)	Specifies whether the application should try to preserve formatting in the query table and copy this formatting to any new rows of data. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
refreshOnLoad (Refresh On Load)	Specifies whether the query table shall refresh its data automatically when the spreadsheetML document is loaded or opened. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
removeDataOnSave (Remove Data On Save)	Specifies whether the query table shall remove all data from the worksheet before the spreadsheetML document is saved. This is very helpful for situations where people who have different permissions to view data want to share the same spreadsheetML document. All data from the last user is removed, and new users re-query the external data sources with their own credentials. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.
rowNumbers (Row Numbers)	Specifies whether the query table shall include a first column of row numbers. The possible values for this attribute are defined by the W3C XML Schema boolean datatype.

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

� ISO/IEC29500: 2008.

Constructors

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

Properties

AdjustColumnWidth	adjustColumnWidth Represents the following attribute in the schema: adjustColumnWidth
ApplyAlignmentFormats	Apply Alignment Formats Represents the following attribute in the schema: applyAlignmentFormats
ApplyBorderFormats	Apply Border Formats Represents the following attribute in the schema: applyBorderFormats
ApplyFontFormats	Apply Font Formats Represents the following attribute in the schema: applyFontFormats
ApplyNumberFormats	Apply Number Formats Represents the following attribute in the schema: applyNumberFormats
ApplyPatternFormats	Apply Pattern Formats Represents the following attribute in the schema: applyPatternFormats
ApplyWidthHeightFormats	Apply Width / Height Formats Represents the following attribute in the schema: applyWidthHeightFormats
AutoFormatId	Auto Format Id Represents the following attribute in the schema: autoFormatId
BackgroundRefresh	backgroundRefresh Represents the following attribute in the schema: backgroundRefresh
ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
ConnectionId	connectionId Represents the following attribute in the schema: connectionId
DisableEdit	disableEdit Represents the following attribute in the schema: disableEdit
DisableRefresh	disableRefresh Represents the following attribute in the schema: disableRefresh
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)
FillFormulas	fillFormulas Represents the following attribute in the schema: fillFormulas
FirstBackgroundRefresh	firstBackgroundRefresh Represents the following attribute in the schema: firstBackgroundRefresh
FirstChild	Gets the first child of the current OpenXmlElement element. (Inherited from OpenXmlCompositeElement)
GrowShrinkType	growShrinkType Represents the following attribute in the schema: growShrinkType
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)
Headers	headers Represents the following attribute in the schema: headers
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)
Intermediate	intermediate Represents the following attribute in the schema: intermediate
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)
Name	name Represents the following attribute in the schema: name
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)
OpenXmlPart	Gets the part that is associated with the DOM tree. It returns null when the DOM tree is not associated with a part. (Inherited from OpenXmlPartRootElement)
OuterXml	Gets the markup that represents the current element and all of its child elements. (Inherited from OpenXmlElement)
Parent	Gets the parent element of the current element. (Inherited from OpenXmlElement)
Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
PreserveFormatting	preserveFormatting Represents the following attribute in the schema: preserveFormatting
QueryTableExtensionList	QueryTableExtensionList. Represents the following element tag in the schema: x:extLst.
QueryTablePart	Gets the QueryTablePart associated with this element.
QueryTableRefresh	QueryTableRefresh. Represents the following element tag in the schema: x:queryTableRefresh.
RefreshOnLoad	refreshOnLoad Represents the following attribute in the schema: refreshOnLoad
RemoveDataOnSave	removeDataOnSave Represents the following attribute in the schema: removeDataOnSave
RowNumbers	rowNumbers Represents the following attribute in the schema: rowNumbers
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)
Load(QueryTablePart)	Loads the DOM from the QueryTablePart
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)
Reload()	Reloads the part content into an Open XML DOM tree. This method can be called multiple times and each time it is called, the tree will be reloaded and previous changes on the tree are abandoned. (Inherited from OpenXmlPartRootElement)
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)
Save()	Saves the data in the DOM tree back to the part. This method can be called multiple times and each time it is called, the stream will be flushed. (Inherited from OpenXmlPartRootElement)
Save(QueryTablePart)	Saves the DOM into the QueryTablePart.
Save(Stream)	Saves the DOM tree to the specified stream. (Inherited from OpenXmlPartRootElement)
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 OpenXmlPartRootElement)

Explicit Interface Implementations

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