Word.Style class

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

baseStyle: string;

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

Комментарии

[ Набор API: WordApi 1.5 ]

Примечание. Возможность установки baseStyle появилась в WordApi 1.6.

Возвращает значение, указывающее, является ли указанный стиль встроенным.

readonly builtIn: boolean;

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

Комментарии

[ Набор API: WordApi 1.5 ]

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

context: RequestContext;

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

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

readonly font: Word.Font;

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

Комментарии

[ Набор API: WordApi 1.5 ]

Примеры

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

// Updates font properties (e.g., color, size) of the specified style.
await Word.run(async (context) => {
  const styleName = $("#style-name").val() as string;
  if (styleName == "") {
    console.warn("Enter a style name to update font properties.");
    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 {
    const font: Word.Font = style.font;
    font.color = "#FF0000";
    font.size = 20;
    console.log(`Successfully updated font properties of the '${styleName}' style.`);
  }
});

Возвращает значение, указывающее, является ли указанный стиль встроенным стилем, который был изменен или применен в документе, или новым стилем, созданным в документе.

readonly inUse: boolean;

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

Комментарии

[ Набор API: WordApi 1.5 ]

Возвращает значение, указывающее, является ли стиль связанным стилем, который можно использовать как для форматирования абзаца, так и для символов.

readonly linked: boolean;

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

Комментарии

[ Набор API: WordApi 1.5 ]

Возвращает имя стиля на языке пользователя.

readonly nameLocal: string;

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

Комментарии

[ Набор API: WordApi 1.5 ]

Примеры

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

// Applies the specified style to a paragraph.
await Word.run(async (context) => {
  const styleName = $("#style-name-to-use").val() as string;
  if (styleName == "") {
    console.warn("Enter a style name to apply.");
    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 if (style.type != Word.StyleType.paragraph) {
    console.log(`The '${styleName}' style isn't a paragraph style.`);
  } else {
    const body: Word.Body = context.document.body;
    body.clear();
    body.insertParagraph(
      "Do you want to create a solution that extends the functionality of Word? You can use the Office Add-ins platform to extend Word clients running on the web, on a Windows desktop, or on a Mac.",
      "Start"
    );
    const paragraph: Word.Paragraph = body.paragraphs.getFirst();
    paragraph.style = style.nameLocal;
    console.log(`'${styleName}' style applied to first paragraph.`);
  }
});

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

nextParagraphStyle: string;

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

Комментарии

[ Набор API: WordApi 1.5 ]

Примечание. Возможность установки nextParagraphStyle появилась в WordApi 1.6.

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

readonly paragraphFormat: Word.ParagraphFormat;

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

Комментарии

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

Указывает приоритет.

priority: number;

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

Комментарии

[ Набор API: WordApi 1.5 ]

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

quickStyle: boolean;

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

Комментарии

[ Набор API: WordApi 1.5 ]

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

readonly shading: Word.Shading;

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

Комментарии

[ Набор API: WordApi 1.6 ]

Примеры

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

// Updates shading properties (e.g., texture, pattern colors) of the specified style.
await Word.run(async (context) => {
  const styleName = $("#style-name").val() as string;
  if (styleName == "") {
    console.warn("Enter a style name to update shading properties.");
    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 {
    const shading: Word.Shading = style.shading;
    shading.load();
    await context.sync();

    shading.backgroundPatternColor = "blue";
    shading.foregroundPatternColor = "yellow";
    shading.texture = Word.ShadingTextureType.darkTrellis;

    console.log("Updated shading.");
  }
});

Возвращает объект TableStyle, представляющий свойства Style, которые можно применить к таблице.

readonly tableStyle: Word.TableStyle;

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

Комментарии

[ Набор API: WordApi 1.6 ]

Возвращает тип стиля.

readonly type: Word.StyleType | "Character" | "List" | "Paragraph" | "Table";

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

Комментарии

[ Набор API: WordApi 1.5 ]

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

unhideWhenUsed: boolean;

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

Комментарии

[ Набор API: WordApi 1.5 ]

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

visibility: boolean;

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

Комментарии

[ Набор API: WordApi 1.5 ]

Удаляет стиль.

delete(): void;

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

Комментарии

[ Набор API: WordApi 1.5 ]

Примеры

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

// Deletes the custom style.
await Word.run(async (context) => {
  const styleName = $("#style-name-to-delete").val() as string;
  if (styleName == "") {
    console.warn("Enter a style name to delete.");
    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.delete();
    console.log(`Successfully deleted custom style '${styleName}'.`);
  }
});

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

load(options?: Word.Interfaces.StyleLoadOptions): Word.Style;

Параметры

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

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

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

Параметры

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

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

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

Параметры

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

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

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

Параметры

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

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

set(properties: Word.Style): void;

Параметры

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

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

toJSON(): Word.Interfaces.StyleData;

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

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

track(): Word.Style;

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

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

untrack(): Word.Style;

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