Keyword Index

Object: DWDocument

  • objType - Returns a string with the name of this object class "DWDocument".
  • readOnly - Returns true if the circuit is marked "read only". Note that this status primarily affects the user interface and does not prevent script methods from making changes to the circuit.
  • save - Saves the design associated with this circuit, as if the user had selected the Save command.
    •

    Property: objType

    Returns a string with the name of this object class "DWDocument".

    String = objType

    Property: readOnly

    Returns true if the circuit is marked "read only". Note that this status primarily affects the user interface and does not prevent script methods from making changes to the circuit.

    bool = readOnly

    Method: save

    Saves the design associated with this circuit, as if the user had selected the Save command.

    bool save();

    bool save(path);

    Parameters
    Name Expected Type Description
    path String The complete file path of the destination file to save the document to. If not provided, this method attempts to save back to the file the document was read from.

    Returns:

    Returns a boolean value true if the save succeeded, false if it failed or was cancelled by the user in response to a prompt.