Query Class
Query For Data Source Records To Merge.When the object is serialized out as xml, its qualified name is w:query.
Inheritance Hierarchy
System.Object
DocumentFormat.OpenXml.OpenXmlElement
DocumentFormat.OpenXml.OpenXmlLeafElement
DocumentFormat.OpenXml.Wordprocessing.StringType
DocumentFormat.OpenXml.Wordprocessing.Query
Namespace: DocumentFormat.OpenXml.Wordprocessing
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)
Syntax
'Declaration
Public Class Query _
Inherits StringType
'Usage
Dim instance As Query
public class Query : StringType
Remarks
[ISO/IEC 29500-1 1st Edition]
17.14.26 query (Query For Data Source Records To Merge)
This element contains the Structured Query Language string (as defined by the normative reference in§3) that shall be run against the specified external data source to return the set of records from the external data which shall be imported into merged WordprocessingML documents when the mail merge operation is performed.
If this element is omitted, then no query shall be associated with the current data source.
[Example: Consider a WordprocessingML document that has been connected to an external database. In addition, consider that the data specifies that the table within the database titled Documentation shall be the specific table whose data is imported. This shall be specified in WordprocessingML as follows:
<w:query w:val="SELECT * FROM Documentation" />
The query element specifies the syntax for the data source query via its val attribute. end example]
Parent Elements |
|---|
mailMerge (§17.14.20) |
Attributes |
Description |
|---|---|
val (String Value) |
Specifies that its contents contain a string. The contents of this string are interpreted based on the context of the parent XML element. [Example: Consider the following WordprocessingML fragment: <w:pPr> <w:pStyle w:val="heading1" /> </w:pPr> The value of the val attribute is the ID of the associated paragraph style's styleId. However, consider the following fragment: <w:sdtPr> <w:alias w:val="SDT Title Example" /> … </w:sdtPr> In this case, the decimal number in the val attribute is the caption of the parent structured document tag. In each case, the value is interpreted in the context of the parent element. end example] The possible values for this attribute are defined by the ST_String simple type (§22.9.2.13). |
[Note: The W3C XML Schema definition of this element’s content model (CT_String) is located in §A.1. 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.