AddLabel Method

  • Article

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.  

Adds a new Shape object representing a text label to the specified Shapes collection.

expression.AddLabel(Orientation, Left, Top, Width, Height)

expression   Required. An expression that returns one of the objects in the Applies To list.

PbTextOrientation

PbTextOrientation can be one of these PbTextOrientation constants.
pbTextOrientationHorizontal  A horizontal text label for left-to-right languages.
pbTextOrientationMixed  Not used for this method.
pbTextOrientationRightToLeft  A horizontal text label for right-to-left languages.
pbTextOrientationVerticalEastAsia  A vertical text label for East Asian languages.

Left  Required Variant. The position of the left edge of the shape representing the text label.

Top  Required Variant. The position of the top edge of the shape representing the text label.

Width  Required Variant. The width of the shape representing the text label.

Height  Required Variant. The height of the shape representing the text label.

Remarks

For the Left, Top, Width, and Height arguments, numeric values are evaluated in points; strings can be in any units supported by Microsoft Publisher (for example, "2.5 in").

Example

The following example adds a new horizontal text label to the first page of the active publication.

  Dim shpLabel As Shape

Set shpLabel = ActiveDocument.Pages(1).Shapes.AddLabel _
    (Orientation:=pbTextOrientationHorizontal, _
    Left:=144, Top:=144, _
    Width:=72, Height:=18)