AutoCaption.Caption Property

  • Reference

Definition

Namespace:
DocumentFormat.OpenXml.Wordprocessing
Assembly:
DocumentFormat.OpenXml.dll
Package:
DocumentFormat.OpenXml v2.10.0
Package:
DocumentFormat.OpenXml v2.10.1
Package:
DocumentFormat.OpenXml v2.11.0
Package:
DocumentFormat.OpenXml v2.11.1
Package:
DocumentFormat.OpenXml v2.11.2
Package:
DocumentFormat.OpenXml v2.11.3
Package:
DocumentFormat.OpenXml v2.12.0
Package:
DocumentFormat.OpenXml v2.12.1
Package:
DocumentFormat.OpenXml v2.12.2
Package:
DocumentFormat.OpenXml v2.12.3
Package:
DocumentFormat.OpenXml v2.13.0
Package:
DocumentFormat.OpenXml v2.13.1
Package:
DocumentFormat.OpenXml v2.14.0
Package:
DocumentFormat.OpenXml v2.15.0
Package:
DocumentFormat.OpenXml v2.16.0
Package:
DocumentFormat.OpenXml v2.17.1
Package:
DocumentFormat.OpenXml v2.18.0
Package:
DocumentFormat.OpenXml v2.19.0
Package:
DocumentFormat.OpenXml v2.20.0
Package:
DocumentFormat.OpenXml v2.7.1
Package:
DocumentFormat.OpenXml v2.7.2
Package:
DocumentFormat.OpenXml v2.8.0
Package:
DocumentFormat.OpenXml v2.8.1
Package:
DocumentFormat.OpenXml v2.9.0
Package:
DocumentFormat.OpenXml v2.9.1
Package:
DocumentFormat.OpenXml v3.0.0
Package:
DocumentFormat.OpenXml v3.0.1

Caption Used for Automatic Captioning

Represents the following attribute in the schema: w:caption

[DocumentFormat.OpenXml.SchemaAttr(23, "caption")]
public DocumentFormat.OpenXml.StringValue Caption { get; set; }
public DocumentFormat.OpenXml.StringValue Caption { get; set; }
[DocumentFormat.OpenXml.SchemaAttr(23, "caption")]
public DocumentFormat.OpenXml.StringValue? Caption { get; set; }
[DocumentFormat.OpenXml.SchemaAttr("w:caption")]
public DocumentFormat.OpenXml.StringValue? Caption { get; set; }
public DocumentFormat.OpenXml.StringValue? Caption { get; set; }
member this.Caption : DocumentFormat.OpenXml.StringValue with get, set
[<DocumentFormat.OpenXml.SchemaAttr(23, "caption")>]
member this.Caption : DocumentFormat.OpenXml.StringValue with get, set
[<DocumentFormat.OpenXml.SchemaAttr("w:caption")>]
member this.Caption : DocumentFormat.OpenXml.StringValue with get, set
Public Property Caption As StringValue

Property Value

StringValue

Returns StringValue.

Attributes
SchemaAttrAttribute

Remarks

The following information from the ECMA International Standard ECMA-376 can be useful when working with this class.

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

Consider the following WordprocessingML:

<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 will automatically be labeled with the caption whose name attribute is equal to Table (specified by the caption element's name attribute having a value of Table).

The possible values for this attribute are defined by the ST_String simple type.

Applies to