GetLinksByLabelTemplate Method (ActiveX/CAO)

Gets a Links collection containing the label links associated with the specified label template.

Signature

VBA / VB.NET 

RetVal = object.GetLinksByLabelTemplate(LabelTemplate, [, LinkTypes] [, Document])
object

Type: DbConnect

The object or objects this method applies to.

LabelTemplate

Type: LabelTemplate, or String identifying a label template; input-only

Specifies the label template whose links are returned.

LinkTypes

Type: Integer; input-only; optional

Specifies the type of links to return. You can specify any combination of the following link types:

  • kFSLabelType: Freestanding labels
  • kAttachedLabelType: Attached labels

If no value is specified, all label links are returned.

Document

Type: AcadDocument; input-only; optional

This argument is ignored if a LabelTemplate Object is passed as the first argument. If this argument is not specified, the document object is identified as follows:

  • If the LabelTemplate argument is a string naming a label template, the current document is used.
  • If the LabelTemplate argument is a LabelTemplate object, the label template document is used.
RetVal

Type: Links

The Links collection meeting the specified conditions.

Related Reference