MailSubject Class

Merged E-mail or Fax Subject Line.When the object is serialized out as xml, its qualified name is w:mailSubject.

Inheritance Hierarchy

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

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

Syntax

'Declaration
Public Class MailSubject _
    Inherits StringType
'Usage
Dim instance As MailSubject
public class MailSubject : StringType

Remarks

[ISO/IEC 29500-1 1st Edition]

17.14.21 mailSubject (Merged E-mail or Fax Subject Line)

This element specifies the text which shall appear in the subject line of the e-mails or faxes that result after the actions of a mail merge have imported external data into fields within a merged WordprocessingML document whose destination, as specified in the destination element (§17.14.21), is email or fax.

If this element is omitted, then no subject line text shall be associated with each merged document produced via a mail merge using the specified mail merge data. If the destination element (§17.14.11) specifies that the merged document destination is not email or fax, this element shall be ignored.

[Example: Consider a merged WordprocessingML document containing fields and the following WordprocessingML as part of its mail merge data:

<w:mailMerge>
…
<w:destination w:val="email" />
<w:mailSubject w:val="Example Subject Line" />
…
</w:mailMerge>

The mailSubject element specifies that after the specified external data has been imported into the specified fields in the merged document, each record merged must result in a single e-mail message, each with their subject line reading Example Subject Line. 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

MailSubject Members

DocumentFormat.OpenXml.Wordprocessing Namespace