Word.ListItem class

Пакет:

word

Представляет формат элемента списка абзаца.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор 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	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
level	Задает уровень элемента в списке.
listString	Возвращает маркер, номер или рисунок элемента списка в виде строки.
siblingIndex	Возвращает порядковый номер элемента списка относительно элементов того же уровня.

Методы

getAncestor(parentOnly)	Возвращает родительский элемент списка или ближайший предок, если родитель не существует. Выдает ошибку, ItemNotFound если элемент списка не имеет предка.
getAncestorOrNullObject(parentOnly)	Возвращает родительский элемент списка или ближайший предок, если родитель не существует. Если элемент списка не имеет предка, этот метод вернет объект со свойством , для которого isNullObject задано значение true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getDescendants(directChildrenOnly)	Возвращает всех потомков элемента списка.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.ListItem объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.ListItemData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.

Сведения о свойстве

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

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

Word.RequestContext

level

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

level: number;

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

number

Комментарии

[ Набор 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();
});

listString

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

readonly listString: string;

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

string

Комментарии

[ Набор API: WordApi 1.3 ]

siblingIndex

Возвращает порядковый номер элемента списка относительно элементов того же уровня.

readonly siblingIndex: number;

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

number

Комментарии

[ Набор API: WordApi 1.3 ]

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

getAncestor(parentOnly)

Возвращает родительский элемент списка или ближайший предок, если родитель не существует. Выдает ошибку, ItemNotFound если элемент списка не имеет предка.

getAncestor(parentOnly?: boolean): Word.Paragraph;

Параметры

parentOnly

boolean

Необязательный параметр. Указывает, что будет возвращен только родительский элемент списка. Значение по умолчанию — false, указывающее на получение наименьшего предка.

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

Word.Paragraph

Комментарии

[ Набор API: WordApi 1.3 ]

getAncestorOrNullObject(parentOnly)

Возвращает родительский элемент списка или ближайший предок, если родитель не существует. Если элемент списка не имеет предка, этот метод вернет объект со свойством , для которого isNullObject задано значение true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getAncestorOrNullObject(parentOnly?: boolean): Word.Paragraph;

Параметры

parentOnly

boolean

Необязательный параметр. Указывает, что будет возвращен только родительский элемент списка. Значение по умолчанию — false, указывающее на получение наименьшего предка.

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

Word.Paragraph

Комментарии

[ Набор API: WordApi 1.3 ]

getDescendants(directChildrenOnly)

Возвращает всех потомков элемента списка.

getDescendants(directChildrenOnly?: boolean): Word.ParagraphCollection;

Параметры

directChildrenOnly

boolean

Необязательный параметр. Указывает, что будут возвращены только прямые дочерние элементы списка. Значение по умолчанию равно false, указывающее на получение всех элементов-потомков.

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

Word.ParagraphCollection

Комментарии

[ Набор API: WordApi 1.3 ]

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Word.Interfaces.ListItemLoadOptions): Word.ListItem;

Параметры

options

Word.Interfaces.ListItemLoadOptions

Предоставляет параметры свойств объекта для загрузки.

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

Word.ListItem

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

propertyNames

string | string[]

Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.

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

Word.ListItem

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

propertyNamesAndPaths

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

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

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

Word.ListItem

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

set(properties: Interfaces.ListItemUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties

Word.Interfaces.ListItemUpdateData

Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .

options

OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.

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

void

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

set(properties: Word.ListItem): void;

Параметры

properties

Word.ListItem

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

void

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.ListItem объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.ListItemData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): Word.Interfaces.ListItemData;

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

Word.Interfaces.ListItemData

track()

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.

track(): Word.ListItem;

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

Word.ListItem

untrack()

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.

untrack(): Word.ListItem;

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

Word.ListItem