NotebookObject

NotebookObject[fe,id]

is an object that represents an open notebook in the front end.

Details

  • NotebookObject expressions are typically generated by kernel commands such as InputNotebook, EvaluationNotebook, and Notebooks.
  • fe is a FrontEndObject that specifies the front end in which the notebook is open.
  • id is an integer that gives a unique serial number for this open notebook.
  • In StandardForm and OutputForm, notebook objects are printed so as to indicate the current title of the window that would be used to display the notebook.
  • Functions such as NotebookPrint and NotebookClose take NotebookObject as their argument.
  • Within any open notebook, there is always a current selection. The current selection can be modified by applying functions such as SelectionMove to NotebookObject.
  • A NotebookObject is permanently invalid after a notebook is closed, even if that notebook is reopened.
  • Information for a NotebookObject may include the following properties:
  • "WindowTitle"notebook's window title
    "MemoryModificationTime"modification time stamp
    "ModifiedInMemory"whether the notebook has been modified since last save
    "StorageSystem"storage location for notebook
    "DocumentType"notebook type
    "MIMEType"application MIME type

Examples

open all close all

Basic Examples  (1)

Functions that create notebooks return NotebookObject expressions:

In[1]:=
Click for copyable input
Out[1]=

Functions that act on notebooks take a notebook object as an argument:

In[2]:=
Click for copyable input

Retitling a notebook changes the way the NotebookObject expression is displayed:

In[3]:=
Click for copyable input
Out[3]=

The NotebookObject expression itself has not changed:

In[4]:=
Click for copyable input
Out[4]=

Scope  (2)

Properties & Relations  (1)

Possible Issues  (1)

Introduced in 1996
(3.0)
|
Updated in 1999
(4.0)