Scope: Schematic editor
Object: Application Object
Prerequisites: None
Opens a schematic sheet by pushing through the components of a path.
Application.PushPath(ByVal Top As String, ByVal HierPath As String, ByVal SheetNumber As String) As Boolean
Name of the schematic that is the top of the design. This argument is a string with a specific format, resembling a path specification:
[library_name:]sch\name.sheetnumberlibrary_name is the (optional) alias assigned to the library containing this object. sch\ specifies that the sheet is a schematic. name.sheetnumber is the name and sheet number of the schematic.For example:
My_comps:sch\foo.1In C++, you must escape the \ character as \\.
Hierarchical path specification. Defines the path from the top-level schematic, specified by the top argument, to the target schematic. It's a sequence of UIDs separated by the \ character. The schematic representing the final component is opened by pushing along the path specified by the other components. An example path could be $1I2\$1I1\$1I1 (or "$1I2\\$1I1\\$1I1" in C++).
Contains either the sheet name or the actual sheet number of interest. For example, in a schematic sheet, "Schematic1.cpu", the SheetNumber argument would be "cpu". A SheetNumber value of “-1” indicates that the application open the default sheet.
As Boolean. True - the path was found and the schematic opened (success). False - the path could not be found and/or the schematic could not be opened (failure).
The schematic is opened based on its relationship to the top of the design. Only the target schematic is opened, not all the schematics along the path.