Export (0) Print
Expand All

AutoCaption class

Single Automatic Captioning Setting. When the object is serialized out as xml, its qualified name is w:autoCaption.

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

public class AutoCaption : OpenXmlLeafElement

[ISO/IEC 29500-1 1st Edition]

autoCaption (Single Automatic Captioning Setting)

This element specifies what type(s) of objects shall automatically labelled with captions (§17.15.1.17), and with which captions the specified objects shall be labelled as defined in the caption element (§17.15.1.16).

[Example: Consider the diagram below illustrating a two page WordprocessingML document that has leveraged WordprocessingML to automatically label WordprocessingML tables with a specified caption when tables are inserted into the given document.

This type of automatic captioning is specified using the following WordprocessingML fragment:

<w:captions>
  <w:caption w:name="Table" w:pos="below" w:chapNum="1" w:heading="2" w:numFmt="upperLetter" w:sep="8212" />
  <w:autoCaptions>
    <w:autoCaption w:name="wfwTable" w:caption="Table" />
  </w:autoCaptions>
</w:captions>

Here, the autoCaption element specifies through the name attribute being set equal to wfwTable that tables are automatically be labeled with the caption specified in the caption element whose name attribute is equal to Table, as the caption element's caption attribute has a value of Table. end example]

Parent Elements

autoCaptions (§17.15.1.8)

Attributes

Description

caption (Caption Used for Automatic Captioning)

Specifies the caption defined in using the caption element (§17.15.1.16) which shall be used to automatically label a given type of object inserted in a WordprocessingML document. The caption settings are linked by matching the value of this attribute with the name attribute of the corresponding caption element.

[Example: Consider the WordprocessingML below

<w:captions>
  <w:caption w:name="table" w:pos="below" w:chapNum="1" w:heading="0" w:noLabel="1" w:numFmt="upperRoman" />
  <w:autoCaptions>
    <w:autoCaption w:name="Paint.Picture"      w:caption="table" />
  </w:autoCaptions>
</w:captions>

The autoCaption element specifies through the name attribute being set equal to wfwTable that tables are automatically be labeled with the caption whose name attribute is equal to Table (specified by the caption element's attribute name having a value of Table). end example]

The possible values for this attribute are defined by the ST_String simple type (§22.9.2.13).

name (Identifier of Object to be Automatically Captioned)

Specifies a unique identifier which can be used to associate objects inserted into the document which are to be automatically labeled with a caption when inserted into the WordprocessingML document.

[Example: Consider the WordprocessingML below specifying that WordprocessingML tables should be labeled with the custom caption:

  <w:autoCaption w:name="wfwTables" w:caption="custom" /> 

The name attribute value of wfwTables specifies that WordprocessingML tables must be labeled with the custom caption. 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_AutoCaption) is located in §A.1. end note]

© ISO/IEC29500: 2008.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2015 Microsoft