Share via


TableCaption Class

Defines the TableCaption Class.This class is only available in Office2010.When the object is serialized out as xml, its qualified name is w:tblCaption.

Inheritance Hierarchy

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

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

Syntax

'Declaration
<OfficeAvailabilityAttribute(FileFormatVersions.Office2010)> _
Public Class TableCaption _
    Inherits StringType
'Usage
Dim instance As TableCaption
[OfficeAvailabilityAttribute(FileFormatVersions.Office2010)]
public class TableCaption : StringType

Remarks

[ISO/IEC 29500-1 1st Edition]

17.4.41 tblCaption (Table Caption)

This element specifies the caption for the table.

[Example: Consider a table which specifies a caption. This object might contain the following XML markup:

<w:tbl>
    <w:tblPr>
        <w:tblCaption w:val="Here is the caption of the table" />
        …
    </w:tblPr>
</w:tbl>

end example]

Parent Elements

tblPr (§17.4.60); tblPr (§17.4.59); tblPr (§17.7.6.4); tblPr (§17.7.6.3)

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

TableCaption Members

DocumentFormat.OpenXml.Wordprocessing Namespace