JavaScript Class Structure for Design Data

These pages provide reference documentation on the JavaScript classes used to support access to objects and information in designs.

WARNING & DISCLAIMER!

These classes are available for your use but they are NOT SUPPORTED by our technical support staff and we cannot provide no charge assistance for their use. In addition we do not guarantee the correctness or safety of these classes as they were designed for a specific purpose and have not been tested for general use. It is very likely that usage of these classes could result in program crashes or loss of data!

Classes and Data Types

• any - Built in type
• array - Built in type
• Array - Built in type
• array/string - Built in type
• b - Built in type
• binary - Built in type
• Bool - Built in type
• bool - Built in type
• Boolean - Built in type
• boolean - Built in type
• c - Built in type
• char - Built in type
• data - Built in type
• date - Built in type
• Date - Built in type
• double - Built in type
• DWArray - Built in type
• DWAttribute - Built in type
• DWCircuit - Built in type
• DWDevice - Built in type
• DWDocument - Built in type
• DWLibrary - Built in type
• DWLineSegment - The DWLineSegment object represents a single line segment in a signal object. The DWLineSegment object gives you access to information associated with the line segment, such as line attributes and line styles.
• DWLineStyle - A DWLineStyle object represents a line style definition used for drawing design objects
• DWObject - Built in type
• DWPage - Built in type
• DWPic - Built in type
• DWPin - Built in type
• DWPoint - Built in type
• DWRect - Built in type
• DWSchema - A DWSchema object represents a single attribute value on DesignWorks entity such as a device or signal.
• DWSchemaObject - A DWSchemaObject object represents a collection of attributes on a DesignWorks entity such as a device or signal. The exact properties of this object are determined by the schema that was used to create it.
• DWSignal - Built in type
• DWStatic - Built in type
• DWType - Built in type
• DWTypePin - Built in type
• DWUnitsSchema - A DWUnitsSchema object represents a single attribute value on DesignWorks entity such as a device or signal.
• DWWindow - Built in type
• int - Built in type
• int64 - Built in type
• integer - Built in type
• Integer - Built in type
• name - Built in type
• NetPadFile - Built in type
• Object - Built in type
• object - Built in type
• p - Built in type
• pathStr - Built in type
• PropsSchema - A PropsSchema object represents a single attribute value on DesignWorks entity such as a device or signal.
• PropsUnitsSchema - A PropsUnitsSchema object represents a single attribute value on DesignWorks entity such as a device or signal.
• real - Built in type
• Rect - Built in type
• regExp - Built in type
• RegExp - Built in type
• SFPoint - Built in type
• SPAddressBook - This object represents a NetPad ideas file and can be used to read, create and modify ideas.
• SPArray - This is used to return arrays of objects.
• SPColour - Represents a colour for display graphics operations.
• SPDatabase - This object represents a database created by Microsoft Access or a similar database product and allows access to records within the database. New SPDatabase objects are created using the
• SPDatastash - This object represents a datastash (i.e. lightweight database). New SPDatastash objects are created using the
• SPDatastashObject - This object represents a node in a datastash (
• SPFile - An SPFile object is used to work with files and directories, either on your local system or on remote Internet sites. Here are some notes regarding SPFile objects:
• SPFTP - An SPFTP object is used to connect to an FTP site and perform uploads, downloads, and other FTP operations. An SPFTP object is created using the
• SPHTMLDialog - This class implements a dialog box that allows information to be displayed or the user to be prompted for information using HTML formatted pages.
• SPInternet - This object is used to access files from the Internet. NOTE: This version supports only the HTTP protocol, i.e. any URL starting with "http". An SPInternet object is created using the Net.SPInternet method.
• SPNet - This is a static, top-level object used to create connections to HTTP (World Wide Web) and FTP servers and to perform various related tasks. The SPNet object always exists and is never explicitly created or destroyed. Since it is a top-level object, methods in this object do not have to be preceded with "Net.".
• SPPoint - Represents an XY position, which may be represented using integer or real values
• SPPropsObject - A general-purpose object used to hold and display property values
• SPPropsSchema - Built in type
• SPPropsSchemaItem - Built in type
• SPRect - Represents a rectangle, which may be represented using integer or real values
• SPRichConsole - This object lets you create and control a scrolling console window with rich text display capabilities
• SPScript - This is a global, top-level object containing a collection of general purpose methods and properties. This means that the SPScript object is never created or destroyed and also that the name Script does
• SPStringMap - An SPStringMap is a table that allows you to store and look up values based on a string index. It can be used, for example, to keep values associated with names or keep lists of strings to determine when an item already exists in the list.
• SPXMLDialog - Built in type
• SPXMLFile - An SPXMLFile object provides a general way of reading objects and attributes from an XML file in a simple and structured way. Elements in the file become properties of the file object. E.g.
• SPXMLText - Built in type
• SPZip - This object lets you create, add to, and extract from standard Zip archive files. An object of this class is created by calling the top-level function SPZip.
• string - Built in type
• String - Built in type
• value - Built in type
• var - Built in type
• void - Built in type
• w - Built in type