Word.NoteItem class
脚注または文末脚注を表します。
- Extends
注釈
使用元
- Word.NoteItemCollection: getFirst, getFirstOrNullObject, items
- Word.範囲: insertEndnote、insertFootnote
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-footnotes.yaml
// Gets the text of the referenced footnote.
await Word.run(async (context) => {
const footnotes: Word.NoteItemCollection = context.document.body.footnotes;
footnotes.load("items/body");
await context.sync();
const referenceNumber = (document.getElementById("input-reference") as HTMLInputElement).value;
const mark = Number.parseInt(referenceNumber, 10) - 1;
const footnoteBody: Word.Range = footnotes.items[mark].body.getRange();
footnoteBody.load("text");
await context.sync();
console.log(`Text of footnote ${referenceNumber}: ${footnoteBody.text}`);
});
プロパティ
| body | ノート アイテムの本文オブジェクトを表します。 脚注または文末脚注内のテキストの部分です。 |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| reference | メイン文書の脚注または文末脚注の参照を表します。 |
| type | ノート アイテムの種類 (脚注または文末脚注) を表します。 |
メソッド
| delete() | ノート項目を削除します。 |
| get |
同じ種類の次のノート項目を取得します。 このメモ項目が最後である場合は、 |
| get |
同じ種類の次のノート項目を取得します。 このノート項目が最後の場合、このメソッドは |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| toJSON() | API オブジェクトが |
| track() | ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject) の短縮形です。 このオブジェクトを |
| untrack() | 前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは、 context.trackedObjects.remove(thisObject) の省略形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ リリースを有効にする前に、 |
プロパティの詳細
body
ノート アイテムの本文オブジェクトを表します。 脚注または文末脚注内のテキストの部分です。
readonly body: Word.Body;プロパティ値
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-footnotes.yaml
// Gets the text of the referenced footnote.
await Word.run(async (context) => {
const footnotes: Word.NoteItemCollection = context.document.body.footnotes;
footnotes.load("items/body");
await context.sync();
const referenceNumber = (document.getElementById("input-reference") as HTMLInputElement).value;
const mark = Number.parseInt(referenceNumber, 10) - 1;
const footnoteBody: Word.Range = footnotes.items[mark].body.getRange();
footnoteBody.load("text");
await context.sync();
console.log(`Text of footnote ${referenceNumber}: ${footnoteBody.text}`);
});
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
reference
メイン文書の脚注または文末脚注の参照を表します。
readonly reference: Word.Range;プロパティ値
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-footnotes.yaml
// Selects the footnote's reference mark in the document body.
await Word.run(async (context) => {
const footnotes: Word.NoteItemCollection = context.document.body.footnotes;
footnotes.load("items/reference");
await context.sync();
const referenceNumber = (document.getElementById("input-reference") as HTMLInputElement).value;
const mark = Number.parseInt(referenceNumber, 10) - 1;
const item: Word.NoteItem = footnotes.items[mark];
const reference: Word.Range = item.reference;
reference.select();
await context.sync();
console.log(`Reference ${referenceNumber} is selected.`);
});
type
ノート アイテムの種類 (脚注または文末脚注) を表します。
readonly type: Word.NoteItemType | "Footnote" | "Endnote";プロパティ値
Word.NoteItemType | "Footnote" | "Endnote"
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-footnotes.yaml
// Gets the referenced note's item type and body type, which are both "Footnote".
await Word.run(async (context) => {
const footnotes: Word.NoteItemCollection = context.document.body.footnotes;
footnotes.load("items");
await context.sync();
const referenceNumber = (document.getElementById("input-reference") as HTMLInputElement).value;
const mark = Number.parseInt(referenceNumber, 10) - 1;
const item: Word.NoteItem = footnotes.items[mark];
console.log(`Note type of footnote ${referenceNumber}: ${item.type}`);
item.body.load("type");
await context.sync();
console.log(`Body type of note: ${item.body.type}`);
});
メソッドの詳細
delete()
ノート項目を削除します。
delete(): void;返品
void
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-footnotes.yaml
// Deletes this referenced footnote.
await Word.run(async (context) => {
const footnotes: Word.NoteItemCollection = context.document.body.footnotes;
footnotes.load("items");
await context.sync();
const referenceNumber = (document.getElementById("input-reference") as HTMLInputElement).value;
const mark = Number.parseInt(referenceNumber, 10) - 1;
footnotes.items[mark].delete();
await context.sync();
console.log("Footnote deleted.");
});
getNext()
同じ種類の次のノート項目を取得します。 このメモ項目が最後である場合は、 ItemNotFound エラーをスローします。
getNext(): Word.NoteItem;返品
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-footnotes.yaml
// Selects the next footnote in the document body.
await Word.run(async (context) => {
const footnotes: Word.NoteItemCollection = context.document.body.footnotes;
footnotes.load("items/reference");
await context.sync();
const referenceNumber = (document.getElementById("input-reference") as HTMLInputElement).value;
const mark = Number.parseInt(referenceNumber, 10) - 1;
const reference: Word.Range = footnotes.items[mark].getNext().reference;
reference.select();
console.log("Selected is the next footnote: " + (mark + 2));
});
getNextOrNullObject()
同じ種類の次のノート項目を取得します。 このノート項目が最後の場合、このメソッドは isNullObject プロパティが true に設定されたオブジェクトを返します。 詳細については、「 *OrNullObject のメソッドとプロパティ」を参照してください。
getNextOrNullObject(): Word.NoteItem;返品
注釈
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Word.Interfaces.NoteItemLoadOptions): Word.NoteItem;パラメーター
読み込むオブジェクトのプロパティのオプションを指定します。
返品
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Word.NoteItem;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。
返品
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.NoteItem;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。
返品
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.NoteItemUpdateData, options?: OfficeExtension.UpdateOptions): void;パラメーター
- properties
- Word.Interfaces.NoteItemUpdateData
メソッドが呼び出されたオブジェクトのプロパティと同型構造のプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
プロパティ オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
返品
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Word.NoteItem): void;パラメーター
- properties
- Word.NoteItem
返品
void
toJSON()
API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Word.NoteItem オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Word.Interfaces.NoteItemData と型指定) を返します。
toJSON(): Word.Interfaces.NoteItemData;返品
track()
ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject) の短縮形です。 このオブジェクトを .sync 呼び出しと ".run" バッチの連続実行の外部で使用していて、プロパティを設定したり、オブジェクトでメソッドを呼び出したりするときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。 このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。
track(): Word.NoteItem;返品
untrack()
前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは、 context.trackedObjects.remove(thisObject) の省略形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ リリースを有効にする前に、 context.sync() を呼び出す必要があります。
untrack(): Word.NoteItem;