Word.ListFormat class
Представляет характеристики форматирования списка диапазона.
- Extends
Комментарии
Используется
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/20-lists/format-list-range.yaml
// Gets the range covering the entire body and reads list formatting properties.
await Word.run(async (context) => {
const bodyRange: Word.Range = context.document.body.getRange();
const listFormat: Word.ListFormat = bodyRange.listFormat;
listFormat.load("isSingleList, listType, listLevelNumber, listString, listValue");
await context.sync();
console.log("List format info for the body range:");
console.log(`- Is single list: ${listFormat.isSingleList}`);
console.log(`- List type: ${listFormat.listType}`);
console.log(`- List level number (first paragraph): ${listFormat.listLevelNumber}`);
console.log(`- List string (first paragraph): "${listFormat.listString}"`);
console.log(`- List value (first paragraph): ${listFormat.listValue}`);
});
Свойства
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| is |
Указывает, содержит ли |
| is |
Указывает, содержит ли |
| list |
|
| list |
Указывает номер уровня списка для первого абзаца |
| list |
Возвращает строковое представление значения списка первого абзаца в диапазоне |
| list |
Возвращает шаблон списка, связанный |
| list |
Возвращает тип списка для |
| list |
Возвращает числовое значение первого абзаца в диапазоне |
Методы
| apply |
Добавляет маркеры и форматирование в абзацы в диапазоне. |
| apply |
Добавляет маркеры и форматирование в абзацы в диапазоне. |
| apply |
Применяет шаблон списка с определенным уровнем к абзацам в диапазоне. |
| apply |
Добавляет нумерацию и форматирование абзацев в диапазоне. |
| apply |
Добавляет нумерацию и форматирование абзацев в диапазоне. |
| apply |
Добавляет нумерацию и форматирование структуры к абзацам в диапазоне. |
| apply |
Добавляет нумерацию и форматирование структуры к абзацам в диапазоне. |
| can |
Определяет, может ли |
| convert |
Преобразует числа в списке в обычный текст. |
| convert |
Преобразует числа в списке в обычный текст. |
| count |
Подсчитывает нумерованные элементы в списке. |
| list |
Отступы списка на один уровень. |
| list |
Отступы списка на один уровень. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| remove |
Удаляет нумеровку из списка. |
| remove |
Удаляет нумеровку из списка. |
| set(properties, options) | Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа. |
| set(properties) | Задает несколько свойств объекта одновременно на основе существующего загруженного объекта. |
| toJSON() | Переопределяет метод JavaScript |
| track() | Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах |
| untrack() | Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить |
Сведения о свойстве
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
isSingleList
Указывает, содержит ли ListFormat объект один список.
readonly isSingleList: boolean;Значение свойства
boolean
Комментарии
isSingleListTemplate
Указывает, содержит ли ListFormat объект один шаблон списка.
readonly isSingleListTemplate: boolean;Значение свойства
boolean
Комментарии
list
List Возвращает объект , представляющий первый отформатированный список, содержащийся в объекте ListFormat .
readonly list: Word.List;Значение свойства
Комментарии
listLevelNumber
Указывает номер уровня списка для первого абзаца ListFormat объекта .
listLevelNumber: number;Значение свойства
number
Комментарии
listString
Возвращает строковое представление значения списка первого абзаца в диапазоне ListFormat для объекта .
readonly listString: string;Значение свойства
string
Комментарии
listTemplate
Возвращает шаблон списка, связанный ListFormat с объектом .
readonly listTemplate: Word.ListTemplate;Значение свойства
Комментарии
listType
Возвращает тип списка для ListFormat объекта .
readonly listType: Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet";Значение свойства
Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet"
Комментарии
listValue
Возвращает числовое значение первого абзаца в диапазоне ListFormat для объекта .
readonly listValue: number;Значение свойства
number
Комментарии
Сведения о методе
applyBulletDefault(defaultListBehavior)
Добавляет маркеры и форматирование в абзацы в диапазоне.
applyBulletDefault(defaultListBehavior: Word.DefaultListBehavior): void;Параметры
- defaultListBehavior
- Word.DefaultListBehavior
Необязательный параметр. Задает поведение списка по умолчанию. По умолчанию используется значение word97.
Возвращаемое значение
void
Комментарии
applyBulletDefault(defaultListBehavior)
Добавляет маркеры и форматирование в абзацы в диапазоне.
applyBulletDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void;Параметры
- defaultListBehavior
-
"Word97" | "Word2000" | "Word2002"
Необязательный параметр. Задает поведение списка по умолчанию. По умолчанию используется значение word97.
Возвращаемое значение
void
Комментарии
applyListTemplateWithLevel(listTemplate, options)
Применяет шаблон списка с определенным уровнем к абзацам в диапазоне.
applyListTemplateWithLevel(listTemplate: Word.ListTemplate, options?: Word.ListTemplateApplyOptions): void;Параметры
- listTemplate
- Word.ListTemplate
Применяемый шаблон списка.
- options
- Word.ListTemplateApplyOptions
Необязательный параметр. Параметры применения шаблона списка, например, следует ли продолжить предыдущий список или к какой части списка следует применить шаблон.
Возвращаемое значение
void
Комментарии
applyNumberDefault(defaultListBehavior)
Добавляет нумерацию и форматирование абзацев в диапазоне.
applyNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void;Параметры
- defaultListBehavior
- Word.DefaultListBehavior
Необязательный параметр. Задает поведение списка по умолчанию.
Возвращаемое значение
void
Комментарии
applyNumberDefault(defaultListBehavior)
Добавляет нумерацию и форматирование абзацев в диапазоне.
applyNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void;Параметры
- defaultListBehavior
-
"Word97" | "Word2000" | "Word2002"
Необязательный параметр. Задает поведение списка по умолчанию.
Возвращаемое значение
void
Комментарии
applyOutlineNumberDefault(defaultListBehavior)
Добавляет нумерацию и форматирование структуры к абзацам в диапазоне.
applyOutlineNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void;Параметры
- defaultListBehavior
- Word.DefaultListBehavior
Необязательный параметр. Задает поведение списка по умолчанию.
Возвращаемое значение
void
Комментарии
applyOutlineNumberDefault(defaultListBehavior)
Добавляет нумерацию и форматирование структуры к абзацам в диапазоне.
applyOutlineNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void;Параметры
- defaultListBehavior
-
"Word97" | "Word2000" | "Word2002"
Необязательный параметр. Задает поведение списка по умолчанию.
Возвращаемое значение
void
Комментарии
canContinuePreviousList(listTemplate)
Определяет, может ли ListFormat объект продолжить предыдущий список.
canContinuePreviousList(listTemplate: Word.ListTemplate): OfficeExtension.ClientResult<Word.Continue>;Параметры
- listTemplate
- Word.ListTemplate
Шаблон списка для проверка.
Возвращаемое значение
Значение Continue , указывающее, возможно ли продолжение.
Комментарии
convertNumbersToText(numberType)
Преобразует числа в списке в обычный текст.
convertNumbersToText(numberType: Word.NumberType): void;Параметры
- numberType
- Word.NumberType
Необязательный параметр. Тип преобразуемого числа.
Возвращаемое значение
void
Комментарии
convertNumbersToText(numberType)
Преобразует числа в списке в обычный текст.
convertNumbersToText(numberType: "Paragraph" | "ListNum" | "AllNumbers"): void;Параметры
- numberType
-
"Paragraph" | "ListNum" | "AllNumbers"
Необязательный параметр. Тип преобразуемого числа.
Возвращаемое значение
void
Комментарии
countNumberedItems(options)
Подсчитывает нумерованные элементы в списке.
countNumberedItems(options?: Word.ListFormatCountNumberedItemsOptions): OfficeExtension.ClientResult<number>;Параметры
Необязательный параметр. Параметры для подсчета нумеруемых элементов, такие как тип числа и уровень для подсчета.
Возвращаемое значение
OfficeExtension.ClientResult<number>
Количество элементов.
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/20-lists/format-list-range.yaml
// Counts all numbered items across every level using numberType: AllNumbers.
await Word.run(async (context) => {
const bodyRange: Word.Range = context.document.body.getRange();
const listFormat: Word.ListFormat = bodyRange.listFormat;
const options: Word.ListFormatCountNumberedItemsOptions = {
numberType: Word.NumberType.allNumbers,
};
const count: OfficeExtension.ClientResult<number> = listFormat.countNumberedItems(options);
await context.sync();
console.log(`Total numbered items (all levels): ${count.value}`);
});
listIndent()
Отступы списка на один уровень.
listIndent(): void;Возвращаемое значение
void
Комментарии
listOutdent()
Отступы списка на один уровень.
listOutdent(): void;Возвращаемое значение
void
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Word.Interfaces.ListFormatLoadOptions): Word.ListFormat;Параметры
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Word.ListFormat;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.ListFormat;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
removeNumbers(numberType)
Удаляет нумеровку из списка.
removeNumbers(numberType: Word.NumberType): void;Параметры
- numberType
- Word.NumberType
Необязательный параметр. Тип удаляемого номера.
Возвращаемое значение
void
Комментарии
removeNumbers(numberType)
Удаляет нумеровку из списка.
removeNumbers(numberType: "Paragraph" | "ListNum" | "AllNumbers"): void;Параметры
- numberType
-
"Paragraph" | "ListNum" | "AllNumbers"
Необязательный параметр. Тип удаляемого номера.
Возвращаемое значение
void
Комментарии
set(properties, options)
Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties: Interfaces.ListFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Word.Interfaces.ListFormatUpdateData
Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.
Возвращаемое значение
void
set(properties)
Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
set(properties: Word.ListFormat): void;Параметры
- properties
- Word.ListFormat
Возвращаемое значение
void
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.ListFormat объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.ListFormatData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
toJSON(): Word.Interfaces.ListFormatData;Возвращаемое значение
track()
Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.
track(): Word.ListFormat;Возвращаемое значение
untrack()
Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.
untrack(): Word.ListFormat;