Word.ParagraphFormat class

  • Referencia
Paquete:
word

Representa un estilo de párrafo en un documento.

Extends
OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: WordApi 1.5 ]

Ejemplos

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

Propiedades

alignment

Especifica la alineación de los párrafos especificados.
context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
firstLineIndent

Especifica el valor (en puntos) de una primera línea o sangría colgante. Use un valor positivo para establecer una sangría de primera línea y usar un valor negativo para establecer una sangría francesa.
keepTogether

Especifica si todas las líneas de los párrafos especificados permanecen en la misma página cuando Microsoft Word repagina el documento.
keepWithNext

Especifica si el párrafo especificado permanece en la misma página que el párrafo que lo sigue cuando Microsoft Word repagina el documento.
leftIndent

Especifica la sangría izquierda.
lineSpacing

Especifica el espaciado de línea (en puntos) de los párrafos especificados.
lineUnitAfter

Especifica la cantidad de espaciado (en líneas de cuadrícula) después de los párrafos especificados.
lineUnitBefore

Especifica la cantidad de espaciado (en líneas de cuadrícula) antes de los párrafos especificados.
mirrorIndents

Especifica si las sangrías izquierda y derecha tienen el mismo ancho.
outlineLevel

Especifica el nivel de esquema de los párrafos especificados.
rightIndent

Especifica la sangría derecha (en puntos) de los párrafos especificados.
spaceAfter

Especifica la cantidad de espaciado (en puntos) después del párrafo o columna de texto especificado.
spaceBefore

Especifica el espaciado (en puntos) antes de los párrafos especificados.
widowControl

Especifica si la primera y la última línea del párrafo especificado permanecen en la misma página que el resto del párrafo cuando Microsoft Word repagina el documento.

Métodos

load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
set(properties, options)

Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.
set(properties)

Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.
toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el Word original. El objeto ParagraphFormat es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Word.Interfaces.ParagraphFormatData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
track()

Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura para context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y obtiene un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe agregar el objeto a la colección de objetos de seguimiento cuando se creó el objeto por primera vez. Si este objeto forma parte de una colección, también debe realizar un seguimiento de la colección primaria.
untrack()

Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es abreviada para context.trackedObjects.remove(thisObject). Tener muchos objetos marcados ralentiza la aplicación host, así que debe recordar liberar los objetos que agregue cuando haya terminado con ellos. Tendrá que llamar context.sync() a antes de que la versión de memoria surta efecto.

Detalles de las propiedades

alignment

Especifica la alineación de los párrafos especificados.

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

Valor de propiedad

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

Comentarios

[ Conjunto de API: WordApi 1.5 ]

Ejemplos

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

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Word.RequestContext

firstLineIndent

Especifica el valor (en puntos) de una primera línea o sangría colgante. Use un valor positivo para establecer una sangría de primera línea y usar un valor negativo para establecer una sangría francesa.

firstLineIndent: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApi 1.5 ]

keepTogether

Especifica si todas las líneas de los párrafos especificados permanecen en la misma página cuando Microsoft Word repagina el documento.

keepTogether: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.5 ]

keepWithNext

Especifica si el párrafo especificado permanece en la misma página que el párrafo que lo sigue cuando Microsoft Word repagina el documento.

keepWithNext: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.5 ]

leftIndent

Especifica la sangría izquierda.

leftIndent: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApi 1.5 ]

Ejemplos

// 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 el espaciado de línea (en puntos) de los párrafos especificados.

lineSpacing: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApi 1.5 ]

lineUnitAfter

Especifica la cantidad de espaciado (en líneas de cuadrícula) después de los párrafos especificados.

lineUnitAfter: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApi 1.5 ]

lineUnitBefore

Especifica la cantidad de espaciado (en líneas de cuadrícula) antes de los párrafos especificados.

lineUnitBefore: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApi 1.5 ]

mirrorIndents

Especifica si las sangrías izquierda y derecha tienen el mismo ancho.

mirrorIndents: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.5 ]

outlineLevel

Especifica el nivel de esquema de los párrafos especificados.

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

Valor de propiedad

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

Comentarios

[ Conjunto de API: WordApi 1.5 ]

rightIndent

Especifica la sangría derecha (en puntos) de los párrafos especificados.

rightIndent: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApi 1.5 ]

spaceAfter

Especifica la cantidad de espaciado (en puntos) después del párrafo o columna de texto especificado.

spaceAfter: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApi 1.5 ]

spaceBefore

Especifica el espaciado (en puntos) antes de los párrafos especificados.

spaceBefore: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApi 1.5 ]

widowControl

Especifica si la primera y la última línea del párrafo especificado permanecen en la misma página que el resto del párrafo cuando Microsoft Word repagina el documento.

widowControl: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.5 ]

Detalles del método

load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(options?: Word.Interfaces.ParagraphFormatLoadOptions): Word.ParagraphFormat;

Parámetros

options
Word.Interfaces.ParagraphFormatLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

Word.ParagraphFormat

load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

propertyNames

string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

Devoluciones

Word.ParagraphFormat

load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

propertyNamesAndPaths

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

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

Word.ParagraphFormat

set(properties, options)

Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.

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

Parámetros

properties
Word.Interfaces.ParagraphFormatUpdateData

Objeto JavaScript con propiedades estructuradas isomórficamente con las propiedades del objeto al que se llama al método.

options
OfficeExtension.UpdateOptions

Proporciona una opción para suprimir errores si el objeto properties intenta establecer propiedades de solo lectura.

Devoluciones

void

set(properties)

Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.

set(properties: Word.ParagraphFormat): void;

Parámetros

properties
Word.ParagraphFormat

Devoluciones

void

toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el Word original. El objeto ParagraphFormat es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Word.Interfaces.ParagraphFormatData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Word.Interfaces.ParagraphFormatData;

Devoluciones

Word.Interfaces.ParagraphFormatData

track()

Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura para context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y obtiene un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe agregar el objeto a la colección de objetos de seguimiento cuando se creó el objeto por primera vez. Si este objeto forma parte de una colección, también debe realizar un seguimiento de la colección primaria.

track(): Word.ParagraphFormat;

Devoluciones

Word.ParagraphFormat

untrack()

Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es abreviada para context.trackedObjects.remove(thisObject). Tener muchos objetos marcados ralentiza la aplicación host, así que debe recordar liberar los objetos que agregue cuando haya terminado con ellos. Tendrá que llamar context.sync() a antes de que la versión de memoria surta efecto.

untrack(): Word.ParagraphFormat;

Devoluciones

Word.ParagraphFormat