Workspaces.itemById Method

Parent Object: Workspaces
Defined in namespace "adsk::core" and the header file is <Core/UserInterface/Workspaces.h>

Description

Returns the Workspace of the specified ID.

Syntax

"workspaces_var" is a variable referencing a Workspaces object.

returnValue = workspaces_var.itemById(id)
"workspaces_var" is a variable referencing a Workspaces object.

#include <Core/UserInterface/Workspaces.h>

returnValue = workspaces_var->itemById(id);
"workspaces_var" is a variable referencing a Workspaces object.

returnValue = workspaces_var.itemById(id);

Return Value

Type Description
Workspace Returns the specified workspace or null in the case where there isn't a workspace with the specified ID.

Parameters

Name Type Description
id string The ID of the workspace to get.

Samples

Name Description
Post Toolpaths API Sample

Demonstrates posting toolpaths in the active document using an NC program: import a post configuration from the post library, choose which setups or operations to include, set NC program and post parameters, and run NCProgram.postProcess.

Before running: Run from Scripts and Add-Ins with a design that contains at least one CAM setup with toolpaths. The script prompts for what to post (all setups, first setup, or first operation) and optionally opens the NC file when complete. It may offer to switch to the MANUFACTURE workspace.
Customizing the UI using the API Sample Demonstrates how to work with tabs, panels, and commands in the user interface. The full source for C++ and Python samples can be downloaded. This is especially useful for getting the resource files.

Version

Introduced in version August 2014