CoatingMaterial Property (OccWdShieldWireEnd)

In This Topic

Gets or sets the coating material of this occurrence.

Syntax

public TextProperty CoatingMaterial {get; set;}

Exceptions

Exception	Description
EPLAN.Harness.API.Exceptions.HpdApiNotInitializedException	Api is not in an initialized state. You can get current state from EPLAN.Harness.API.HpdApi.Status property. If API is uninitialized, you can initialize it by calling EPLAN.Harness.API.HpdApi.Init method. If API is in failed state, you can not resurrect it.
EPLAN.Harness.API.Exceptions.ObjectInvalidException	The object is in invalid state. Obtain a new one.
EPLAN.Harness.API.Exceptions.OccurrenceDeletedException	The exception that is thrown when you trying to access to already deleted occurrence.
EPLAN.Harness.API.Exceptions.PropertyDoesNotExistException	Thrown when this property does not exist in this context.

Remarks

This property exists only if the associated cable sub-part is conductive and connected to a pin.

Example

This example shows how to set a new coating material for this occurrence.

// Obtain the occurrence before.
OccWsShieldEnd shieldEnd = ...

// Get all coating materials.
List<string> coatingMaterials = shieldEnd.GetAllCoatingMaterials();

// Find the desired coating material.
string coatingMaterial = coatingMaterials.FirstOrDefault(m => m == "Gold");

if(coatingMaterial == null)
{
	// Resolve this issue.
}

shieldEnd.CoatingMaterial = coatingMaterial;

Reference

OccWdShieldWireEnd Class
OccWdShieldWireEnd Members
TextProperty Class

Send Feedback