Word.Style class

Referência

Pacote:: word

Representa um estilo em um documento Word.

Extends: OfficeExtension.ClientObject

Comentários

Propriedades

baseStyle	Especifica o nome de um estilo existente a ser usado como a formatação base de outro estilo.
borders	Especifica um objeto BorderCollection que representa todas as bordas para o estilo especificado.
builtIn	Obtém se o estilo especificado é um estilo interno.
context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
description	Obtém a descrição do estilo especificado.
font	Obtém um objeto de fonte que representa a formatação de caracteres do estilo especificado.
inUse	Obtém se o estilo especificado é um estilo interno que foi modificado ou aplicado no documento ou um novo estilo que foi criado no documento.
linked	Obtém se um estilo é um estilo vinculado que pode ser usado para formatação de parágrafo e caractere.
listTemplate	Obtém um objeto ListTemplate que representa a formatação de lista para o objeto Style especificado.
nameLocal	Obtém o nome de um estilo na linguagem do usuário.
nextParagraphStyle	Especifica o nome do estilo a ser aplicado automaticamente a um novo parágrafo inserido após um parágrafo formatado com o estilo especificado.
paragraphFormat	Obtém um objeto ParagraphFormat que representa as configurações de parágrafo para o estilo especificado.
priority	Especifica a prioridade.
quickStyle	Especifica se o estilo corresponde a um estilo rápido disponível.
shading	Obtém um objeto Sombreamento que representa o sombreamento para o estilo especificado. Não aplicável ao estilo List.
tableStyle	Obtém um objeto TableStyle que representa propriedades style que podem ser aplicadas a uma tabela.
type	Obtém o tipo de estilo.
unhideWhenUsed	Especifica se o estilo especificado é visível como um estilo recomendado no painel Estilos e no painel de tarefas Estilos na Microsoft Word depois de ser usado no documento.
visibility	Especifica se o estilo especificado está visível como um estilo recomendado na galeria Estilos e no painel de tarefas Estilos.

Métodos

delete()	Exclui o estilo.
load(options)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
load(propertyNames)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
load(propertyNamesAndPaths)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
set(properties, options)	Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.
set(properties)	Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.
toJSON()	Substitui o método JavaScript `toJSON()` para fornecer uma saída mais útil quando um objeto de API é passado para `JSON.stringify()`. (`JSON.stringify`por sua vez, chama o `toJSON` método do objeto que é passado para ele.) Enquanto o Word original. Objeto Style é um objeto API, o `toJSON` método retorna um objeto JavaScript simples (digitado como `Word.Interfaces.StyleData`) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.
track()	Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação para context.trackedObjects.add(thisObject). Se você estiver usando esse objeto entre `.sync` chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, você precisará adicionar o objeto à coleção de objetos rastreados quando o objeto foi criado pela primeira vez. Se esse objeto fizer parte de uma coleção, você também deverá acompanhar a coleção pai.
untrack()	Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa chamada é abreviada para context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Você precisará chamar `context.sync()` antes que a versão da memória entre em vigor.

Detalhes da propriedade

baseStyle

Especifica o nome de um estilo existente a ser usado como a formatação base de outro estilo.

baseStyle: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 1.5 ]

Observação: a capacidade de definir baseStyle foi introduzida no WordApi 1.6.

borders

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Especifica um objeto BorderCollection que representa todas as bordas para o estilo especificado.

readonly borders: Word.BorderCollection;

Valor da propriedade

Word.BorderCollection

Comentários

[ Conjunto de API: WordApi BETA (SOMENTE VERSÃO PRÉVIA) ]

builtIn

Obtém se o estilo especificado é um estilo interno.

readonly builtIn: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.5 ]

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Word.RequestContext

description

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Obtém a descrição do estilo especificado.

readonly description: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi BETA (SOMENTE VERSÃO PRÉVIA) ]

font

Obtém um objeto de fonte que representa a formatação de caracteres do estilo especificado.

readonly font: Word.Font;

Valor da propriedade

Word.Font

Comentários

[ Conjunto de API: WordApi 1.5 ]

Exemplos

// 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 = 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 = style.font;
    font.color = "#FF0000";
    font.size = 20;
    console.log(`Successfully updated font properties of the '${styleName}' style.`);
  }
});

inUse

Obtém se o estilo especificado é um estilo interno que foi modificado ou aplicado no documento ou um novo estilo que foi criado no documento.

readonly inUse: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.5 ]

linked

Obtém se um estilo é um estilo vinculado que pode ser usado para formatação de parágrafo e caractere.

readonly linked: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.5 ]

listTemplate

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Obtém um objeto ListTemplate que representa a formatação de lista para o objeto Style especificado.

readonly listTemplate: Word.ListTemplate;

Valor da propriedade

Word.ListTemplate

Comentários

[ Conjunto de API: WordApi BETA (SOMENTE VERSÃO PRÉVIA) ]

nameLocal

Obtém o nome de um estilo na linguagem do usuário.

readonly nameLocal: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 1.5 ]

Exemplos

// 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 = 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 = context.document.body;
    body.clear();
    body.insertParagraph(
      "Video provides a powerful way to help you prove your point. When you click Online Video, you can paste in the embed code for the video you want to add. You can also type a keyword to search online for the video that best fits your document.",
      "Start"
    );
    const paragraph = body.paragraphs.getFirst();
    paragraph.style = style.nameLocal;
    console.log(`'${styleName}' style applied to first paragraph.`);
  }
});

nextParagraphStyle

Especifica o nome do estilo a ser aplicado automaticamente a um novo parágrafo inserido após um parágrafo formatado com o estilo especificado.

nextParagraphStyle: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 1.5 ]

Observação: a capacidade de definir nextParagraphStyle foi introduzida no WordApi 1.6.

paragraphFormat

Obtém um objeto ParagraphFormat que representa as configurações de parágrafo para o estilo especificado.

readonly paragraphFormat: Word.ParagraphFormat;

Valor da propriedade

Word.ParagraphFormat

Comentários

[ Conjunto de API: WordApi 1.5 ]

Exemplos

// 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.`);
  }
});

priority

Especifica a prioridade.

priority: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApi 1.5 ]

quickStyle

Especifica se o estilo corresponde a um estilo rápido disponível.

quickStyle: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.5 ]

shading

Obtém um objeto Sombreamento que representa o sombreamento para o estilo especificado. Não aplicável ao estilo List.

readonly shading: Word.Shading;

Valor da propriedade

Word.Shading

Comentários

[ Conjunto de API: WordApi 1.6 ]

tableStyle

Obtém um objeto TableStyle que representa propriedades style que podem ser aplicadas a uma tabela.

readonly tableStyle: Word.TableStyle;

Valor da propriedade

Word.TableStyle

Comentários

[ Conjunto de API: WordApi 1.6 ]

type

Obtém o tipo de estilo.

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

Valor da propriedade

Word.StyleType | "Character" | "List" | "Paragraph" | "Table"

Comentários

[ Conjunto de API: WordApi 1.5 ]

unhideWhenUsed

Especifica se o estilo especificado é visível como um estilo recomendado no painel Estilos e no painel de tarefas Estilos na Microsoft Word depois de ser usado no documento.

unhideWhenUsed: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.5 ]

visibility

Especifica se o estilo especificado está visível como um estilo recomendado na galeria Estilos e no painel de tarefas Estilos.

visibility: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.5 ]

Detalhes do método

delete()

Exclui o estilo.

delete(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApi 1.5 ]

Exemplos

// 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 = 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}'.`);
  }
});

load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

options: Word.Interfaces.StyleLoadOptions

Fornece opções para quais propriedades do objeto carregar.

Retornos

Word.Style

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

propertyNames: string | string[]

Uma cadeia de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

Word.Style

load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

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

propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.

Retornos

Word.Style

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.

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

Parâmetros

properties: Word.Interfaces.StyleUpdateData

Um objeto JavaScript com propriedades estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.

options: OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto properties tentar definir quaisquer propriedades somente leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.

set(properties: Word.Style): void;

Parâmetros

properties: Word.Style

Retornos

void

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o Word original. Objeto Style é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Word.Interfaces.StyleData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

toJSON(): Word.Interfaces.StyleData;

Retornos

Word.Interfaces.StyleData

track()

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação para context.trackedObjects.add(thisObject). Se você estiver usando esse objeto entre .sync chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, você precisará adicionar o objeto à coleção de objetos rastreados quando o objeto foi criado pela primeira vez. Se esse objeto fizer parte de uma coleção, você também deverá acompanhar a coleção pai.

track(): Word.Style;

Retornos

Word.Style

untrack()

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa chamada é abreviada para context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Você precisará chamar context.sync() antes que a versão da memória entre em vigor.

untrack(): Word.Style;

Retornos

Word.Style