Compartilhar via

Word.ParagraphFormat class

  • Referência
Pacote:
word

Representa um estilo de parágrafo num documento.

Extends
OfficeExtension.ClientObject

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

Propriedades

alignment

Especifica o alinhamento dos parágrafos especificados.
context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
firstLineIndent

Especifica o valor (em pontos) para uma primeira linha ou avanço pendente. Use um valor positivo para definir um recuo da primeira linha e use um valor negativo para definir um recuo deslocado.
keepTogether

Especifica se todas as linhas nos parágrafos especificados permanecem na mesma página quando o Microsoft Word repagina o documento.
keepWithNext

Especifica se o parágrafo especificado permanece na mesma página que o parágrafo que o segue quando a Microsoft Word repagina o documento.
leftIndent

Especifica o avanço esquerdo.
lineSpacing

Especifica o espaçamento entre linhas (em pontos) para os parágrafos especificados.
lineUnitAfter

Especifica a quantidade de espaçamento (em linhas de grelha) após os parágrafos especificados.
lineUnitBefore

Especifica a quantidade de espaçamento (em linhas de grelha) antes dos parágrafos especificados.
mirrorIndents

Especifica se os avanços à esquerda e à direita têm a mesma largura.
outlineLevel

Especifica o nível hierárquico para os parágrafos especificados.
rightIndent

Especifica o avanço direito (em pontos) para os parágrafos especificados.
spaceAfter

Especifica a quantidade de espaçamento (em pontos) após o parágrafo ou coluna de texto especificado.
spaceBefore

Especifica o espaçamento (em pontos) antes dos parágrafos especificados.
widowControl

Especifica se a primeira e a última linha no parágrafo especificado permanecem na mesma página que o resto do parágrafo quando a Microsoft Word repagina o documento.

Métodos

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. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.
set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.
toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Word.ParagraphFormat é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.ParagraphFormatData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
track()

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este 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, terá de adicionar o objeto à coleção de objetos controlados quando o objeto foi criado pela primeira vez. Se este objeto fizer parte de uma coleção, também deve controlar a coleção principal.
untrack()

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta 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. Terá de chamar context.sync() antes de a libertação da memória ser aplicada.

Detalhes da propriedade

alignment

Especifica o alinhamento dos parágrafos especificados.

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

Valor da propriedade

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

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: 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

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

Word.RequestContext

firstLineIndent

Especifica o valor (em pontos) para uma primeira linha ou avanço pendente. Use um valor positivo para definir um recuo da primeira linha e use um valor negativo para definir um recuo deslocado.

firstLineIndent: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApi 1.5 ]

keepTogether

Especifica se todas as linhas nos parágrafos especificados permanecem na mesma página quando o Microsoft Word repagina o documento.

keepTogether: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.5 ]

keepWithNext

Especifica se o parágrafo especificado permanece na mesma página que o parágrafo que o segue quando a Microsoft Word repagina o documento.

keepWithNext: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.5 ]

leftIndent

Especifica o avanço esquerdo.

leftIndent: number;

Valor da propriedade

number

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: 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

Especifica o espaçamento entre linhas (em pontos) para os parágrafos especificados.

lineSpacing: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApi 1.5 ]

lineUnitAfter

Especifica a quantidade de espaçamento (em linhas de grelha) após os parágrafos especificados.

lineUnitAfter: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApi 1.5 ]

lineUnitBefore

Especifica a quantidade de espaçamento (em linhas de grelha) antes dos parágrafos especificados.

lineUnitBefore: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApi 1.5 ]

mirrorIndents

Especifica se os avanços à esquerda e à direita têm a mesma largura.

mirrorIndents: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.5 ]

outlineLevel

Especifica o nível hierárquico para os parágrafos especificados.

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

Valor da propriedade

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

Comentários

[ Conjunto de API: WordApi 1.5 ]

rightIndent

Especifica o avanço direito (em pontos) para os parágrafos especificados.

rightIndent: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApi 1.5 ]

spaceAfter

Especifica a quantidade de espaçamento (em pontos) após o parágrafo ou coluna de texto especificado.

spaceAfter: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApi 1.5 ]

spaceBefore

Especifica o espaçamento (em pontos) antes dos parágrafos especificados.

spaceBefore: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApi 1.5 ]

widowControl

Especifica se a primeira e a última linha no parágrafo especificado permanecem na mesma página que o resto do parágrafo quando a Microsoft Word repagina o documento.

widowControl: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.5 ]

Detalhes do método

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.ParagraphFormatLoadOptions): Word.ParagraphFormat;

Parâmetros

options
Word.Interfaces.ParagraphFormatLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

Word.ParagraphFormat

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.ParagraphFormat;

Parâmetros

propertyNames

string | string[]

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

Retornos

Word.ParagraphFormat

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.ParagraphFormat;

Parâmetros

propertyNamesAndPaths

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

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

Retornos

Word.ParagraphFormat

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.

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

Parâmetros

properties
Word.Interfaces.ParagraphFormatUpdateData

Um objeto JavaScript com propriedades que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.

options
OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.

Retornos

void

set(properties)

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

set(properties: Word.ParagraphFormat): void;

Parâmetros

properties
Word.ParagraphFormat

Retornos

void

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Word.ParagraphFormat é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.ParagraphFormatData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Word.Interfaces.ParagraphFormatData;

Retornos

Word.Interfaces.ParagraphFormatData

track()

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este 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, terá de adicionar o objeto à coleção de objetos controlados quando o objeto foi criado pela primeira vez. Se este objeto fizer parte de uma coleção, também deve controlar a coleção principal.

track(): Word.ParagraphFormat;

Retornos

Word.ParagraphFormat

untrack()

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta 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. Terá de chamar context.sync() antes de a libertação da memória ser aplicada.

untrack(): Word.ParagraphFormat;

Retornos

Word.ParagraphFormat