# WorkSpace(ID)

base classes — `bpy_struct`, `ID`

class `bpy.types.``WorkSpace`(ID)

  Workspace data-block, defining the working environment for the user

  `object_mode`

    Switch to this object mode when activating the workspace

    - `OBJECT` Object Mode.
    - `EDIT` Edit Mode.
    - `POSE` Pose Mode.
    - `SCULPT` Sculpt Mode.
    - `VERTEX_PAINT` Vertex Paint.
    - `WEIGHT_PAINT` Weight Paint.
    - `TEXTURE_PAINT` Texture Paint.
    - `PARTICLE_EDIT` Particle Edit.
    - `EDIT_GPENCIL` Grease Pencil Edit Mode, Edit Grease Pencil Strokes.
    - `SCULPT_GPENCIL` Grease Pencil Sculpt Mode, Sculpt Grease Pencil Strokes.
    - `PAINT_GPENCIL` Grease Pencil Draw, Paint Grease Pencil Strokes.
    - `WEIGHT_GPENCIL` Grease Pencil Weight Paint, Grease Pencil Weight Paint Strokes.

    Type: | enum in [‘OBJECT’, ‘EDIT’, ‘POSE’, ‘SCULPT’, ‘VERTEX_PAINT’, ‘WEIGHT_PAINT’, ‘TEXTURE_PAINT’, ‘PARTICLE_EDIT’, ‘EDIT_GPENCIL’, ‘SCULPT_GPENCIL’, ‘PAINT_GPENCIL’, ‘WEIGHT_GPENCIL’], default ‘OBJECT’

  `owner_ids`

    Type: | `wmOwnerIDs` `bpy_prop_collection` of `wmOwnerID`, (readonly)

  `screens`

    Screen layouts of a workspace

    Type: | `bpy_prop_collection` of `Screen`, (readonly)

  `tools`

    Type: | `wmTools` `bpy_prop_collection` of `WorkSpaceTool`, (readonly)

  `use_filter_by_owner`

    Filter the UI by tags

    Type: | boolean, default False

  classmethod `status_text_set_internal`(text)

    Set the status bar text, typically key shortcuts for modal operators

    Parameters: | text (string) – Text, New string for the status bar, None clears the text

  `status_text_set`(text)

    Set the status text or None to clear, When text is a function, this will be called with the (header, context) arguments.

  classmethod `bl_rna_get_subclass`(id, default=None)

    Parameters: | id (string) – The RNA type identifier.
    Returns: | The RNA type or default when not found.
    Return type: | `bpy.types.Struct` subclass

  classmethod `bl_rna_get_subclass_py`(id, default=None)

    Parameters: | id (string) – The RNA type identifier.
    Returns: | The class or default when not found.
    Return type: | type

Inherited Properties

`bpy_struct.id_data` `ID.name` `ID.name_full` `ID.is_evaluated` `ID.original` `ID.users` | `ID.use_fake_user` `ID.tag` `ID.is_library_indirect` `ID.library` `ID.override_library` `ID.preview`

Inherited Functions

`bpy_struct.as_pointer` `bpy_struct.driver_add` `bpy_struct.driver_remove` `bpy_struct.get` `bpy_struct.is_property_hidden` `bpy_struct.is_property_overridable_library` `bpy_struct.is_property_readonly` `bpy_struct.is_property_set` `bpy_struct.items` `bpy_struct.keyframe_delete` `bpy_struct.keyframe_insert` `bpy_struct.keys` `bpy_struct.path_from_id` `bpy_struct.path_resolve` `bpy_struct.pop` | `bpy_struct.property_overridable_library_set` `bpy_struct.property_unset` `bpy_struct.type_recast` `bpy_struct.values` `ID.evaluated_get` `ID.copy` `ID.override_create` `ID.user_clear` `ID.user_remap` `ID.make_local` `ID.user_of_id` `ID.animation_data_create` `ID.animation_data_clear` `ID.update_tag`

References

`BlendData.workspaces` `Context.workspace` | `Window.workspace`