App DocumentObject

Introduction


An App DocumentObject object, or formally an, is the base class of all object classes handled in the document.



How to use
The App DocumentObject is an internal class, so it cannot be created from the graphical interface. It is not meant to be used directly. It is sub-classed by other classes that are intended to handle other types of information. Therefore, almost everything in the software, every object that can be listed in the tree view, which can be saved and restored with the document, is a "DocumentObject".

One of the most important DocumentObjects is the Part Feature class, which is the parent object of most 2D and 3D geometrical objects that can be displayed in the 3D view.

Properties
These are the basic properties that essentially all objects have. The basic DocumentObject doesn't have a view provider, so these properties aren't displayed in the property editor, but can be accessed from the Python console.


 * : a list of expressions that can be used.
 * : the user editable name of this object.
 * : a longer, user editable description of this object.
 * : whether to display the object or not.

Scripting
FreeCAD Scripting Basics, and scripted objects.

See Part Feature for the general information on adding objects to the program

A DocumentObject is created with the method of the document. However, in general, there is no need to create this object manually. It is usually better to create one of the sub-classes, for example,, , or.