Word.ParagraphFormat class

  • Referência
Pacote:
word

Representa um estilo de parágrafo em um 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 = 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 de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
firstLineIndent

Especifica o valor (em pontos) para um recuo de primeira linha ou de suspensão. 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 a 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 recuo esquerdo.
lineSpacing

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

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

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

Especifica se os recuos esquerdo e direito têm a mesma largura.
outlineLevel

Especifica o nível de contorno dos parágrafos especificados.
rightIndent

Especifica o recuo 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 as primeiras e últimas linhas no parágrafo especificado permanecem na mesma página que o restante 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. 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.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o Word original. O objeto ParagraphFormat é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Word.Interfaces.ParagraphFormatData) 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

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

firstLineIndent

Especifica o valor (em pontos) para um recuo de primeira linha ou de suspensão. 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 a 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 recuo 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 = 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 de linha (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 grade) 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 grade) antes dos parágrafos especificados.

lineUnitBefore: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApi 1.5 ]

mirrorIndents

Especifica se os recuos esquerdo e direito têm a mesma largura.

mirrorIndents: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.5 ]

outlineLevel

Especifica o nível de contorno dos 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 recuo 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 as primeiras e últimas linhas no parágrafo especificado permanecem na mesma página que o restante 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 quais propriedades do objeto 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 de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

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

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.ParagraphFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties
Word.Interfaces.ParagraphFormatUpdateData

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.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 é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o Word original. O objeto ParagraphFormat é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Word.Interfaces.ParagraphFormatData) que contém cópias rasas de quaisquer propriedades filho 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. 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.ParagraphFormat;

Retornos

Word.ParagraphFormat

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

Retornos

Word.ParagraphFormat