Skip to main content
View as Markdown

IPCB_ViaStructure interface

No description yet.

public interface IPCB_ViaStructure

Namespace: PCB · Assembly: Altium.SDK.Interfaces

Properties​

PropertyTypeAccessDescription
CanEditFeatureboolget
CanEditMaterialboolget
CanEditSideboolget
FeatureIPCB_ViaStructureFeatureget
FeatureByTypeIPCB_ViaStructureFeatureget
FeaturesCountintget
FeaturesSideTViaStructureFeatureSideget; set
StructureTypeTViaStructureTypeget; set
vIndexForSaveintget; set

CanEditFeature​

No description yet.

bool GetState_CanEditFeature(TViaStructureFeatureType argType);

Type: bool · Access: read-only · Index: argType (TViaStructureFeatureType)

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

CanEditMaterial​

No description yet.

bool GetState_CanEditMaterial(TViaStructureFeatureType argType);

Type: bool · Access: read-only · Index: argType (TViaStructureFeatureType)

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

CanEditSide​

No description yet.

bool GetState_CanEditSide(TViaStructureFeatureType argType);

Type: bool · Access: read-only · Index: argType (TViaStructureFeatureType)

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

Feature​

No description yet.

IPCB_ViaStructureFeature GetState_Feature(int argIndex);

Type: IPCB_ViaStructureFeature · Access: read-only · Index: argIndex (int)

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

FeatureByType​

No description yet.

IPCB_ViaStructureFeature GetState_FeatureByType(TViaStructureFeatureType argType);

Type: IPCB_ViaStructureFeature · Access: read-only · Index: argType (TViaStructureFeatureType)

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

FeaturesCount​

No description yet.

int GetState_FeaturesCount();

Type: int · Access: read-only

FeaturesSide​

No description yet.

TViaStructureFeatureSide GetState_FeaturesSide();
void SetState_FeaturesSide(TViaStructureFeatureSide argValue);

Type: TViaStructureFeatureSide · Access: read/write

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

StructureType​

No description yet.

TViaStructureType GetState_StructureType();
void SetState_StructureType(TViaStructureType argValue);

Type: TViaStructureType · Access: read/write

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

vIndexForSave​

No description yet.

int GetState_vIndexForSave();
void SetState_vIndexForSave(int argIndex);

Type: int · Access: read/write

Methods​

MethodReturnsDescription
CopyTovoid
Deserializevoid
GetFeatureTypesTViaStructureFeatureTypeSet
IsEqualbool
ReplicateIPCB_ViaStructure
Serializestring

CopyTo​

No description yet.

void CopyTo(IPCB_ViaStructure argViaStructure);
void CopyTo(object argViaStructure);
ParameterTypePassing
argViaStructureIPCB_ViaStructurevalue

Returns: nothing (void)

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

Deserialize​

No description yet.

void Deserialize(string argData);
ParameterTypePassing
argDatastringvalue

Returns: nothing (void)

GetFeatureTypes​

No description yet.

TViaStructureFeatureTypeSet GetFeatureTypes();

Returns: TViaStructureFeatureTypeSet

Extension method of IPCB_ViaStructureHelper (using PCB;).

IsEqual​

No description yet.

bool IsEqual(IPCB_ViaStructure argViaStructure);
bool IsEqual(object argViaStructure);
ParameterTypePassing
argViaStructureIPCB_ViaStructurevalue

Returns: bool

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

Replicate​

No description yet.

IPCB_ViaStructure Replicate();

Returns: IPCB_ViaStructure

Extension method of IPCB_ViaStructureHelper (using PCB;).

Serialize​

No description yet.

string Serialize();

Returns: string

Returned by​

IPCB_ViaStructureManager.CreateViaStructure, IPCB_ViaStructureManager.Item, IPCB_ViaStructureManager.RegisterViaStructure, IPCB_ViaStructureSupport.GetViaStructureReplica, IPCB_ViaStructureSupport.ViaStructure, IPCB_ViaTemplate.ViaStructure

Accepted by​

IPCB_ViaStructureManager.RegisterViaStructure