INavigationSystem interface
The navigation system is the workhouse for the Navigation panel which is the center-piece for net connectivity for the design project. There are three ways a design can be arranged - as a list of compiled sheets, flattened hierarchy and as a structural tree.
public interface INavigationSystem
Namespace: DXP · Assembly: Altium.SDK.Interfaces
Methods
| Method | Returns | Description |
|---|---|---|
| DisableHistory | void | |
| EnableHistory | void | |
| ExpandTargets | void | |
| IsHistoryEnabled | bool | |
| NavigateTo | bool | |
| NavigateToScene | bool | |
| ParseDestinationString | void | |
| RegisterNavigationProvider | UIntPtr | |
| UnregisterNavigationProtocol | void | |
| ValidatedTarget | string |
DisableHistory
No description yet.
void DisableHistory();
Returns: nothing (void)
EnableHistory
No description yet.
void EnableHistory();
Returns: nothing (void)
ExpandTargets
No description yet.
void ExpandTargets(ref string argTarget);
| Parameter | Type | Passing |
|---|---|---|
argTarget | string | ref |
Returns: nothing (void)
IsHistoryEnabled
No description yet.
bool IsHistoryEnabled();
Returns: bool
NavigateTo
No description yet.
bool NavigateTo(IExternalForm argCurrentView, ref string argDestination, out IExternalForm argTargetView);
bool NavigateTo(object argCurrentView, ref string argDestination, out IExternalForm argTargetView);
| Parameter | Type | Passing |
|---|---|---|
argCurrentView | IExternalForm | value |
argDestination | string | ref |
argTargetView | IExternalForm | out |
Returns: bool
The first overload is an extension method of INavigationSystemHelper (using DXP;) with typed parameters; the second is declared by the interface.
NavigateToScene
No description yet.
bool NavigateToScene(IExternalForm argCurrentView, ref string argDestination, out IExternalForm argTargetView, out IExternalForm argTargetHeaderView);
bool NavigateToScene(object argCurrentView, ref string argDestination, out IExternalForm argTargetView, out IExternalForm argTargetHeaderView);
| Parameter | Type | Passing |
|---|---|---|
argCurrentView | IExternalForm | value |
argDestination | string | ref |
argTargetView | IExternalForm | out |
argTargetHeaderView | IExternalForm | out |
Returns: bool
The first overload is an extension method of INavigationSystemHelper (using DXP;) with typed parameters; the second is declared by the interface.
ParseDestinationString
No description yet.
void ParseDestinationString(string argDestination, ref string argProtocol, ref string argTarget, ref string argParameters);
| Parameter | Type | Passing |
|---|---|---|
argDestination | string | value |
argProtocol | string | ref |
argTarget | string | ref |
argParameters | string | ref |
Returns: nothing (void)
RegisterNavigationProvider
No description yet.
UIntPtr RegisterNavigationProvider(string argProtocolName, INavigationProvider argNavigationProvider);
| Parameter | Type | Passing |
|---|---|---|
argProtocolName | string | value |
argNavigationProvider | INavigationProvider | value |
Returns: UIntPtr
Extension method of INavigationSystemHelper (using DXP;).
UnregisterNavigationProtocol
No description yet.
void UnregisterNavigationProtocol(string argProtocol, UIntPtr argHandle);
void UnregisterNavigationProtocol(string argProtocol, object argHandle);
| Parameter | Type | Passing |
|---|---|---|
argProtocol | string | value |
argHandle | UIntPtr | value |
Returns: nothing (void)
The first overload is an extension method of INavigationSystemHelper (using DXP;) with typed parameters; the second is declared by the interface.
ValidatedTarget
No description yet.
string ValidatedTarget(string argTarget);
| Parameter | Type | Passing |
|---|---|---|
argTarget | string | value |
Returns: string