Word.ParagraphFormat class
Представляет стиль абзаца в документе.
- Extends
Комментарии
Используется
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/28-formatting/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 = (document.getElementById("style-name") as HTMLInputElement).value;
if (styleName == "") {
console.warn("Enter a style name to update its paragraph format.");
return;
}
const style: Word.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. |
| first |
Значение (в точках) для первой строки или выступа. Для установки отступа первой строки укажите положительное значение и используйте отрицательное значение, чтобы задать выступ. |
| keep |
Указывает, все ли строки указанных абзацев остаются на одной странице, когда Microsoft Word перенастраивает документ. |
| keep |
Указывает, остается ли указанный абзац на той же странице, что и следующий за ним, когда Microsoft Word перенастраивает документ. |
| left |
Задает отступ слева. |
| line |
Задает междустрочный интервал (в точках) для указанных абзацев. |
| line |
Задает величину интервала (в сетке) после указанных абзацев. |
| line |
Задает величину интервала (в сетке) перед указанными абзацами. |
| mirror |
Левый и правый отступы одинаковой ширины. |
| outline |
Определяет уровень структуры для указанных абзацев. |
| right |
Указывает правый отступ (в пунктах) для указанных абзацев. |
| space |
Задает интервал (в пунктах) после указанного абзаца или столбца текста. |
| space |
Задает интервал (в точках) перед указанными абзацами. |
| widow |
Указывает, остаются ли первая и последняя строки указанного абзаца на той же странице, что и остальная часть абзаца, когда Microsoft Word перенагружает документ. |
Методы
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set(properties, options) | Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа. |
| set(properties) | Одновременно задает несколько свойств объекта на основе существующего загруженного объекта. |
| toJSON() | Переопределяет метод JavaScript |
| track() | Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех |
| untrack() | Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить |
Сведения о свойстве
alignment
Выравнивание указанных абзацев.
alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";Значение свойства
Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/28-formatting/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 = (document.getElementById("style-name") as HTMLInputElement).value;
if (styleName == "") {
console.warn("Enter a style name to update its paragraph format.");
return;
}
const style: Word.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;Значение свойства
firstLineIndent
Значение (в точках) для первой строки или выступа. Для установки отступа первой строки укажите положительное значение и используйте отрицательное значение, чтобы задать выступ.
firstLineIndent: number;Значение свойства
number
Комментарии
keepTogether
Указывает, все ли строки указанных абзацев остаются на одной странице, когда Microsoft Word перенастраивает документ.
keepTogether: boolean;Значение свойства
boolean
Комментарии
keepWithNext
Указывает, остается ли указанный абзац на той же странице, что и следующий за ним, когда Microsoft Word перенастраивает документ.
keepWithNext: boolean;Значение свойства
boolean
Комментарии
leftIndent
Задает отступ слева.
leftIndent: number;Значение свойства
number
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/28-formatting/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 = (document.getElementById("style-name") as HTMLInputElement).value;
if (styleName == "") {
console.warn("Enter a style name to update its paragraph format.");
return;
}
const style: Word.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
Комментарии
lineUnitAfter
Задает величину интервала (в сетке) после указанных абзацев.
lineUnitAfter: number;Значение свойства
number
Комментарии
lineUnitBefore
Задает величину интервала (в сетке) перед указанными абзацами.
lineUnitBefore: number;Значение свойства
number
Комментарии
mirrorIndents
Левый и правый отступы одинаковой ширины.
mirrorIndents: boolean;Значение свойства
boolean
Комментарии
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"
Комментарии
rightIndent
Указывает правый отступ (в пунктах) для указанных абзацев.
rightIndent: number;Значение свойства
number
Комментарии
spaceAfter
Задает интервал (в пунктах) после указанного абзаца или столбца текста.
spaceAfter: number;Значение свойства
number
Комментарии
spaceBefore
Задает интервал (в точках) перед указанными абзацами.
spaceBefore: number;Значение свойства
number
Комментарии
widowControl
Указывает, остаются ли первая и последняя строки указанного абзаца на той же странице, что и остальная часть абзаца, когда Microsoft Word перенагружает документ.
widowControl: boolean;Значение свойства
boolean
Комментарии
Сведения о методе
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Word.Interfaces.ParagraphFormatLoadOptions): Word.ParagraphFormat;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Word.ParagraphFormat;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.ParagraphFormat;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
set(properties, options)
Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties: Interfaces.ParagraphFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Word.Interfaces.ParagraphFormatUpdateData
Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.
Возвращаемое значение
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;Возвращаемое значение
track()
Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех .sync вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.
track(): Word.ParagraphFormat;Возвращаемое значение
untrack()
Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить context.sync() , прежде чем освобождение памяти вступит в силу.
untrack(): Word.ParagraphFormat;