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	Возвращает идентификатор списка.
levelExistences	Проверяет наличие каждого из 9 уровней в списке. Значение true указывает, что уровень существует, то есть на этом уровне имеется по крайней мере один элемент списка.
levelTypes	Возвращает типы всех 9 уровней списка. Каждый тип может быть "Маркер", "Число" или "Рисунок".
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)	Задает два отступа на указанном уровне списка.
setLevelNumbering(level, listNumbering, formatString)	Задает формат нумерации на указанном уровне списка.
setLevelNumbering(level, listNumberingString, formatString)	Задает формат нумерации на указанном уровне списка.
setLevelPicture(level, base64EncodedImage)	Задает рисунок на указанном уровне в списке.
setLevelStartingNumber(level, startingNumber)	Задает начальный номер на указанном уровне списка. Значение по умолчанию: 1.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`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

Возвращает идентификатор списка.

readonly id: number;

Значение свойства

number

levelExistences

Проверяет наличие каждого из 9 уровней в списке. Значение true указывает, что уровень существует, то есть на этом уровне имеется по крайней мере один элемент списка.

readonly levelExistences: boolean[];

Значение свойства

boolean[]

Примеры

// 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 уровней списка. Каждый тип может быть "Маркер", "Число" или "Рисунок".

readonly levelTypes: Word.ListLevelType[];

Значение свойства

Word.ListLevelType[]

Примеры

// 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

Сведения о методе

getLevelFont(level)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Возвращает шрифт маркера, номера или рисунка на указанном уровне в списке.

getLevelFont(level: number): Word.Font;

Параметры

level: number

Обязательно. Уровень в списке.

Возвращаемое значение

Word.Font

getLevelParagraphs(level)

Возвращает абзацы, обнаруженные на указанном уровне списка.

getLevelParagraphs(level: number): Word.ParagraphCollection;

Параметры

level: number

Обязательно. Уровень в списке.

Возвращаемое значение

Word.ParagraphCollection

getLevelPicture(level)

Примечание

Возвращает строковое представление рисунка в кодировке Base64 на указанном уровне в списке.

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

Параметры

level: number

Обязательно. Уровень в списке.

Возвращаемое значение

OfficeExtension.ClientResult<string>

getLevelString(level)

Возвращает маркер, число или рисунок на указанном уровне в виде строки.

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

Параметры

level: number

Обязательно. Уровень в списке.

Возвращаемое значение

OfficeExtension.ClientResult<string>

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

Примеры

// 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

setLevelAlignment(level, alignment)

Задает выравнивание маркера, номера или рисунка на указанном уровне в списке.

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

Параметры

level: number

Обязательно. Уровень в списке.

alignment: Word.Alignment

Обязательно. Выравнивание уровня должно быть "Слева", "По центру" или "Справа".

Возвращаемое значение

void

setLevelAlignment(level, alignmentString)

Задает выравнивание маркера, номера или рисунка на указанном уровне в списке.

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

Параметры

level: number

Обязательно. Уровень в списке.

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

Обязательно. Выравнивание уровня должно быть "Слева", "По центру" или "Справа".

Возвращаемое значение

void

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

Примеры

// 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)

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

fontName: string

Возвращаемое значение

void

setLevelIndents(level, textIndent, bulletNumberPictureIndent)

Задает два отступа на указанном уровне списка.

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

Параметры

level: number

Обязательно. Уровень в списке.

textIndent: number

Обязательно. Отступ текста в точках. Он совпадает с отступом слева от абзаца.

bulletNumberPictureIndent: number

Обязательно. Относительный отступ в точках маркера, числа или рисунка. Он совпадает с отступом первой строки абзаца.

Возвращаемое значение

void

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

Примеры

// 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

setLevelPicture(level, base64EncodedImage)

Примечание

Задает рисунок на указанном уровне в списке.

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

Параметры

level: number

Обязательно. Уровень в списке.

base64EncodedImage: string

Необязательный параметр. Задается изображение в кодировке Base64. Если этот параметр не задан, задается рисунок по умолчанию.

Возвращаемое значение

void

setLevelStartingNumber(level, startingNumber)

Задает начальный номер на указанном уровне списка. Значение по умолчанию: 1.

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

Параметры

level: number

Обязательно. Уровень в списке.

startingNumber: number

Обязательно. Число для начала.

Возвращаемое значение

void

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (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)