Products Object

Derived from: Base Object
Defined in namespace "adsk::core" and the header file is <Core/Application/Products.h>

Description

The Products object provides access to all of the products that exist in the document.

Methods

Name Description
classType Static function that all classes support that returns the type of the class as a string. The returned string matches the string returned by the objectType property. For example if you have a reference to an object and you want to check if it's a SketchLine you can use myObject.objectType == fusion.SketchLine.classType().
item Function that returns the specified product using an index into the collection.
itemByProductType Returns the specified product, if it exists within this document.

Properties

Name Description
count Returns the number of products within the collection.
isValid Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference.
objectType This property is supported by all objects in the API and returns a string that contains the full name (namespace::objecttype) describing the type of the object.

It's often useful to use this in combination with the classType method to see if an object is a certain type. For example: if obj.objectType == adsk.core.Point3D.classType():

Accessed From

Document.products, DrawingDocument.products, FusionDocument.products

Samples

Name Description
Generate Toolpaths API Sample Demonstrates generating the toolpaths in the active document.
Post Toolpaths API Sample Demonstrates posting toolpaths in the active document.
Save and Insert File API Sample Demonstrates creating save a new file and then inserting it into a design. To use this sample, have a design open that has been saved and run the script. It will create a new design that contains a cylinder, save it to the same folder the active design was saved to, and then insert it into the active design.

Version

Introduced in version August 2014