Layouts

Nodes for reading, creating, and editing AutoCAD layouts.

---

AutoCAD Layout

AutoCAD › Layouts · Introduced v1.0.0, updated v1.0.5

Reads the details of an existing AutoCAD layout and breaks them out into separate values. Feed it a layout and you get back its name, identifier, tab display order and the block table record it is associated with.

Inputs

Outputs

See also

Set AutoCAD Layout, Get AutoCAD Layouts, Get AutoCAD Layout By Name, Create AutoCAD Layout

Create AutoCAD Layout

AutoCAD › Layouts · Introduced v1.0.0, updated v1.0.20

Creates a new layout in an AutoCAD document. Give it a name and, optionally, a target document; if no document is supplied the active drawing is used. The new layout's details are returned. If a layout with the same name already exists it is returned instead of creating a duplicate.

Inputs

Outputs

Menu & behaviour

• Recomputes automatically when relevant objects are added, modified, or erased in the AutoCAD/Civil document.

Exceptions

Level	Message	Cause & fix
Error	No active AutoCAD document available	No document was supplied and no drawing is open. Open a drawing or connect a document.
Error	Layout name cannot be empty	The name was blank or whitespace. Supply a valid layout name.
Warning	A Layout with this name already exists	A layout of that name is already in the drawing; the existing layout is returned. Choose a different name to create a new one.

See also

AutoCAD Layout, Get AutoCAD Layout By Name, Get AutoCAD Layouts, Set AutoCAD Layout

Get AutoCAD Layout By Name

AutoCAD › Layouts · Introduced v1.0.0, updated v1.0.20

Finds a single layout in an AutoCAD drawing by its exact name. Optionally target a specific document; if none is supplied the active drawing is searched. Use this when you already know the layout name and want to pull just that one layout.

Inputs

Outputs

Menu & behaviour

• Recomputes automatically when relevant objects are added, modified, or erased in the AutoCAD/Civil document.

Exceptions

Level	Message	Cause & fix
Error	No active AutoCAD document available	No document was supplied and no drawing is open. Open a drawing or connect a document.
Warning	No layout exists with name: {name}	No layout matches the supplied name. Check the spelling, or use Get AutoCAD Layouts to list available layouts.

See also

AutoCAD Layout, Get AutoCAD Layouts, Create AutoCAD Layout, Set AutoCAD Layout

Get AutoCAD Layouts

AutoCAD › Layouts · Introduced v1.0.0, updated v1.0.20

Returns every layout in an AutoCAD drawing as a list. Optionally target a specific document; if none is supplied the active drawing is used. Use this to browse all layouts or to feed downstream nodes that filter or process them.

Inputs

Outputs

Menu & behaviour

• Recomputes automatically when relevant objects are added, modified, or erased in the AutoCAD/Civil document.

Exceptions

Level	Message	Cause & fix
Error	No active AutoCAD document available	No document was supplied and no drawing is open. Open a drawing or connect a document.

See also

AutoCAD Layout, Get AutoCAD Layout By Name, Create AutoCAD Layout, Set AutoCAD Layout

Set AutoCAD Layout

AutoCAD › Layouts · Introduced v1.0.0, updated v1.0.5

Edits the properties of an existing AutoCAD layout. Connect a layout and supply a new name; if you leave the name unconnected the current name is kept. The layout is only renamed when the name actually changes, and the updated details are returned.

Inputs

Outputs

Exceptions

Level	Message	Cause & fix
Error	Layout name cannot be empty	The supplied name was blank or whitespace. Provide a valid layout name.
Error	{message}	The rename failed in AutoCAD; the underlying error text is shown. Check the name is valid and unique, then retry.

See also

AutoCAD Layout, Create AutoCAD Layout, Get AutoCAD Layout By Name, Get AutoCAD Layouts