Word.Style class

Referencia

Paquete:: word

Representa un estilo en un documento Word.

Extends: OfficeExtension.ClientObject

Comentarios

Propiedades

baseStyle	Especifica el nombre de un estilo existente que se usará como formato base de otro estilo.
borders	Especifica un objeto BorderCollection que representa todos los bordes del estilo especificado.
builtIn	Obtiene si el estilo especificado es un estilo integrado.
context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
description	Obtiene la descripción del estilo especificado.
font	Obtiene un objeto de fuente que representa el formato de caracteres del estilo especificado.
inUse	Obtiene si el estilo especificado es un estilo integrado que se ha modificado o aplicado en el documento o un nuevo estilo que se ha creado en el documento.
linked	Obtiene si un estilo es un estilo vinculado que se puede usar para el formato de párrafo y carácter.
listTemplate	Obtiene un objeto ListTemplate que representa el formato de lista para el objeto Style especificado.
nameLocal	Obtiene el nombre de un estilo en el idioma del usuario.
nextParagraphStyle	Especifica el nombre del estilo que se va a aplicar automáticamente a un nuevo párrafo que se inserta después de un párrafo con el formato especificado.
paragraphFormat	Obtiene un objeto ParagraphFormat que representa la configuración de párrafo para el estilo especificado.
priority	Especifica la prioridad.
quickStyle	Especifica si el estilo corresponde a un estilo rápido disponible.
shading	Obtiene un objeto Shading que representa el sombreado para el estilo especificado. No se aplica al estilo de lista.
tableStyle	Obtiene un objeto TableStyle que representa las propiedades Style que se pueden aplicar a una tabla.
type	Obtiene el tipo de estilo.
unhideWhenUsed	Especifica si el estilo especificado se hace visible como un estilo recomendado en el panel de tareas Estilos y en el panel de tareas Estilos de Microsoft Word después de usarlo en el documento.
visibility	Especifica si el estilo especificado está visible como un estilo recomendado en la galería Estilos y en el panel de tareas Estilos.

Métodos

delete()	Elimina el estilo.
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.stringify`a su vez, llama al `toJSON` método del objeto que se le pasa). Mientras que el Word original. El objeto Style es un objeto de API, el `toJSON` método devuelve un objeto JavaScript sin formato (escrito como `Word.Interfaces.StyleData`) 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

baseStyle

Especifica el nombre de un estilo existente que se usará como formato base de otro estilo.

baseStyle: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApi 1.5 ]

Nota: La capacidad de establecer baseStyle se introdujo en WordApi 1.6.

borders

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Especifica un objeto BorderCollection que representa todos los bordes del estilo especificado.

readonly borders: Word.BorderCollection;

Valor de propiedad

Word.BorderCollection

Comentarios

[ Conjunto de API: WordApi BETA (SOLO VERSIÓN PRELIMINAR) ]

builtIn

Obtiene si el estilo especificado es un estilo integrado.

readonly builtIn: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.5 ]

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

description

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Obtiene la descripción del estilo especificado.

readonly description: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApi BETA (SOLO VERSIÓN PRELIMINAR) ]

font

Obtiene un objeto de fuente que representa el formato de caracteres del estilo especificado.

readonly font: Word.Font;

Valor de propiedad

Word.Font

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

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

Obtiene si el estilo especificado es un estilo integrado que se ha modificado o aplicado en el documento o un nuevo estilo que se ha creado en el documento.

readonly inUse: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.5 ]

linked

Obtiene si un estilo es un estilo vinculado que se puede usar para el formato de párrafo y carácter.

readonly linked: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.5 ]

listTemplate

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Obtiene un objeto ListTemplate que representa el formato de lista para el objeto Style especificado.

readonly listTemplate: Word.ListTemplate;

Valor de propiedad

Word.ListTemplate

Comentarios

[ Conjunto de API: WordApi BETA (SOLO VERSIÓN PRELIMINAR) ]

nameLocal

Obtiene el nombre de un estilo en el idioma del usuario.

readonly nameLocal: string;

Valor de propiedad

string

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

// 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 el nombre del estilo que se va a aplicar automáticamente a un nuevo párrafo que se inserta después de un párrafo con el formato especificado.

nextParagraphStyle: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApi 1.5 ]

Nota: La capacidad de establecer nextParagraphStyle se introdujo en WordApi 1.6.

paragraphFormat

Obtiene un objeto ParagraphFormat que representa la configuración de párrafo para el estilo especificado.

readonly paragraphFormat: Word.ParagraphFormat;

Valor de propiedad

Word.ParagraphFormat

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

priority

Especifica la prioridad.

priority: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApi 1.5 ]

quickStyle

Especifica si el estilo corresponde a un estilo rápido disponible.

quickStyle: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.5 ]

shading

Obtiene un objeto Shading que representa el sombreado para el estilo especificado. No se aplica al estilo de lista.

readonly shading: Word.Shading;

Valor de propiedad

Word.Shading

Comentarios

[ Conjunto de API: WordApi 1.6 ]

tableStyle

Obtiene un objeto TableStyle que representa las propiedades Style que se pueden aplicar a una tabla.

readonly tableStyle: Word.TableStyle;

Valor de propiedad

Word.TableStyle

Comentarios

[ Conjunto de API: WordApi 1.6 ]

type

Obtiene el tipo de estilo.

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

Valor de propiedad

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

Comentarios

[ Conjunto de API: WordApi 1.5 ]

unhideWhenUsed

Especifica si el estilo especificado se hace visible como un estilo recomendado en el panel de tareas Estilos y en el panel de tareas Estilos de Microsoft Word después de usarlo en el documento.

unhideWhenUsed: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.5 ]

visibility

Especifica si el estilo especificado está visible como un estilo recomendado en la galería Estilos y en el panel de tareas Estilos.

visibility: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.5 ]

Detalles del método

delete()

Elimina el estilo.

delete(): void;

Devoluciones

void

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

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

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.StyleLoadOptions): Word.Style;

Parámetros

options: Word.Interfaces.StyleLoadOptions

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

Devoluciones

Word.Style

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

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

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

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

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

Parámetros

properties: Word.Interfaces.StyleUpdateData

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.Style): void;

Parámetros

properties: Word.Style

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 Style es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Word.Interfaces.StyleData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Word.Interfaces.StyleData;

Devoluciones

Word.Interfaces.StyleData

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

Devoluciones

Word.Style

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

Devoluciones

Word.Style