Sets the style of frame objects.

syntaxSyntax:
DlxFrameStyle.SetStyle(name)
DlxFrameStyle.SetStyle(handle)
DlxFrameStyle.SetStyle(style)
new DlxFrameStyle(pen, brush, shadow, numStyle, nameStyle, infoStyle)

Parameters

Parameter Description
name A string containing the name of the style.
handle A string containing the handle of the style.
style A DlxFrameStyle object from which to copy the style.
pen A DlxPenStyle object or a string containing the name or handle of the outline style.
brush A DlxBrushStyle object or a string containing the name or handle of the background style.
shadow A DlxShadowStyle object or a string containing the name or handle of the shadow style.
numStyle A DlxTextStyle object or a string containing the name or handle of the text style of the frame number.
nameStyle A DlxTextStyle object or a string containing the name or handle of the text style of the frame name.
infoStyle A DlxTextStyle object or a string containing the name or handle of the text style of the frame description.

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.

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 style = new DlxFrameStyle(DlxApp.STYLE_DEFAULT);
      doc.SetStyle(style);
      var rect = new DlxRect(50,40,120,90);
      layer.DrawFrame(rect, 1, "NAND", "The NAND gate."); 

      style.SetStyle(new DlxPenStyle(0.2, "blue"), "orange", "none", "Pin Text", "Pin Text", "Pin Text");
      doc.SetStyle(style);
      rect.Offset(100, 0);
      layer.DrawFrame(rect, 1, "NAND", "The NAND gate."); 
    }
  }
}

See also