ConnectString Class

  • Article

Data Source Connection String.When the object is serialized out as xml, its qualified name is w:connectString.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Wordprocessing.StringType
        DocumentFormat.OpenXml.Wordprocessing.ConnectString

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

Syntax

'Declaration
Public Class ConnectString _
    Inherits StringType
'Usage
Dim instance As ConnectString

public class ConnectString : StringType

Remarks

[ISO/IEC 29500-1 1st Edition]

17.14.8 connectString (Data Source Connection String)

This element specifies the connection string used to reconnect to an external data source. The string within this element's val attribute shall contain the connection string that the hosting application shall pass to a external data source access application to enable the WordprocessingML document to be reconnected to the specified external data source.

[Note: This string is generally comprised of a series of name/value pairs, delimited by semicolons, determined by the data source access application and the external data source that is accessed. end note]

If this string is omitted, then no legacy connection string shall be associated with this mail merge.

This connection string should be ignored under the following conditions:

  • The udl element (§17.14.34) is present within the mail merge data

  • The dataType element (§17.14.10) is set to native

  • The current application is able to use the information contained in the odso element (§17.14.25) to access the data source

[Guidance: In this case, using the connection string in the udl element provides an equal or greater amount of connection information for the mail merge data source for clients which support it. end guidance]

[Example: Consider a merged WordprocessingML document that has been connected to an external data source for the purposes of a mail merge. The following WordprocessingML fragment represents the legacy connection string used to connect to the external data source when the merged WordprocessingML document is reopened:

<w:connectString w:val="Provider=Example;Password=Test;User ID=readonly;…" />

The connectString element specifies that the string Provider=Example;Password=Test;User ID=readonly;… must be used to enable the given WordprocessingML document to be reconnected to the specified external data source. 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.

See Also

Reference

ConnectString Members

DocumentFormat.OpenXml.Wordprocessing Namespace