Range.InsertCaption Method

  • Article
Word Developer Reference

Inserts a caption immediately preceding or following the specified range.

Syntax

expression.InsertCaption(Label, Title, TitleAutoText, Position, ExcludeLabel)

expression   Required. A variable that represents a Range object.

Parameters

Name Required/Optional Data Type Description
Label Required Variant The caption label to be inserted. Can be a String or one of the WdCaptionLabelID constants. If the label has not yet been defined, an error occurs. Use the Add method with the CaptionLabels object to define new caption labels.
Title Optional Variant The string to be inserted immediately following the label in the caption (ignored if TitleAutoText is specified).
TitleAutoText Optional Variant The AutoText entry whose contents you want to insert immediately following the label in the caption (overrides any text specified by Title).
Position Optional Variant Specifies whether the caption will be inserted above or below the range. Can be either one of the WdCaptionPosition constants.
ExcludeLabel Optional Variant True does not include the text label, as defined in the Label parameter. False includes the specified label.

Remarks

Example

This example inserts a caption below the first table in the active document.

Visual Basic for Applications 
  ActiveDocument.Tables(1).Range.InsertCaption _
    Label:=wdCaptionTable, _
    Position:=wdCaptionPositionBelow

See Also