To set the page property flags.

syntaxSyntax:
DlxPage.SetFlags(flags, mask)

Parameters

Parameter Description
flags Specifies values for page property flags. Specify a combination of the values in the following table.
mask Specifies which flags are to be set. Specify a combination of the values in the following table.
Value Meaning
DlxApp.PAGEFLAGS_SINGLECOMPONENT Enable this option to indicate that all the symbols defined on the page represent a single component. You can dedicate an entire page to a single component by bringing together in it all the symbols that represent it. In this case, the name of the symbol is the name of the page.
DlxApp.PAGEFLAGS_IGNORETHISPAGE Enable this option to exclude the page from a library or schematic.
DlxApp.PAGEFLAGS_CONTINUEFROMPREVIOUS Use this option to merge two or more pages. Symbols are shown on the same page as the library bar.
DlxApp.PAGEFLAGS_IPCFOOTPRINT Enable this option if the page defines the footprints corresponding to the three levels of PCB classification based on component density. See Drawing a three-level footprint.

Return Value

If the page flags have been changed it returns true otherwise it returns false.

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())
{
  var page = doc.GetActivePage();
  page.SetFlags(DlxApp.PAGEFLAGS_IGNORETHISPAGE, DlxApp.PAGEFLAGS_IGNORETHISPAGE);
}

See also