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

Word.ParagraphFormat class

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

Представляет стиль абзаца в документе.

Extends
OfficeExtension.ClientObject

Комментарии

[ Набор API: WordApi 1.5 ]

Примеры

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

// Sets certain aspects of the specified style's paragraph format e.g., the left indent size and the alignment.
await Word.run(async (context) => {
  const styleName = $("#style-name").val() as string;
  if (styleName == "") {
    console.warn("Enter a style name to update its paragraph format.");
    return;
  }

  const style = context.document.getStyles().getByNameOrNullObject(styleName);
  style.load();
  await context.sync();

  if (style.isNullObject) {
    console.warn(`There's no existing style with the name '${styleName}'.`);
  } else {
    style.paragraphFormat.leftIndent = 30;
    style.paragraphFormat.alignment = Word.Alignment.centered;
    console.log(`Successfully the paragraph format of the '${styleName}' style.`);
  }
});

Свойства

alignment

Задает выравнивание для указанных абзацев.
context

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

Задает значение (в точках) для первой строки или висячий отступ. Для установки отступа первой строки укажите положительное значение и используйте отрицательное значение, чтобы задать выступ.
keepTogether

Указывает, остаются ли все строки в указанных абзацах на одной и той же странице, когда Microsoft Word репагирует документ.
keepWithNext

Указывает, остается ли указанный абзац на той же странице, что и следующий за ним абзац, когда microsoft Word репагинирует документ.
leftIndent

Указывает левый отступ.
lineSpacing

Задает междустрочный интервал (в точках) для указанных абзацев.
lineUnitAfter

Указывает интервал (в линиях сетки) после указанных абзацев.
lineUnitBefore

Указывает интервал (в линиях сетки) перед указанными абзацами.
mirrorIndents

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

Задает уровень структуры для указанных абзацев.
rightIndent

Задает правый отступ (в точках) для указанных абзацев.
spaceAfter

Указывает интервал (в точках) после указанного абзаца или текстового столбца.
spaceBefore

Задает интервал (в точках) перед указанными абзацами.
widowControl

Указывает, остаются ли первая и последняя строки указанного абзаца на той же странице, что и остальная часть абзаца, когда Microsoft Word повторно перенастроит документ.

Методы

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. Объект ParagraphFormat — это объект API. toJSON Метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.ParagraphFormatData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
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: WordApi 1.5 ]

Примеры

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

// Sets certain aspects of the specified style's paragraph format e.g., the left indent size and the alignment.
await Word.run(async (context) => {
  const styleName = $("#style-name").val() as string;
  if (styleName == "") {
    console.warn("Enter a style name to update its paragraph format.");
    return;
  }

  const style = context.document.getStyles().getByNameOrNullObject(styleName);
  style.load();
  await context.sync();

  if (style.isNullObject) {
    console.warn(`There's no existing style with the name '${styleName}'.`);
  } else {
    style.paragraphFormat.leftIndent = 30;
    style.paragraphFormat.alignment = Word.Alignment.centered;
    console.log(`Successfully the paragraph format of the '${styleName}' style.`);
  }
});

context

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

context: RequestContext;

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

Word.RequestContext

firstLineIndent

Задает значение (в точках) для первой строки или висячий отступ. Для установки отступа первой строки укажите положительное значение и используйте отрицательное значение, чтобы задать выступ.

firstLineIndent: number;

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

number

Комментарии

[ Набор API: WordApi 1.5 ]

keepTogether

Указывает, остаются ли все строки в указанных абзацах на одной и той же странице, когда Microsoft Word репагирует документ.

keepTogether: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.5 ]

keepWithNext

Указывает, остается ли указанный абзац на той же странице, что и следующий за ним абзац, когда microsoft Word репагинирует документ.

keepWithNext: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.5 ]

leftIndent

Указывает левый отступ.

leftIndent: number;

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

number

Комментарии

[ Набор API: WordApi 1.5 ]

Примеры

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

// Sets certain aspects of the specified style's paragraph format e.g., the left indent size and the alignment.
await Word.run(async (context) => {
  const styleName = $("#style-name").val() as string;
  if (styleName == "") {
    console.warn("Enter a style name to update its paragraph format.");
    return;
  }

  const style = context.document.getStyles().getByNameOrNullObject(styleName);
  style.load();
  await context.sync();

  if (style.isNullObject) {
    console.warn(`There's no existing style with the name '${styleName}'.`);
  } else {
    style.paragraphFormat.leftIndent = 30;
    style.paragraphFormat.alignment = Word.Alignment.centered;
    console.log(`Successfully the paragraph format of the '${styleName}' style.`);
  }
});

lineSpacing

Задает междустрочный интервал (в точках) для указанных абзацев.

lineSpacing: number;

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

number

Комментарии

[ Набор API: WordApi 1.5 ]

lineUnitAfter

Указывает интервал (в линиях сетки) после указанных абзацев.

lineUnitAfter: number;

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

number

Комментарии

[ Набор API: WordApi 1.5 ]

lineUnitBefore

Указывает интервал (в линиях сетки) перед указанными абзацами.

lineUnitBefore: number;

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

number

Комментарии

[ Набор API: WordApi 1.5 ]

mirrorIndents

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

mirrorIndents: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.5 ]

outlineLevel

Задает уровень структуры для указанных абзацев.

outlineLevel: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText";

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

Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText"

Комментарии

[ Набор API: WordApi 1.5 ]

rightIndent

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

rightIndent: number;

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

number

Комментарии

[ Набор API: WordApi 1.5 ]

spaceAfter

Указывает интервал (в точках) после указанного абзаца или текстового столбца.

spaceAfter: number;

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

number

Комментарии

[ Набор API: WordApi 1.5 ]

spaceBefore

Задает интервал (в точках) перед указанными абзацами.

spaceBefore: number;

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

number

Комментарии

[ Набор API: WordApi 1.5 ]

widowControl

Указывает, остаются ли первая и последняя строки указанного абзаца на той же странице, что и остальная часть абзаца, когда Microsoft Word повторно перенастроит документ.

widowControl: boolean;

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

boolean

Комментарии

[ Набор API: WordApi 1.5 ]

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

load(options)

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

load(options?: Word.Interfaces.ParagraphFormatLoadOptions): Word.ParagraphFormat;

Параметры

options
Word.Interfaces.ParagraphFormatLoadOptions

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

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

Word.ParagraphFormat

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Word.ParagraphFormat

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Word.ParagraphFormat

set(properties, options)

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

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

Параметры

properties
Word.Interfaces.ParagraphFormatUpdateData

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

options
OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Word.ParagraphFormat): void;

Параметры

properties
Word.ParagraphFormat

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

void

toJSON()

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

toJSON(): Word.Interfaces.ParagraphFormatData;

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

Word.Interfaces.ParagraphFormatData

track()

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

track(): Word.ParagraphFormat;

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

Word.ParagraphFormat

untrack()

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

untrack(): Word.ParagraphFormat;

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

Word.ParagraphFormat