Поделиться через

Word.ListLevel class

  • Ссылка
Пакет:
word

Представляет уровень списка.

Extends
OfficeExtension.ClientObject

Комментарии

[ Набор API: WordApiDesktop 1.1 ]

Примеры

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

// Gets the properties of the specified style.
await Word.run(async (context) => {
  const styleName = $("#style-name-to-use").val() as string;
  if (styleName == "") {
    console.warn("Enter a style name to get properties.");
    return;
  }

  const style: Word.Style = context.document.getStyles().getByNameOrNullObject(styleName);
  style.load("type");
  await context.sync();

  if (style.isNullObject || style.type != Word.StyleType.list) {
    console.warn(`There's no existing style with the name '${styleName}'. Or this isn't a list style.`);
  } else {
    // Load objects to log properties and their values in the console.
    style.load();
    style.listTemplate.load();
    await context.sync();

    console.log(`Properties of the '${styleName}' style:`, style);

    const listLevels = style.listTemplate.listLevels;
    listLevels.load("items");
    await context.sync();

    console.log(`List levels of the '${styleName}' style:`, listLevels);
  }
});

Свойства

alignment

Задает горизонтальное выравнивание уровня списка. Значение может быть "Слева", "По центру" или "Справа".
context

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

Возвращает объект Font, представляющий форматирование символов указанного объекта.
linkedStyle

Указывает имя стиля, связанного с указанным объектом уровня списка.
numberFormat

Задает числовой формат для указанного уровня списка.
numberPosition

Задает позицию (в точках) номера или маркера для указанного объекта уровня списка.
numberStyle

Задает стиль номера для объекта уровня списка.
resetOnHigher

Указывает уровень списка, который должен появиться до того, как указанный уровень списка перезапустит нумеровку с 1.
startAt

Указывает начальный номер для указанного объекта уровня списка.
tabPosition

Задает позицию табуляции для указанного объекта уровня списка.
textPosition

Задает позицию (в точках) для второй строки текста-оболочки для указанного объекта уровня списка.
trailingCharacter

Указывает символ, вставленный после номера для указанного уровня списка.

Методы

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.ListLevel объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.ListLevelData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
track()

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

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

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

alignment

Задает горизонтальное выравнивание уровня списка. Значение может быть "Слева", "По центру" или "Справа".

alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";

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

Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"

Комментарии

[ Набор API: WordApiDesktop 1.1 ]

context

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

context: RequestContext;

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

Word.RequestContext

font

Возвращает объект Font, представляющий форматирование символов указанного объекта.

readonly font: Word.Font;

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

Word.Font

Комментарии

[ Набор API: WordApiDesktop 1.1 ]

linkedStyle

Указывает имя стиля, связанного с указанным объектом уровня списка.

linkedStyle: string;

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

string

Комментарии

[ Набор API: WordApiDesktop 1.1 ]

numberFormat

Задает числовой формат для указанного уровня списка.

numberFormat: string;

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

string

Комментарии

[ Набор API: WordApiDesktop 1.1 ]

numberPosition

Задает позицию (в точках) номера или маркера для указанного объекта уровня списка.

numberPosition: number;

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

number

Комментарии

[ Набор API: WordApiDesktop 1.1 ]

numberStyle

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

numberStyle: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ";

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

Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ"

Комментарии

[ Набор API: WordApiDesktop 1.1 ]

resetOnHigher

Указывает уровень списка, который должен появиться до того, как указанный уровень списка перезапустит нумеровку с 1.

resetOnHigher: number;

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

number

Комментарии

[ Набор API: WordApiDesktop 1.1 ]

startAt

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

startAt: number;

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

number

Комментарии

[ Набор API: WordApiDesktop 1.1 ]

tabPosition

Задает позицию табуляции для указанного объекта уровня списка.

tabPosition: number;

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

number

Комментарии

[ Набор API: WordApiDesktop 1.1 ]

textPosition

Задает позицию (в точках) для второй строки текста-оболочки для указанного объекта уровня списка.

textPosition: number;

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

number

Комментарии

[ Набор API: WordApiDesktop 1.1 ]

trailingCharacter

Указывает символ, вставленный после номера для указанного уровня списка.

trailingCharacter: Word.TrailingCharacter | "TrailingTab" | "TrailingSpace" | "TrailingNone";

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

Word.TrailingCharacter | "TrailingTab" | "TrailingSpace" | "TrailingNone"

Комментарии

[ Набор API: WordApiDesktop 1.1 ]

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

load(options)

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

load(options?: Word.Interfaces.ListLevelLoadOptions): Word.ListLevel;

Параметры

options
Word.Interfaces.ListLevelLoadOptions

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

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

Word.ListLevel

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Word.ListLevel

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Word.ListLevel

set(properties, options)

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

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

Параметры

properties
Word.Interfaces.ListLevelUpdateData

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

options
OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Word.ListLevel): void;

Параметры

properties
Word.ListLevel

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

void

toJSON()

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

toJSON(): Word.Interfaces.ListLevelData;

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

Word.Interfaces.ListLevelData

track()

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

track(): Word.ListLevel;

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

Word.ListLevel

untrack()

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

untrack(): Word.ListLevel;

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

Word.ListLevel