Word.List class

リファレンス

パッケージ:: word

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

Extends: OfficeExtension.ClientObject

注釈

例

// 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	オブジェクトに関連付けられている要求コンテキスト。これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。
id	リストの ID を取得します。
levelExistences	リストに 9 つのレベルがそれぞれ存在するかどうかを確認します。 true 値は、レベルが存在することを示します。つまり、そのレベルには少なくとも 1 つのリストアイテムがあります。
levelTypes	リスト内の 9 レベルのすべての種類を取得します。各型には、'Bullet'、'Number'、または 'Picture' を指定できます。
paragraphs	リスト内の段落を取得します。

メソッド

getLevelFont(level)	リスト内の指定したレベルの箇条書き、数値、または図のフォントを取得します。
getLevelParagraphs(level)	リスト内の指定したレベルで発生する段落を取得します。
getLevelPicture(level)	リスト内の指定したレベルの画像の Base64 でエンコードされた文字列表現を取得します。
getLevelString(level)	指定したレベルの箇条書き、数値、または図を文字列として取得します。
insertParagraph(paragraphText, insertLocation)	指定した位置に、段落を挿入します。
load(options)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNames)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNamesAndPaths)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
resetLevelFont(level, resetFontName)	箇条書き、数字、または図のフォントをリスト内の指定したレベルにリセットします。
setLevelAlignment(level, alignment)	箇条書き、数値、または図の配置を、リスト内の指定されたレベルに設定します。
setLevelAlignment(level, alignmentString)	箇条書き、数値、または図の配置を、リスト内の指定されたレベルに設定します。
setLevelBullet(level, listBullet, charCode, fontName)	リスト内の指定したレベルで行頭文字の書式を設定します。行頭文字が 'Custom' の場合は、charCode が必要です。
setLevelBullet(level, listBulletString, charCode, fontName)	リスト内の指定したレベルで行頭文字の書式を設定します。行頭文字が 'Custom' の場合は、charCode が必要です。
setLevelIndents(level, textIndent, bulletNumberPictureIndent)	リスト内の指定したレベルの 2 つのインデントを設定します。
setLevelNumbering(level, listNumbering, formatString)	リスト内の指定したレベルで番号付け書式を設定します。
setLevelNumbering(level, listNumberingString, formatString)	リスト内の指定したレベルで番号付け書式を設定します。
setLevelPicture(level, base64EncodedImage)	一覧の指定したレベルで画像を設定します。
setLevelStartingNumber(level, startingNumber)	リスト内の指定したレベルで開始番号を設定します。既定値は 1 です。
toJSON()	API オブジェクトが`JSON.stringify()`に渡されたときにより便利な出力を提供するために、JavaScript `toJSON()` メソッドをオーバーライドします。 (`JSON.stringify`、それに渡されるオブジェクトの `toJSON` メソッドを呼び出します)。元の `Word.List` オブジェクトは API オブジェクトですが、 `toJSON` メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( `Word.Interfaces.ListData` として型指定) を返します。
track()	ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。この呼び出しは、 context.trackedObjects.add(thisObject)の短縮形です。このオブジェクトを `.sync` 呼び出しで使用し、".run" バッチのシーケンシャル実行の外部でプロパティを設定するとき、またはオブジェクトに対してメソッドを呼び出すときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクトコレクションにオブジェクトを追加する必要があります。このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。
untrack()	前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。この呼び出しは、context.trackedObjects.remove(thisObject)の短縮形です。追跡対象オブジェクトが多いとホストアプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。メモリ解放が有効になる前に、 `context.sync()` を呼び出す必要があります。

プロパティの詳細

context

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

context: RequestContext;

プロパティ値

Word.RequestContext

id

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

readonly id: number;

プロパティ値

number

注釈

[ API セット: WordApi 1.3 ]

levelExistences

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

readonly levelExistences: boolean[];

プロパティ値

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]}`);
  }
});

levelTypes

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

readonly levelTypes: Word.ListLevelType[];

プロパティ値

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]}`);
  }
});

paragraphs

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

readonly paragraphs: Word.ParagraphCollection;

プロパティ値

Word.ParagraphCollection

注釈

[ API セット: WordApi 1.3 ]

メソッドの詳細

getLevelFont(level)

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

getLevelFont(level: number): Word.Font;

パラメーター

level: number

必須です。一覧のレベル。

戻り値

Word.Font

注釈

[ API セット: WordApiDesktop 1.1 ]

getLevelParagraphs(level)

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

getLevelParagraphs(level: number): Word.ParagraphCollection;

パラメーター

level: number

必須です。一覧のレベル。

戻り値

Word.ParagraphCollection

注釈

[ API セット: WordApi 1.3 ]

getLevelPicture(level)

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

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

パラメーター

level: number

必須。一覧のレベル。

戻り値

OfficeExtension.ClientResult<string>

注釈

[ API セット: WordApiDesktop 1.1 ]

getLevelString(level)

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

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

パラメーター

level: number

必須です。一覧のレベル。

戻り値

OfficeExtension.ClientResult<string>

注釈

[ API セット: WordApi 1.3 ]

insertParagraph(paragraphText, insertLocation)

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

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

パラメーター

paragraphText: string

必須。挿入する段落テキスト。

insertLocation: start | end | before | after | "Start" | "End" | "Before" | "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();
});

load(options)

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

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

パラメーター

options: Word.Interfaces.ListLoadOptions

読み込むオブジェクトのプロパティのオプションを提供します。

戻り値

Word.List

load(propertyNames)

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

パラメーター

propertyNames: string | string[]

読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。

戻り値

Word.List

load(propertyNamesAndPaths)

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

パラメーター

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。

戻り値

Word.List

resetLevelFont(level, resetFontName)

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

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

パラメーター

level: number

必須。一覧のレベル。

resetFontName: boolean

省略可能。フォント名をリセットするかどうかを示します。既定値は false で、フォント名は変更されません。

戻り値

void

注釈

[ API セット: WordApiDesktop 1.1 ]

setLevelAlignment(level, alignment)

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

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

パラメーター

level: number

必須です。一覧のレベル。

alignment: Word.Alignment

必須。 "左"、"中央揃え"、または "右" である必要があるレベルの配置。

戻り値

void

注釈

[ API セット: WordApi 1.3 ]

setLevelAlignment(level, alignmentString)

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

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

パラメーター

level: number

必須です。一覧のレベル。

alignmentString: "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"

必須。 "左"、"中央揃え"、または "右" である必要があるレベルの配置。

戻り値

void

注釈

[ API セット: WordApi 1.3 ]

setLevelBullet(level, listBullet, charCode, fontName)

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

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

パラメーター

level: number

必須です。一覧のレベル。

listBullet: Word.ListBullet

必須。箇条書き。

charCode: number

省略可能。行頭文字のコード値。行頭文字が 'Custom' の場合にのみ使用されます。

fontName: string

省略可能。箇条書きのフォント名。行頭文字が 'Custom' の場合にのみ使用されます。

戻り値

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();
});

setLevelBullet(level, listBulletString, charCode, fontName)

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

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

パラメーター

level: number

必須です。一覧のレベル。

listBulletString: "Custom" | "Solid" | "Hollow" | "Square" | "Diamonds" | "Arrow" | "Checkmark"

必須です。箇条書き。

charCode: number

省略可能。行頭文字のコード値。行頭文字が 'Custom' の場合にのみ使用されます。

fontName: string

省略可能。箇条書きのフォント名。行頭文字が 'Custom' の場合にのみ使用されます。

戻り値

void

注釈

[ API セット: WordApi 1.3 ]

setLevelIndents(level, textIndent, bulletNumberPictureIndent)

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

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

パラメーター

level: number

必須です。一覧のレベル。

textIndent: number

必須。テキストのインデントをポイント単位で指定します。段落左インデントと同じです。

bulletNumberPictureIndent: number

必須。箇条書き、数字、または図の相対インデント (ポイント単位)。これは、段落の最初の行インデントと同じです。

戻り値

void

注釈

[ API セット: WordApi 1.3 ]

setLevelNumbering(level, listNumbering, formatString)

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

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

パラメーター

level: number

必須です。一覧のレベル。

listNumbering: Word.ListNumbering

必須。序数形式。

formatString: Array<string | number>

省略可能。文字列または整数の配列として定義された番号付け文字列形式。各整数は、このレベル以上の数値型のレベルです。たとえば、["(", level - 1, ".", level, ")"] の配列は"(2.c)"の形式を定義できます。ここで、2 は親の項目番号であり、c はこのレベルの項目番号です。

戻り値

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, listNumberingString, formatString)

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

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

パラメーター

level: number

必須です。一覧のレベル。

listNumberingString: "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter"

必須。序数形式。

formatString: Array<string | number>

戻り値

void

注釈

[ API セット: WordApi 1.3 ]

setLevelPicture(level, base64EncodedImage)

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

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

パラメーター

level: number

必須。一覧のレベル。

base64EncodedImage: string

省略可能。設定する Base64 でエンコードされたイメージ。指定しない場合、既定の画像が設定されます。

戻り値

void

注釈

[ API セット: WordApiDesktop 1.1 ]

setLevelStartingNumber(level, startingNumber)

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

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

パラメーター

level: number

必須です。一覧のレベル。

startingNumber: number

必須。開始する番号。

戻り値

void

注釈

[ API セット: WordApi 1.3 ]

toJSON()

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

toJSON(): Word.Interfaces.ListData;

戻り値

Word.Interfaces.ListData

track()

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

track(): Word.List;

戻り値

Word.List

untrack()

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

untrack(): Word.List;

戻り値

Word.List

次の方法で共有

Word.List class

注釈

例

プロパティ

メソッド

プロパティの詳細

context

プロパティ値

id

プロパティ値

注釈

levelExistences

プロパティ値

注釈

例

levelTypes

プロパティ値

注釈

例

paragraphs

プロパティ値

注釈

メソッドの詳細

getLevelFont(level)

パラメーター

戻り値

注釈

getLevelParagraphs(level)

パラメーター

戻り値

注釈

getLevelPicture(level)

パラメーター

戻り値

注釈

getLevelString(level)

パラメーター

戻り値

注釈

insertParagraph(paragraphText, insertLocation)

パラメーター

戻り値

注釈

例

load(options)

パラメーター

戻り値

load(propertyNames)

パラメーター

戻り値

load(propertyNamesAndPaths)

パラメーター

戻り値

resetLevelFont(level, resetFontName)

パラメーター

戻り値

注釈

setLevelAlignment(level, alignment)

パラメーター

戻り値

注釈

setLevelAlignment(level, alignmentString)

パラメーター

戻り値

注釈

setLevelBullet(level, listBullet, charCode, fontName)

パラメーター

戻り値

注釈

例

setLevelBullet(level, listBulletString, charCode, fontName)

パラメーター

戻り値

注釈

setLevelIndents(level, textIndent, bulletNumberPictureIndent)

パラメーター

戻り値

注釈

setLevelNumbering(level, listNumbering, formatString)