DesignComponents Method (Application Object)

Scope: Schematic editor

Object: Application Object

Prerequisites: None

Builds a collection of component objects for a schematic or an entire design.

Usage

Application.DesignComponents(ByVal Library As String, ByVal Name As String, [ByVal EndSheet As String], [ByVal LevelString As String], [ByVal RecurseDown As Boolean = True]) As IVdObjs

Arguments

Library

Specific library to search. This argument may be empty. When empty, the schematic editor will look through the entire search order.

Name

Name of the design that contains the components to be collected.

EndSheet

(Optional) Specifies the name of the last sheet for which objects are to be collected. A value of “-1” (default) indicates that all sheets be included.

LevelString

(Optional) This argument is a space delimited string that specifies the levels at which to stop loading anything other than primitives. For example, STD VHDL would stop at the primitive, on the STD and VHDL levels of the hierarchy. This argument is ignored if RecurseDown is False.

RecurseDown

(Optional) Indicates whether or not to traverse down the hierarchy. If RecurseDown is True then the Levels string is tested against each component instance before traversing down. If the flag is False then only sheets at the same level of hierarchy are traversed.

True (default) - Traverse into the hierarchy. False - Do not traverse into the hierarchy.

Return Values

As IVdObjs. The collection of Component Objects.

Description

You can get all components in the hierarchy or simply all components at the same level of the hierarchy by setting the RecurseDown flag. If there are multiple paths to a schematic, the components on the schematic will be in the collection multiple times.