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	インクストロークの単一点を表します
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.set({ ... })` で使用するために、`InkAnalysisParagraphCollection` オブジェクトのデータを更新するためのインターフェイス。
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.set({ ... })` で使用するために、`InkStrokeCollection` オブジェクトのデータを更新するためのインターフェイス。
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.set({ ... })` で使用するために、`PageContentCollection` オブジェクトのデータを更新するためのインターフェイス。
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	インクストロークの単一点を表します
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>

例

// *.run methods automatically create an OfficeExtension.ClientRequestContext
// object to work with the Office file.
await OneNote.run(async (context) => {
    const notebook = context.application.getActiveNotebook();
    // Interact with the OneNote notebook...
});

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)

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

パラメーター

objects: OfficeExtension.ClientObject[]

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

返品

Promise<T>

フィードバック

このページはお役に立ちましたか?