Word.List class

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

リストの ID を取得します。

readonly id: number;

プロパティ値

注釈

[ API セット: WordApi 1.3 ]

リストに 9 つのレベルがそれぞれ存在するかどうかを確認します。 true 値は、レベルが存在することを示します。つまり、そのレベルには少なくとも 1 つのリスト アイテムがあります。

readonly levelExistences: boolean[];

プロパティ値

注釈

[ API セット: WordApi 1.3 ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/20-lists/organize-list.yaml

// Gets information about the first list in the document.
await Word.run(async (context) => {
  const lists: Word.ListCollection = context.document.body.lists;
  lists.load("items");

  await context.sync();

  if (lists.items.length === 0) {
    console.warn("There are no lists in this document.");
    return;
  }
  
  // Get the first list.
  const list: Word.List = lists.getFirst();
  list.load("levelTypes,levelExistences");

  await context.sync();

  const levelTypes  = list.levelTypes;
  console.log("Level types of the first list:");
  for (let i = 0; i < levelTypes.length; i++) {
    console.log(`- Level ${i + 1} (index ${i}): ${levelTypes[i]}`);
  }

  const levelExistences = list.levelExistences;
  console.log("Level existences of the first list:");
  for (let i = 0; i < levelExistences.length; i++) {
    console.log(`- Level ${i + 1} (index ${i}): ${levelExistences[i]}`);
  }
});

リスト内の 9 レベルのすべての種類を取得します。 各型には、'Bullet'、'Number'、または 'Picture' を指定できます。

readonly levelTypes: Word.ListLevelType[];

プロパティ値

注釈

[ API セット: WordApi 1.3 ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/20-lists/organize-list.yaml

// Gets information about the first list in the document.
await Word.run(async (context) => {
  const lists: Word.ListCollection = context.document.body.lists;
  lists.load("items");

  await context.sync();

  if (lists.items.length === 0) {
    console.warn("There are no lists in this document.");
    return;
  }
  
  // Get the first list.
  const list: Word.List = lists.getFirst();
  list.load("levelTypes,levelExistences");

  await context.sync();

  const levelTypes  = list.levelTypes;
  console.log("Level types of the first list:");
  for (let i = 0; i < levelTypes.length; i++) {
    console.log(`- Level ${i + 1} (index ${i}): ${levelTypes[i]}`);
  }

  const levelExistences = list.levelExistences;
  console.log("Level existences of the first list:");
  for (let i = 0; i < levelExistences.length; i++) {
    console.log(`- Level ${i + 1} (index ${i}): ${levelExistences[i]}`);
  }
});

リスト内の段落を取得します。

readonly paragraphs: Word.ParagraphCollection;

プロパティ値

注釈

[ API セット: WordApi 1.3 ]

リスト内の指定したレベルの箇条書き、数値、または図のフォントを取得します。

getLevelFont(level: number): Word.Font;

パラメーター

戻り値

注釈

[ API セット: WordApiDesktop 1.1 ]

リスト内の指定したレベルで発生する段落を取得します。

getLevelParagraphs(level: number): Word.ParagraphCollection;

パラメーター

戻り値

注釈

[ API セット: WordApi 1.3 ]

リスト内の指定したレベルの画像の Base64 でエンコードされた文字列表現を取得します。

getLevelPicture(level: number): OfficeExtension.ClientResult<string>;

パラメーター

戻り値

注釈

[ API セット: WordApiDesktop 1.1 ]

指定したレベルの箇条書き、数値、または図を文字列として取得します。

getLevelString(level: number): OfficeExtension.ClientResult<string>;

パラメーター

戻り値

注釈

[ API セット: WordApi 1.3 ]

指定した位置に、段落を挿入します。

insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After"): Word.Paragraph;

パラメーター

戻り値

注釈

[ API セット: WordApi 1.3 ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/20-lists/insert-list.yaml

// This example starts a new list with the second paragraph.
await Word.run(async (context) => {
  const paragraphs: Word.ParagraphCollection = context.document.body.paragraphs;
  paragraphs.load("$none");

  await context.sync();

  // Start new list using the second paragraph.
  const list: Word.List = paragraphs.items[1].startNewList();
  list.load("$none");

  await context.sync();

  // To add new items to the list, use Start or End on the insertLocation parameter.
  list.insertParagraph("New list item at the start of the list", "Start");
  const paragraph: Word.Paragraph = list.insertParagraph("New list item at the end of the list (set to list level 5)", "End");

  // Set up list level for the list item.
  paragraph.listItem.level = 4;

  // To add paragraphs outside the list, use Before or After.
  list.insertParagraph("New paragraph goes after (not part of the list)", "After");

  await context.sync();
});

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: Word.Interfaces.ListLoadOptions): Word.List;

パラメーター

戻り値

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNames?: string | string[]): Word.List;

パラメーター

戻り値

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.List;

パラメーター

戻り値

箇条書き、数字、または図のフォントをリスト内の指定したレベルにリセットします。

resetLevelFont(level: number, resetFontName?: boolean): void;

パラメーター

戻り値

注釈

[ API セット: WordApiDesktop 1.1 ]

箇条書き、数値、または図の配置を、リスト内の指定されたレベルに設定します。

setLevelAlignment(level: number, alignment: Word.Alignment): void;

パラメーター

戻り値

注釈

[ API セット: WordApi 1.3 ]

箇条書き、数値、または図の配置を、リスト内の指定されたレベルに設定します。

setLevelAlignment(level: number, alignmentString: "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"): void;

パラメーター

戻り値

注釈

[ API セット: WordApi 1.3 ]

リスト内の指定したレベルで行頭文字の書式を設定します。 行頭文字が 'Custom' の場合は、charCode が必要です。

setLevelBullet(level: number, listBullet: Word.ListBullet, charCode?: number, fontName?: string): void;

パラメーター

戻り値

注釈

[ API セット: WordApi 1.3 ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/20-lists/organize-list.yaml

// Inserts a list starting with the first paragraph then set numbering and bullet types of the list items.
await Word.run(async (context) => {
  const paragraphs: Word.ParagraphCollection = context.document.body.paragraphs;
  paragraphs.load("$none");

  await context.sync();

  // Use the first paragraph to start a new list.
  const list: Word.List = paragraphs.items[0].startNewList();
  list.load("$none");

  await context.sync();

  // To add new items to the list, use Start or End on the insertLocation parameter.
  list.insertParagraph("New list item at the start of the list", "Start");
  const paragraph: Word.Paragraph = list.insertParagraph("New list item at the end of the list (set to list level 5)", "End");

  // Set numbering for list level 1.
  list.setLevelNumbering(0, Word.ListNumbering.arabic);

  // Set bullet type for list level 5.
  list.setLevelBullet(4, Word.ListBullet.arrow);

  // Set list level for the last item in this list.
  paragraph.listItem.level = 4;

  list.load("levelTypes");

  await context.sync();
});

リスト内の指定したレベルで行頭文字の書式を設定します。 行頭文字が 'Custom' の場合は、charCode が必要です。

setLevelBullet(level: number, listBulletString: "Custom" | "Solid" | "Hollow" | "Square" | "Diamonds" | "Arrow" | "Checkmark", charCode?: number, fontName?: string): void;

パラメーター

戻り値

注釈

[ API セット: WordApi 1.3 ]

リスト内の指定したレベルの 2 つのインデントを設定します。

setLevelIndents(level: number, textIndent: number, bulletNumberPictureIndent: number): void;

パラメーター

戻り値

注釈

[ API セット: WordApi 1.3 ]

リスト内の指定したレベルで番号付け書式を設定します。

setLevelNumbering(level: number, listNumbering: Word.ListNumbering, formatString?: Array<string | number>): void;

パラメーター

戻り値

注釈

[ API セット: WordApi 1.3 ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/20-lists/organize-list.yaml

// Inserts a list starting with the first paragraph then set numbering and bullet types of the list items.
await Word.run(async (context) => {
  const paragraphs: Word.ParagraphCollection = context.document.body.paragraphs;
  paragraphs.load("$none");

  await context.sync();

  // Use the first paragraph to start a new list.
  const list: Word.List = paragraphs.items[0].startNewList();
  list.load("$none");

  await context.sync();

  // To add new items to the list, use Start or End on the insertLocation parameter.
  list.insertParagraph("New list item at the start of the list", "Start");
  const paragraph: Word.Paragraph = list.insertParagraph("New list item at the end of the list (set to list level 5)", "End");

  // Set numbering for list level 1.
  list.setLevelNumbering(0, Word.ListNumbering.arabic);

  // Set bullet type for list level 5.
  list.setLevelBullet(4, Word.ListBullet.arrow);

  // Set list level for the last item in this list.
  paragraph.listItem.level = 4;

  list.load("levelTypes");

  await context.sync();
});

リスト内の指定したレベルで番号付け書式を設定します。

setLevelNumbering(level: number, listNumberingString: "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter", formatString?: Array<string | number>): void;

パラメーター

戻り値

注釈

[ API セット: WordApi 1.3 ]

一覧の指定したレベルで画像を設定します。

setLevelPicture(level: number, base64EncodedImage?: string): void;

パラメーター

戻り値

注釈

[ API セット: WordApiDesktop 1.1 ]

リスト内の指定したレベルで開始番号を設定します。 既定値は 1 です。

setLevelStartingNumber(level: number, startingNumber: number): void;

パラメーター

戻り値

注釈

[ API セット: WordApi 1.3 ]

API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Word.List オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Word.Interfaces.ListData として型指定) を返します。

toJSON(): Word.Interfaces.ListData;

戻り値

ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject)の短縮形です。 このオブジェクトを .sync 呼び出しで使用し、".run" バッチのシーケンシャル実行の外部でプロパティを設定するとき、またはオブジェクトに対してメソッドを呼び出すときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。 このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。

track(): Word.List;

戻り値

前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは 、context.trackedObjects.remove(thisObject)の短縮形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ解放が有効になる前に、 context.sync() を呼び出す必要があります。

untrack(): Word.List;

戻り値