GetLinksByLabelTemplate [Connectivity Automation Reference: CAR]

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

See Also

Signature

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

Object

DbConnect The object or objects this method applies to.

LabelTemplate

LabelTemplate object, or a string identifying a label template; input-only
Specifies the label template whose links are returned.

LinkTypes

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

Document object; 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

Links collection;
The Links collection meeting the specified conditions.