NotebookRead
Copy to clipboard.

✖
`NotebookRead`

Updated in 14

✖

NotebookRead[notebook]

gives the expression corresponding to the current selection in the specified notebook object.

✖

NotebookRead[obj]

gives the expression corresponding to the given cell or box object.

✖

NotebookRead[{obj₁,obj₂,…}]

gives a list of expressions corresponding to the obj_i.

Details and Options

NotebookRead is the basic way to get into the kernel pieces of notebooks that are being manipulated by the front end.
NotebookRead can take a NotebookObject, CellObject, or BoxObject.
If a list of CellObject or BoxObject expressions is given, then a list of equal length will be returned, with the expressions corresponding to each object.
If an object is no longer valid, NotebookRead returns $Failed. If a list of objects is given, then $Failed will be returned for each of the invalid objects.
The following options can be given:

	CellContext	None	context to substitute for $CellContext`
	StripCellGrouping	False	whether to strip cell grouping when reading contiguously selected cells

When NotebookRead[notebook] reads a contiguous selection of cells, selected cell groups are returned as Cell[CellGroupData[…]] expressions by default. The option setting StripCellGroupingTrue will force selected cells to be returned as a flat list regardless of grouping.

Examples

open allclose all

Basic Examples (3)Summary of the most common use cases

This creates a document notebook:

In[1]:=1

✖

https://wolfram.com/xid/0tz3xk3u-cu28j

Out[1]=1

This selects the first cell:

In[2]:=2

✖

https://wolfram.com/xid/0tz3xk3u-tv3co

This reads the cell and returns its Cell expression:

In[3]:=3

✖

https://wolfram.com/xid/0tz3xk3u-g8k3rh

Out[3]=3

Read a CellObject:

In[1]:=1

✖

https://wolfram.com/xid/0tz3xk3u-kqcbxw

Out[1]=1

Read a BoxObject:

In[1]:=1

✖

https://wolfram.com/xid/0tz3xk3u-m3hszb

Out[1]=1

Scope (1)Survey of the scope of standard use cases

Create a notebook and move the selection to the first "T":

In[1]:=1

✖

https://wolfram.com/xid/0tz3xk3u-f58vje

In[2]:=2

✖

https://wolfram.com/xid/0tz3xk3u-fyci5s

Read the current selection:

In[3]:=3

✖

https://wolfram.com/xid/0tz3xk3u-gv7v7p

Out[3]=3

Select multiple cells and read the content:

In[4]:=4

✖

https://wolfram.com/xid/0tz3xk3u-izhf0

In[5]:=5

✖

https://wolfram.com/xid/0tz3xk3u-iewwuq

Out[5]=5

Select and read graphics:

In[6]:=6

✖

https://wolfram.com/xid/0tz3xk3u-cuk91l

In[7]:=7

✖

https://wolfram.com/xid/0tz3xk3u-jj1w3

Display the result:

In[8]:=8

✖

https://wolfram.com/xid/0tz3xk3u-kxyk68

Out[8]=8

Options (2)Common values & functionality for each option

CellContext (1)

Create a target cell with a raw expression in it:

In[1]:=1

✖

https://wolfram.com/xid/0tz3xk3u-fs81il

Read the cell using NotebookRead:

In[2]:=2

✖

https://wolfram.com/xid/0tz3xk3u-o8kwhi

Out[2]=2

Use CellContext to substitute a value for the $CellContext` context:

In[3]:=3

✖

https://wolfram.com/xid/0tz3xk3u-kr1azy

Out[3]=3

StripCellGrouping (1)

Reading a group of cells includes CellGroupData constructs by default:

In[1]:=1

✖

https://wolfram.com/xid/0tz3xk3u-bc5imh

Out[1]=1

Use StripCellGrouping to remove the grouping information:

In[2]:=2

✖

https://wolfram.com/xid/0tz3xk3u-rgh8f

Out[2]=2

Applications (1)Sample problems that can be solved with this function

A palette that reads the word at the current selection and makes it uppercase:

In[1]:=1

✖

https://wolfram.com/xid/0tz3xk3u-jzxzrs

Out[1]=1

Top