onenote package

クラス

OneNote.Application

グローバルにアドレス可能な OneNote オブジェクト (ノートブック、アクティブなノートブック、アクティブなセクションなど) すべてを含む最上位のオブジェクトを表します。

OneNote.FloatingInk

インク ストロークのグループを表します。

OneNote.Image

イメージを表します。 Image は、PageContent オブジェクトまたは Paragraph オブジェクトの直接の子にすることができます。

OneNote.InkAnalysis

指定されたインク ストロークのセットに関するインクの解析データを表します。

OneNote.InkAnalysisLine

インク ストロークによって形成された識別済みテキスト行のインクの解析データを表します。

OneNote.InkAnalysisLineCollection

InkAnalysisLine オブジェクトのコレクションを表します。

OneNote.InkAnalysisParagraph

インク ストロークによって形成された識別済み段落のインクの解析データを表します。

OneNote.InkAnalysisParagraphCollection

InkAnalysisParagraph オブジェクトのコレクションを表します。

OneNote.InkAnalysisWord

インク ストロークによって形成された識別済み単語のインクの解析データを表します。

OneNote.InkAnalysisWordCollection

InkAnalysisWord オブジェクトのコレクションを表します。

OneNote.InkStroke

インクの 1 つのストロークを表します。

OneNote.InkStrokeCollection

InkStroke オブジェクトのコレクションを表します。

OneNote.InkWord

段落内の単語のインクのコンテナー。

OneNote.InkWordCollection

InkWord オブジェクトのコレクションを表します。

OneNote.Notebook

OneNote ノートブックを表します。 ノートブックには、セクション グループとセクションが含まれます。

OneNote.NotebookCollection

ノートブックのコレクションを表します。

OneNote.NoteTag

段落内の NoteTag のコンテナー。

OneNote.Outline

Paragraph オブジェクトのコンテナーを表します。

OneNote.Page

OneNote のページを表します。

OneNote.PageCollection

ページのコレクションを表します。

OneNote.PageContent

Outline や Image などの最上位のコンテンツの種類を含むページの領域を表します。 PageContent オブジェクトは、XY の位置を指定できます。

OneNote.PageContentCollection

PageContent オブジェクトのコレクションとして、ページのコンテンツを表します。

OneNote.Paragraph

ページに表示されるコンテンツのコンテナー。 Paragraph に含めることができるのは、コンテンツの ParagraphType の種類のいずれか 1 つです。

OneNote.ParagraphCollection

Paragraph オブジェクトのコレクションを表します。

OneNote.Point

インク ストロークの 1 点を表します

OneNote.PointCollection

Point オブジェクトのコレクションを表します。

OneNote.RequestContext
OneNote.RichText

Paragraph 内の RichText オブジェクトを表します。

OneNote.Section

OneNote セクションを表します。 セクションには、ページを含めることができます。

OneNote.SectionCollection

セクションのコレクションを表します。

OneNote.SectionGroup

OneNote セクション グループを表します。 セクション グループに含めることができるのは、セクションとその他のセクション グループです。

OneNote.SectionGroupCollection

セクション グループのコレクションを表します。

OneNote.Table

OneNote ページのテーブルを表します。

OneNote.TableCell

OneNote テーブル内のセルを表します。

OneNote.TableCellCollection

TableCell オブジェクトのコレクションが含まれています。

OneNote.TableRow

テーブル内の行を表します。

OneNote.TableRowCollection

TableRow オブジェクトのコレクションが含まれます。

インターフェイス

OneNote.ImageOcrData

画像の OCR (光学式文字認識) によって取得されたデータを表します。

OneNote.InkStrokePointer

インク ストローク オブジェクトとそのコンテンツの親への弱い参照。

OneNote.Interfaces.ApplicationData

を呼び出 application.toJSON()して返されるデータを記述するインターフェイス。

OneNote.Interfaces.ApplicationLoadOptions

グローバルにアドレス可能な OneNote オブジェクト (ノートブック、アクティブなノートブック、アクティブなセクションなど) すべてを含む最上位のオブジェクトを表します。

OneNote.Interfaces.ApplicationUpdateData

で使用 application.set({ ... })する Application オブジェクトのデータを更新するためのインターフェイス。

OneNote.Interfaces.CollectionLoadOptions

コレクションのメンバーのサブセットのみのプロパティを読み込む方法を提供します。

OneNote.Interfaces.FloatingInkData

を呼び出 floatingInk.toJSON()して返されるデータを記述するインターフェイス。

OneNote.Interfaces.FloatingInkLoadOptions

インク ストロークのグループを表します。

OneNote.Interfaces.ImageData

を呼び出 image.toJSON()して返されるデータを記述するインターフェイス。

OneNote.Interfaces.ImageLoadOptions

イメージを表します。 Image は、PageContent オブジェクトまたは Paragraph オブジェクトの直接の子にすることができます。

OneNote.Interfaces.ImageUpdateData

で使用 image.set({ ... })する Image オブジェクトのデータを更新するためのインターフェイス。

OneNote.Interfaces.InkAnalysisData

を呼び出 inkAnalysis.toJSON()して返されるデータを記述するインターフェイス。

OneNote.Interfaces.InkAnalysisLineCollectionData

を呼び出 inkAnalysisLineCollection.toJSON()して返されるデータを記述するインターフェイス。

OneNote.Interfaces.InkAnalysisLineCollectionLoadOptions

InkAnalysisLine オブジェクトのコレクションを表します。

OneNote.Interfaces.InkAnalysisLineCollectionUpdateData

で使用 inkAnalysisLineCollection.set({ ... })する InkAnalysisLineCollection オブジェクトのデータを更新するためのインターフェイス。

OneNote.Interfaces.InkAnalysisLineData

を呼び出 inkAnalysisLine.toJSON()して返されるデータを記述するインターフェイス。

OneNote.Interfaces.InkAnalysisLineLoadOptions

インク ストロークによって形成された識別済みテキスト行のインクの解析データを表します。

OneNote.Interfaces.InkAnalysisLineUpdateData

で使用 inkAnalysisLine.set({ ... })する InkAnalysisLine オブジェクトのデータを更新するためのインターフェイス。

OneNote.Interfaces.InkAnalysisLoadOptions

指定されたインク ストロークのセットに関するインクの解析データを表します。

OneNote.Interfaces.InkAnalysisParagraphCollectionData

を呼び出 inkAnalysisParagraphCollection.toJSON()して返されるデータを記述するインターフェイス。

OneNote.Interfaces.InkAnalysisParagraphCollectionLoadOptions

InkAnalysisParagraph オブジェクトのコレクションを表します。

OneNote.Interfaces.InkAnalysisParagraphCollectionUpdateData

で使用する InkAnalysisParagraphCollection オブジェクトの inkAnalysisParagraphCollection.set({ ... })データを更新するためのインターフェイス。

OneNote.Interfaces.InkAnalysisParagraphData

を呼び出 inkAnalysisParagraph.toJSON()して返されるデータを記述するインターフェイス。

OneNote.Interfaces.InkAnalysisParagraphLoadOptions

インク ストロークによって形成された識別済み段落のインクの解析データを表します。

OneNote.Interfaces.InkAnalysisParagraphUpdateData

で使用 inkAnalysisParagraph.set({ ... })するための InkAnalysisParagraph オブジェクトのデータを更新するためのインターフェイス。

OneNote.Interfaces.InkAnalysisUpdateData

で使用 inkAnalysis.set({ ... })する InkAnalysis オブジェクトのデータを更新するためのインターフェイス。

OneNote.Interfaces.InkAnalysisWordCollectionData

を呼び出 inkAnalysisWordCollection.toJSON()して返されるデータを記述するインターフェイス。

OneNote.Interfaces.InkAnalysisWordCollectionLoadOptions

InkAnalysisWord オブジェクトのコレクションを表します。

OneNote.Interfaces.InkAnalysisWordCollectionUpdateData

で使用 inkAnalysisWordCollection.set({ ... })する InkAnalysisWordCollection オブジェクトのデータを更新するためのインターフェイス。

OneNote.Interfaces.InkAnalysisWordData

を呼び出 inkAnalysisWord.toJSON()して返されるデータを記述するインターフェイス。

OneNote.Interfaces.InkAnalysisWordLoadOptions

インク ストロークによって形成された識別済み単語のインクの解析データを表します。

OneNote.Interfaces.InkAnalysisWordUpdateData

で使用 inkAnalysisWord.set({ ... })する InkAnalysisWord オブジェクトのデータを更新するためのインターフェイス。

OneNote.Interfaces.InkStrokeCollectionData

を呼び出 inkStrokeCollection.toJSON()して返されるデータを記述するインターフェイス。

OneNote.Interfaces.InkStrokeCollectionLoadOptions

InkStroke オブジェクトのコレクションを表します。

OneNote.Interfaces.InkStrokeCollectionUpdateData

で使用する InkStrokeCollection オブジェクトの inkStrokeCollection.set({ ... })データを更新するためのインターフェイス。

OneNote.Interfaces.InkStrokeData

を呼び出 inkStroke.toJSON()して返されるデータを記述するインターフェイス。

OneNote.Interfaces.InkStrokeLoadOptions

インクの 1 つのストロークを表します。

OneNote.Interfaces.InkWordCollectionData

を呼び出 inkWordCollection.toJSON()して返されるデータを記述するインターフェイス。

OneNote.Interfaces.InkWordCollectionLoadOptions

InkWord オブジェクトのコレクションを表します。

OneNote.Interfaces.InkWordCollectionUpdateData

で使用 inkWordCollection.set({ ... })する InkWordCollection オブジェクトのデータを更新するためのインターフェイス。

OneNote.Interfaces.InkWordData

を呼び出 inkWord.toJSON()して返されるデータを記述するインターフェイス。

OneNote.Interfaces.InkWordLoadOptions

段落内の単語のインクのコンテナー。

OneNote.Interfaces.NotebookCollectionData

を呼び出 notebookCollection.toJSON()して返されるデータを記述するインターフェイス。

OneNote.Interfaces.NotebookCollectionLoadOptions

ノートブックのコレクションを表します。

OneNote.Interfaces.NotebookCollectionUpdateData

で使用 notebookCollection.set({ ... })する NotebookCollection オブジェクトのデータを更新するためのインターフェイス。

OneNote.Interfaces.NotebookData

を呼び出 notebook.toJSON()して返されるデータを記述するインターフェイス。

OneNote.Interfaces.NotebookLoadOptions

OneNote ノートブックを表します。 ノートブックには、セクション グループとセクションが含まれます。

OneNote.Interfaces.NoteTagData

を呼び出 noteTag.toJSON()して返されるデータを記述するインターフェイス。

OneNote.Interfaces.NoteTagLoadOptions

段落内の NoteTag のコンテナー。

OneNote.Interfaces.OutlineData

を呼び出 outline.toJSON()して返されるデータを記述するインターフェイス。

OneNote.Interfaces.OutlineLoadOptions

Paragraph オブジェクトのコンテナーを表します。

OneNote.Interfaces.PageCollectionData

を呼び出 pageCollection.toJSON()して返されるデータを記述するインターフェイス。

OneNote.Interfaces.PageCollectionLoadOptions

ページのコレクションを表します。

OneNote.Interfaces.PageCollectionUpdateData

で使用 pageCollection.set({ ... })する PageCollection オブジェクトのデータを更新するためのインターフェイス。

OneNote.Interfaces.PageContentCollectionData

を呼び出 pageContentCollection.toJSON()して返されるデータを記述するインターフェイス。

OneNote.Interfaces.PageContentCollectionLoadOptions

PageContent オブジェクトのコレクションとして、ページのコンテンツを表します。

OneNote.Interfaces.PageContentCollectionUpdateData

で使用する PageContentCollection オブジェクトの pageContentCollection.set({ ... })データを更新するためのインターフェイス。

OneNote.Interfaces.PageContentData

を呼び出 pageContent.toJSON()して返されるデータを記述するインターフェイス。

OneNote.Interfaces.PageContentLoadOptions

Outline や Image などの最上位のコンテンツの種類を含むページの領域を表します。 PageContent オブジェクトは、XY の位置を指定できます。

OneNote.Interfaces.PageContentUpdateData

で使用 pageContent.set({ ... })する PageContent オブジェクトのデータを更新するためのインターフェイス。

OneNote.Interfaces.PageData

を呼び出 page.toJSON()して返されるデータを記述するインターフェイス。

OneNote.Interfaces.PageLoadOptions

OneNote のページを表します。

OneNote.Interfaces.PageUpdateData

で使用 page.set({ ... })する Page オブジェクトのデータを更新するためのインターフェイス。

OneNote.Interfaces.ParagraphCollectionData

を呼び出 paragraphCollection.toJSON()して返されるデータを記述するインターフェイス。

OneNote.Interfaces.ParagraphCollectionLoadOptions

Paragraph オブジェクトのコレクションを表します。

OneNote.Interfaces.ParagraphCollectionUpdateData

で使用 paragraphCollection.set({ ... })する ParagraphCollection オブジェクトのデータを更新するためのインターフェイス。

OneNote.Interfaces.ParagraphData

を呼び出 paragraph.toJSON()して返されるデータを記述するインターフェイス。

OneNote.Interfaces.ParagraphLoadOptions

ページに表示されるコンテンツのコンテナー。 Paragraph に含めることができるのは、コンテンツの ParagraphType の種類のいずれか 1 つです。

OneNote.Interfaces.ParagraphUpdateData

で使用 paragraph.set({ ... })する Paragraph オブジェクトのデータを更新するためのインターフェイス。

OneNote.Interfaces.PointCollectionData

を呼び出 pointCollection.toJSON()して返されるデータを記述するインターフェイス。

OneNote.Interfaces.PointCollectionLoadOptions

Point オブジェクトのコレクションを表します。

OneNote.Interfaces.PointCollectionUpdateData

で使用 pointCollection.set({ ... })する PointCollection オブジェクトのデータを更新するためのインターフェイス。

OneNote.Interfaces.PointData

を呼び出 point.toJSON()して返されるデータを記述するインターフェイス。

OneNote.Interfaces.PointLoadOptions

インク ストロークの 1 点を表します

OneNote.Interfaces.RichTextData

を呼び出 richText.toJSON()して返されるデータを記述するインターフェイス。

OneNote.Interfaces.RichTextLoadOptions

Paragraph 内の RichText オブジェクトを表します。

OneNote.Interfaces.SectionCollectionData

を呼び出 sectionCollection.toJSON()して返されるデータを記述するインターフェイス。

OneNote.Interfaces.SectionCollectionLoadOptions

セクションのコレクションを表します。

OneNote.Interfaces.SectionCollectionUpdateData

で使用 sectionCollection.set({ ... })する SectionCollection オブジェクトのデータを更新するためのインターフェイス。

OneNote.Interfaces.SectionData

を呼び出 section.toJSON()して返されるデータを記述するインターフェイス。

OneNote.Interfaces.SectionGroupCollectionData

を呼び出 sectionGroupCollection.toJSON()して返されるデータを記述するインターフェイス。

OneNote.Interfaces.SectionGroupCollectionLoadOptions

セクション グループのコレクションを表します。

OneNote.Interfaces.SectionGroupCollectionUpdateData

で使用 sectionGroupCollection.set({ ... })する SectionGroupCollection オブジェクトのデータを更新するためのインターフェイス。

OneNote.Interfaces.SectionGroupData

を呼び出 sectionGroup.toJSON()して返されるデータを記述するインターフェイス。

OneNote.Interfaces.SectionGroupLoadOptions

OneNote セクション グループを表します。 セクション グループに含めることができるのは、セクションとその他のセクション グループです。

OneNote.Interfaces.SectionLoadOptions

OneNote セクションを表します。 セクションには、ページを含めることができます。

OneNote.Interfaces.TableCellCollectionData

を呼び出 tableCellCollection.toJSON()して返されるデータを記述するインターフェイス。

OneNote.Interfaces.TableCellCollectionLoadOptions

TableCell オブジェクトのコレクションが含まれています。

OneNote.Interfaces.TableCellCollectionUpdateData

で使用 tableCellCollection.set({ ... })する TableCellCollection オブジェクトのデータを更新するためのインターフェイス。

OneNote.Interfaces.TableCellData

を呼び出 tableCell.toJSON()して返されるデータを記述するインターフェイス。

OneNote.Interfaces.TableCellLoadOptions

OneNote テーブル内のセルを表します。

OneNote.Interfaces.TableCellUpdateData

で使用 tableCell.set({ ... })する TableCell オブジェクトのデータを更新するためのインターフェイス。

OneNote.Interfaces.TableData

を呼び出 table.toJSON()して返されるデータを記述するインターフェイス。

OneNote.Interfaces.TableLoadOptions

OneNote ページのテーブルを表します。

OneNote.Interfaces.TableRowCollectionData

を呼び出 tableRowCollection.toJSON()して返されるデータを記述するインターフェイス。

OneNote.Interfaces.TableRowCollectionLoadOptions

TableRow オブジェクトのコレクションが含まれます。

OneNote.Interfaces.TableRowCollectionUpdateData

で使用 tableRowCollection.set({ ... })する TableRowCollection オブジェクトのデータを更新するためのインターフェイス。

OneNote.Interfaces.TableRowData

を呼び出 tableRow.toJSON()して返されるデータを記述するインターフェイス。

OneNote.Interfaces.TableRowLoadOptions

テーブル内の行を表します。

OneNote.Interfaces.TableUpdateData

で使用 table.set({ ... })する Table オブジェクトのデータを更新するためのインターフェイス。

OneNote.ParagraphInfo

段落の情報を一覧表示します。

列挙型

OneNote.ErrorCodes
OneNote.EventType
OneNote.InsertLocation
OneNote.ListType
OneNote.NoteTagStatus
OneNote.NoteTagType
OneNote.NumberType
OneNote.PageContentType
OneNote.ParagraphStyle
OneNote.ParagraphType

機能

OneNote.run(batch)

新しい要求コンテキストを使用して、OneNote オブジェクト モデルに対してアクションを実行するバッチ スクリプトを実行します。 promise が解決されると、実行中に自動的に割り当てられた追跡対象オブジェクトが解放されます。

OneNote.run(object, batch)

以前に作成した API オブジェクトの要求コンテキストを使用して、OneNote オブジェクト モデルに対してアクションを実行するバッチ スクリプトを実行します。

OneNote.run(objects, batch)

以前に作成した API オブジェクトの要求コンテキストを使用して、OneNote オブジェクト モデルに対してアクションを実行するバッチ スクリプトを実行します。

関数の詳細

OneNote.run(batch)

新しい要求コンテキストを使用して、OneNote オブジェクト モデルに対してアクションを実行するバッチ スクリプトを実行します。 promise が解決されると、実行中に自動的に割り当てられた追跡対象オブジェクトが解放されます。

export function run<T>(batch: (context: OneNote.RequestContext) => Promise<T>): Promise<T>;

パラメーター

batch

(context: OneNote.RequestContext) => Promise<T>

OneNote.RequestContext を受け取り、promise を返す関数 (通常は "context.sync()" の結果のみ)。 context パラメーターを使用すると、OneNote アプリケーションへの要求が容易になります。 Office アドインと OneNote アプリケーションは 2 つの異なるプロセスで実行されるため、アドインから OneNote オブジェクト モデルにアクセスするには要求コンテキストが必要です。

戻り値

Promise<T>

OneNote.run(object, batch)

以前に作成した API オブジェクトの要求コンテキストを使用して、OneNote オブジェクト モデルに対してアクションを実行するバッチ スクリプトを実行します。

export function run<T>(object: OfficeExtension.ClientObject, batch: (context: OneNote.RequestContext) => Promise<T>): Promise<T>;

パラメーター

object
OfficeExtension.ClientObject

以前に作成した API オブジェクト。 バッチでは、渡されたオブジェクトと同じ要求コンテキストが使用されます。つまり、オブジェクトに適用された変更はすべて "context.sync()" によって取得されます。

batch

(context: OneNote.RequestContext) => Promise<T>

OneNote.RequestContext を受け取り、promise を返す関数 (通常は "context.sync()" の結果のみ)。 promise が解決されると、実行中に自動的に割り当てられた追跡対象オブジェクトが解放されます。

戻り値

Promise<T>

OneNote.run(objects, batch)

以前に作成した API オブジェクトの要求コンテキストを使用して、OneNote オブジェクト モデルに対してアクションを実行するバッチ スクリプトを実行します。

export function run<T>(objects: OfficeExtension.ClientObject[], batch: (context: OneNote.RequestContext) => Promise<T>): Promise<T>;

パラメーター

batch

(context: OneNote.RequestContext) => Promise<T>

OneNote.RequestContext を受け取り、promise を返す関数 (通常は "context.sync()" の結果のみ)。 promise が解決されると、実行中に自動的に割り当てられた追跡対象オブジェクトが解放されます。

戻り値

Promise<T>