IPCB_BoardEx interface

No description yet.

public interface IPCB_BoardEx

Namespace: PCB · Assembly: Altium.SDK.Interfaces

Properties

Property	Type	Access	Description
BoardRegionManager	IPCB_BoardRegionsManager	get
FullComponents	IPCB_FullComponents	get
GridManager	IPCB_GridManager	get
Navigate_HighlightObjectListEx	bool	set
SingleLayer	V7_LayerBase	get
StateId	uint	get
ViaManager	IPCB_ViaManager	get
ViaStructureManager	IPCB_ViaStructureManager	get

BoardRegionManager

No description yet.

IPCB_BoardRegionsManager GetState_BoardRegionManager();

Type: IPCB_BoardRegionsManager · Access: read-only

The accessors are extension methods of IPCB_BoardExHelper (using PCB;).

FullComponents

No description yet.

IPCB_FullComponents GetState_FullComponents();

Type: IPCB_FullComponents · Access: read-only

The accessors are extension methods of IPCB_BoardExHelper (using PCB;).

GridManager

No description yet.

IPCB_GridManager GetState_GridManager();

Type: IPCB_GridManager · Access: read-only

The accessors are extension methods of IPCB_BoardExHelper (using PCB;).

Navigate_HighlightObjectListEx

No description yet.

void SetState_Navigate_HighlightObjectListEx(THighlightMethodSet argHighlightMethods, bool argClearExisting, bool argHighBoardOutline, bool argClearExistingHighlights, bool argFullUpdate);

Type: bool · Access: write-only · Index: argHighlightMethods (THighlightMethodSet), argClearExisting (bool), argHighBoardOutline (bool), argClearExistingHighlights (bool)

The accessors are extension methods of IPCB_BoardExHelper (using PCB;).

SingleLayer

No description yet.

V7_LayerBase GetState_SingleLayer();

Type: V7_LayerBase · Access: read-only

The accessors are extension methods of IPCB_BoardExHelper (using PCB;).

StateId

No description yet.

uint GetState_StateId();

Type: uint · Access: read-only

ViaManager

No description yet.

IPCB_ViaManager GetState_ViaManager();

Type: IPCB_ViaManager · Access: read-only

The accessors are extension methods of IPCB_BoardExHelper (using PCB;).

ViaStructureManager

No description yet.

IPCB_ViaStructureManager GetState_ViaStructureManager();

Type: IPCB_ViaStructureManager · Access: read-only

The accessors are extension methods of IPCB_BoardExHelper (using PCB;).

Methods

Method	Returns	Description
AddMeshToLayer	int
AddPolygonMeshToLayer	int
BeginReadOnlyMode	bool
Drillmanager_GetDrillSymbolIndex	int
EndReadOnlyMode	bool
GetExpressionManager	IPCB_ExpressionManager
GetSignalDelayForPrim	double
GetSignalDelayPerMeter	double
GetViewConfigurationByTypeAsString	bool
GetVoidsOnPlaneLayer	IPCB_Polygon
IsPlaneLayerIsPoured	bool
IsReadOnly	bool
LoadFromASCIIFile	void
LoadFromJSONFile	void
LoadFromPCBFile	void
LoadFromPCBLibraryFile	void
PlaceViaStructureFeaturesGeometry	void
RemoveViaStructureFeaturesGeometry	void
RenderToPNG	int
ResetDelaysCalculator	void
SaveToASCIIFile	void
SaveToJSONFile	void
SaveToPCBFile	void
SaveToPCBLibraryFile	void

AddMeshToLayer

No description yet.

int AddMeshToLayer(string argMeshString, V7_LayerBase argLayer);
int AddMeshToLayer(string argMeshString, IV7_Layer argLayer);

Parameter	Type	Passing
argMeshString	string	value
argLayer	V7_LayerBase	value

Returns: int

The first overload is an extension method of IPCB_BoardExHelper (using PCB;) with typed parameters; the second is declared by the interface.

AddPolygonMeshToLayer

No description yet.

int AddPolygonMeshToLayer(IPCB_Contour argShape, int argz, uint argColor, V7_LayerBase argLayer);
int AddPolygonMeshToLayer(object argShape, int argz, uint argColor, IV7_Layer argLayer);

Parameter	Type	Passing
argShape	IPCB_Contour	value
argz	int	value
argColor	uint	value
argLayer	V7_LayerBase	value

Returns: int

The first overload is an extension method of IPCB_BoardExHelper (using PCB;) with typed parameters; the second is declared by the interface.

BeginReadOnlyMode

No description yet.

bool BeginReadOnlyMode();

Returns: bool

Drillmanager_GetDrillSymbolIndex

No description yet.

int Drillmanager_GetDrillSymbolIndex(IPCB_Primitive argPrimitive);
int Drillmanager_GetDrillSymbolIndex(object argPrimitive);

Parameter	Type	Passing
argPrimitive	IPCB_Primitive	value

Returns: int

The first overload is an extension method of IPCB_BoardExHelper (using PCB;) with typed parameters; the second is declared by the interface.

EndReadOnlyMode

No description yet.

bool EndReadOnlyMode();

Returns: bool

GetExpressionManager

No description yet.

IPCB_ExpressionManager GetExpressionManager();

Returns: IPCB_ExpressionManager

Extension method of IPCB_BoardExHelper (using PCB;).

GetSignalDelayForPrim

No description yet.

double GetSignalDelayForPrim(IPCB_Primitive argPrimitive);
double GetSignalDelayForPrim(object argPrimitive);

Parameter	Type	Passing
argPrimitive	IPCB_Primitive	value

Returns: double

The first overload is an extension method of IPCB_BoardExHelper (using PCB;) with typed parameters; the second is declared by the interface.

GetSignalDelayPerMeter

No description yet.

double GetSignalDelayPerMeter(IPCB_Primitive argPrimitive);
double GetSignalDelayPerMeter(object argPrimitive);

Parameter	Type	Passing
argPrimitive	IPCB_Primitive	value

Returns: double

The first overload is an extension method of IPCB_BoardExHelper (using PCB;) with typed parameters; the second is declared by the interface.

GetViewConfigurationByTypeAsString

No description yet.

bool GetViewConfigurationByTypeAsString(string argType, out string argConfig);

Parameter	Type	Passing
argType	string	value
argConfig	string	out

Returns: bool

GetVoidsOnPlaneLayer

No description yet.

IPCB_Polygon GetVoidsOnPlaneLayer(V7_LayerBase argLayer);

Parameter	Type	Passing
argLayer	V7_LayerBase	value

Returns: IPCB_Polygon

Extension method of IPCB_BoardExHelper (using PCB;).

IsPlaneLayerIsPoured

No description yet.

bool IsPlaneLayerIsPoured(V7_LayerBase argLayer);
bool IsPlaneLayerIsPoured(IV7_Layer argLayer);

Parameter	Type	Passing
argLayer	V7_LayerBase	value

Returns: bool

The first overload is an extension method of IPCB_BoardExHelper (using PCB;) with typed parameters; the second is declared by the interface.

IsReadOnly

No description yet.

bool IsReadOnly();

Returns: bool

LoadFromASCIIFile

No description yet.

void LoadFromASCIIFile(string argFilename);

Parameter	Type	Passing
argFilename	string	value

Returns: nothing (void)

LoadFromJSONFile

No description yet.

void LoadFromJSONFile(string argFilename);

Parameter	Type	Passing
argFilename	string	value

Returns: nothing (void)

LoadFromPCBFile

No description yet.

void LoadFromPCBFile(string argFilename);

Parameter	Type	Passing
argFilename	string	value

Returns: nothing (void)

LoadFromPCBLibraryFile

No description yet.

void LoadFromPCBLibraryFile(string argFilename, bool argrrangeComponents);

Parameter	Type	Passing
argFilename	string	value
argrrangeComponents	bool	value

Returns: nothing (void)

PlaceViaStructureFeaturesGeometry

No description yet.

void PlaceViaStructureFeaturesGeometry();

Returns: nothing (void)

RemoveViaStructureFeaturesGeometry

No description yet.

void RemoveViaStructureFeaturesGeometry();

Returns: nothing (void)

RenderToPNG

No description yet.

int RenderToPNG(string argOutputFileName, int argDPI, bool argtop, string argConfigType, string argConfig);

Parameter	Type	Passing
argOutputFileName	string	value
argDPI	int	value
argtop	bool	value
argConfigType	string	value
argConfig	string	value

Returns: int

ResetDelaysCalculator

No description yet.

void ResetDelaysCalculator();

Returns: nothing (void)

SaveToASCIIFile

No description yet.

void SaveToASCIIFile(string argFilename);

Parameter	Type	Passing
argFilename	string	value

Returns: nothing (void)

SaveToJSONFile

No description yet.

void SaveToJSONFile(string argFilename);

Parameter	Type	Passing
argFilename	string	value

Returns: nothing (void)

SaveToPCBFile

No description yet.

void SaveToPCBFile(string argFilename);

Parameter	Type	Passing
argFilename	string	value

Returns: nothing (void)

SaveToPCBLibraryFile

No description yet.

void SaveToPCBLibraryFile(string argFilename);

Parameter	Type	Passing
argFilename	string	value

Returns: nothing (void)