Returns the page format.

syntaxSyntax:
DlxGraphixDocument.GetPageFormat()

Return Value

If the document is open, this function returns a string with the name of the page format. If the document is closed, an empty string is returned.

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())
{
  DlxApp.Printf("%s : Format=%s Width=%.1fmm Height=%.1fmm.", doc.GetName(), doc.GetPageFormat(), doc.GetPageWidth(), doc.GetPageHeight());
}

See also