Sets the pen color.

syntaxSyntax:
DlxPenStyle.SetColor(color)
DlxPenStyle.SetColor(brush)
DlxPenStyle.SetColor(name)
DlxPenStyle.SetColor(handle)

Parameters

Parameter Description
color A DlxColor object that specifies the color for this pen.
brush A DlxBrushStyle object that specifies the color for this pen.
name A string containing the name of the color.
handle A string containing the handle of the color.

Return Value

If the operation ends correctly, it returns true otherwise it returns false.

Remarks

The style handle is a 27-character alphanumeric string and appears in the box at the bottom of the Style Manager dialog box. Additionally, you can use the ones listed below:

DlxApp.STYLE_NULL Transparent color. The pen is invisible.
DlxApp.STYLE_BYLAYER Use the color defined in the layer to which the object belongs.

Example

  Copy codeCopy code 
var prj = DlxApp.GetJob().GetProject("Example Sch");
if (!prj.IsValid())
  prj = DlxApp.GetJob().NewProject("Example Sch");
var doc = prj.GetDocument("Examples Sch", DlxApp.DOCTYPE_SCHEMATIC);
if (!doc.IsValid())
{
  doc = prj.NewDocument("Examples Sch", DlxApp.DOCTYPE_SCHEMATIC);
  doc.SetPageFormat("A4", false);
}
if (doc.IsValid() && doc.Activate())
{
  var page = doc.GetActivePage();
  if (page.IsValid())
  {
    var layer = page.GetLayerFromType(DlxApp.LAYERTYPE_DRAWING);
    if (layer.IsValid())
    {
      var pen = new DlxPenStyle(0.5, new DlxColor("orangered"), "DASHED");
      doc.SetStyle(pen);
      layer.DrawLine(new DlxPoint(30, 30), new DlxPoint(80, 80));
      pen.SetColor(new DlxColor("DarkCyan"));
      doc.SetStyle(pen);
      layer.DrawLine(new DlxPoint(40, 30), new DlxPoint(90, 80));
    }
  }
}

See also