Word.List class

Referencia

Paquete:: word

Contiene una colección de Word. Objetos paragraph.

Extends: OfficeExtension.ClientObject

Comentarios

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/20-lists/insert-list.yaml

// This example starts a new list with the second paragraph.
await Word.run(async (context) => {
  const paragraphs = context.document.body.paragraphs;
  paragraphs.load("$none");

  await context.sync();

  // Start new list using the second paragraph.
  const list = paragraphs.items[1].startNewList();
  list.load("$none");

  await context.sync();

  // To add new items to the list, use Start or End on the insertLocation parameter.
  list.insertParagraph("New list item at the start of the list", "Start");
  const paragraph = list.insertParagraph("New list item at the end of the list (set to list level 5)", "End");

  // Set up list level for the list item.
  paragraph.listItem.level = 4;

  // To add paragraphs outside the list, use Before or After.
  list.insertParagraph("New paragraph goes after (not part of the list)", "After");

  await context.sync();
});

Propiedades

context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
id	Obtiene el identificador de la lista.
levelExistences	Comprueba si cada uno de los 9 niveles existe en la lista. Un valor True indica que el nivel existe, lo que significa que existe al menos un elemento de lista en ese nivel.
levelTypes	Obtiene todos los tipos de los 9 niveles de la lista. Cada tipo puede ser "Bullet", "Number" o "Picture".
paragraphs	Obtiene los párrafos de la lista. Solo lectura.

Métodos

getLevelFont(level)	Obtiene la fuente de la viñeta, el número o la imagen en el nivel especificado de la lista.
getLevelParagraphs(level)	Obtiene los párrafos que se producen en el nivel especificado de la lista.
getLevelPicture(level)	Obtiene la representación de cadena codificada en Base64 de la imagen en el nivel especificado de la lista.
getLevelString(level)	Obtiene la viñeta, el número o la imagen en el nivel especificado como una cadena.
insertParagraph(paragraphText, insertLocation)	Inserta un párrafo en la ubicación especificada.
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.
resetLevelFont(level, resetFontName)	Restablece la fuente de la viñeta, el número o la imagen en el nivel especificado de la lista.
setLevelAlignment(level, alignment)	Establece la alineación de la viñeta, el número o la imagen en el nivel especificado de la lista.
setLevelAlignment(level, alignmentString)	Establece la alineación de la viñeta, el número o la imagen en el nivel especificado de la lista.
setLevelBullet(level, listBullet, charCode, fontName)	Establece el formato de viñeta en el nivel especificado de la lista. Si la viñeta es 'Custom', se requiere charCode.
setLevelBullet(level, listBulletString, charCode, fontName)	Establece el formato de viñeta en el nivel especificado de la lista. Si la viñeta es 'Custom', se requiere charCode.
setLevelIndents(level, textIndent, bulletNumberPictureIndent)	Establece las dos sangrías del nivel especificado de la lista.
setLevelNumbering(level, listNumbering, formatString)	Establece el formato de numeración en el nivel especificado de la lista.
setLevelNumbering(level, listNumberingString, formatString)	Establece el formato de numeración en el nivel especificado de la lista.
setLevelPicture(level, base64EncodedImage)	Establece la imagen en el nivel especificado de la lista.
setLevelStartingNumber(level, startingNumber)	Establece el número de inicio en el nivel especificado de la lista. El valor predeterminado es 1.
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 List es un objeto de API, el `toJSON` método devuelve un objeto JavaScript sin formato (escrito como `Word.Interfaces.ListData`) 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

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

id

Obtiene el identificador de la lista.

readonly id: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApi 1.3 ]

levelExistences

Comprueba si cada uno de los 9 niveles existe en la lista. Un valor True indica que el nivel existe, lo que significa que existe al menos un elemento de lista en ese nivel.

readonly levelExistences: boolean[];

Valor de propiedad

boolean[]

Comentarios

[ Conjunto de API: WordApi 1.3 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/20-lists/organize-list.yaml

// Gets information about the first list in the document.
await Word.run(async (context) => {
  const lists = context.document.body.lists;
  lists.load("items");

  await context.sync();

  if (lists.items.length === 0) {
    console.warn("There are no lists in this document");
    return;
  }
  
  // Get the first list.
  const list = lists.getFirst();
  list.load("levelTypes,levelExistences");

  await context.sync();

  const levelTypes = list.levelTypes;
  console.log("Level types of the first list:");
  for (let i = 0; i < levelTypes.length; i++) {
    console.log(`- Level ${i + 1} (index ${i}): ${levelTypes[i]}`);
  }

  const levelExistences = list.levelExistences;
  console.log("Level existences of the first list:");
  for (let i = 0; i < levelExistences.length; i++) {
    console.log(`- Level ${i + 1} (index ${i}): ${levelExistences[i]}`);
  }
});

levelTypes

Obtiene todos los tipos de los 9 niveles de la lista. Cada tipo puede ser "Bullet", "Number" o "Picture".

readonly levelTypes: Word.ListLevelType[];

Valor de propiedad

Word.ListLevelType[]

Comentarios

[ Conjunto de API: WordApi 1.3 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/20-lists/organize-list.yaml

// Gets information about the first list in the document.
await Word.run(async (context) => {
  const lists = context.document.body.lists;
  lists.load("items");

  await context.sync();

  if (lists.items.length === 0) {
    console.warn("There are no lists in this document");
    return;
  }
  
  // Get the first list.
  const list = lists.getFirst();
  list.load("levelTypes,levelExistences");

  await context.sync();

  const levelTypes = list.levelTypes;
  console.log("Level types of the first list:");
  for (let i = 0; i < levelTypes.length; i++) {
    console.log(`- Level ${i + 1} (index ${i}): ${levelTypes[i]}`);
  }

  const levelExistences = list.levelExistences;
  console.log("Level existences of the first list:");
  for (let i = 0; i < levelExistences.length; i++) {
    console.log(`- Level ${i + 1} (index ${i}): ${levelExistences[i]}`);
  }
});

paragraphs

Obtiene los párrafos de la lista. Solo lectura.

readonly paragraphs: Word.ParagraphCollection;

Valor de propiedad

Word.ParagraphCollection

Comentarios

[ Conjunto de API: WordApi 1.3 ]

Detalles del método

getLevelFont(level)

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 fuente de la viñeta, el número o la imagen en el nivel especificado de la lista.

getLevelFont(level: number): Word.Font;

Parámetros

level: number

Obligatorio. Nivel de la lista.

Devoluciones

Word.Font

Comentarios

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

getLevelParagraphs(level)

Obtiene los párrafos que se producen en el nivel especificado de la lista.

getLevelParagraphs(level: number): Word.ParagraphCollection;

Parámetros

level: number

Obligatorio. Nivel de la lista.

Devoluciones

Word.ParagraphCollection

Comentarios

[ Conjunto de API: WordApi 1.3 ]

getLevelPicture(level)

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 representación de cadena codificada en Base64 de la imagen en el nivel especificado de la lista.

getLevelPicture(level: number): OfficeExtension.ClientResult<string>;

Parámetros

level: number

Obligatorio. Nivel de la lista.

Devoluciones

OfficeExtension.ClientResult<string>

Comentarios

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

getLevelString(level)

Obtiene la viñeta, el número o la imagen en el nivel especificado como una cadena.

getLevelString(level: number): OfficeExtension.ClientResult<string>;

Parámetros

level: number

Obligatorio. Nivel de la lista.

Devoluciones

OfficeExtension.ClientResult<string>

Comentarios

[ Conjunto de API: WordApi 1.3 ]

insertParagraph(paragraphText, insertLocation)

Inserta un párrafo en la ubicación especificada.

insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | Word.InsertLocation.before | Word.InsertLocation.after | "Start" | "End" | "Before" | "After"): Word.Paragraph;

Parámetros

paragraphText: string

Obligatorio. Texto de párrafo que se va a insertar.

insertLocation: start | end | before | after | "Start" | "End" | "Before" | "After"

Obligatorio. El valor debe ser "Start", "End", "Before" o "After".

Devoluciones

Word.Paragraph

Comentarios

[ Conjunto de API: WordApi 1.3 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/20-lists/insert-list.yaml

// This example starts a new list with the second paragraph.
await Word.run(async (context) => {
  const paragraphs = context.document.body.paragraphs;
  paragraphs.load("$none");

  await context.sync();

  // Start new list using the second paragraph.
  const list = paragraphs.items[1].startNewList();
  list.load("$none");

  await context.sync();

  // To add new items to the list, use Start or End on the insertLocation parameter.
  list.insertParagraph("New list item at the start of the list", "Start");
  const paragraph = list.insertParagraph("New list item at the end of the list (set to list level 5)", "End");

  // Set up list level for the list item.
  paragraph.listItem.level = 4;

  // To add paragraphs outside the list, use Before or After.
  list.insertParagraph("New paragraph goes after (not part of the list)", "After");

  await context.sync();
});

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.ListLoadOptions): Word.List;

Parámetros

options: Word.Interfaces.ListLoadOptions

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

Devoluciones

Word.List

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

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

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

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

resetLevelFont(level, resetFontName)

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.

Restablece la fuente de la viñeta, el número o la imagen en el nivel especificado de la lista.

resetLevelFont(level: number, resetFontName?: boolean): void;

Parámetros

level: number

Obligatorio. Nivel de la lista.

resetFontName: boolean

Opcional. Indica si se va a restablecer el nombre de fuente. El valor predeterminado es false que indica que el nombre de fuente se mantiene sin cambios.

Devoluciones

void

Comentarios

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

setLevelAlignment(level, alignment)

Establece la alineación de la viñeta, el número o la imagen en el nivel especificado de la lista.

setLevelAlignment(level: number, alignment: Word.Alignment): void;

Parámetros

level: number

Obligatorio. Nivel de la lista.

alignment: Word.Alignment

Obligatorio. Alineación de nivel que debe ser "Left", "Centered" o "Right".

Devoluciones

void

Comentarios

[ Conjunto de API: WordApi 1.3 ]

setLevelAlignment(level, alignmentString)

Establece la alineación de la viñeta, el número o la imagen en el nivel especificado de la lista.

setLevelAlignment(level: number, alignmentString: "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"): void;

Parámetros

level: number

Obligatorio. Nivel de la lista.

alignmentString: "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"

Obligatorio. Alineación de nivel que debe ser "Left", "Centered" o "Right".

Devoluciones

void

Comentarios

[ Conjunto de API: WordApi 1.3 ]

setLevelBullet(level, listBullet, charCode, fontName)

Establece el formato de viñeta en el nivel especificado de la lista. Si la viñeta es 'Custom', se requiere charCode.

setLevelBullet(level: number, listBullet: Word.ListBullet, charCode?: number, fontName?: string): void;

Parámetros

level: number

Obligatorio. Nivel de la lista.

listBullet: Word.ListBullet

Obligatorio. La bala.

charCode: number

Opcional. Valor de código del carácter de viñeta. Solo se usa si la viñeta es "Custom".

fontName: string

Opcional. Nombre de fuente de la viñeta. Solo se usa si la viñeta es "Custom".

Devoluciones

void

Comentarios

[ Conjunto de API: WordApi 1.3 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/20-lists/organize-list.yaml

// Inserts a list starting with the first paragraph then set numbering and bullet types of the list items.
await Word.run(async (context) => {
  const paragraphs = context.document.body.paragraphs;
  paragraphs.load("$none");

  await context.sync();

  // Use the first paragraph to start a new list.
  const list = paragraphs.items[0].startNewList();
  list.load("$none");

  await context.sync();

  // To add new items to the list, use Start or End on the insertLocation parameter.
  list.insertParagraph("New list item at the start of the list", "Start");
  const paragraph = list.insertParagraph("New list item at the end of the list (set to list level 5)", "End");

  // Set numbering for list level 1.
  list.setLevelNumbering(0, Word.ListNumbering.arabic);

  // Set bullet type for list level 5.
  list.setLevelBullet(4, Word.ListBullet.arrow);

  // Set list level for the last item in this list.
  paragraph.listItem.level = 4;

  list.load("levelTypes");

  await context.sync();
});

setLevelBullet(level, listBulletString, charCode, fontName)

Establece el formato de viñeta en el nivel especificado de la lista. Si la viñeta es 'Custom', se requiere charCode.

setLevelBullet(level: number, listBulletString: "Custom" | "Solid" | "Hollow" | "Square" | "Diamonds" | "Arrow" | "Checkmark", charCode?: number, fontName?: string): void;

Parámetros

level: number

Obligatorio. Nivel de la lista.

listBulletString: "Custom" | "Solid" | "Hollow" | "Square" | "Diamonds" | "Arrow" | "Checkmark"

Obligatorio. La bala.

charCode: number

Opcional. Valor de código del carácter de viñeta. Solo se usa si la viñeta es "Custom".

fontName: string

Opcional. Nombre de fuente de la viñeta. Solo se usa si la viñeta es "Custom".

Devoluciones

void

Comentarios

[ Conjunto de API: WordApi 1.3 ]

setLevelIndents(level, textIndent, bulletNumberPictureIndent)

Establece las dos sangrías del nivel especificado de la lista.

setLevelIndents(level: number, textIndent: number, bulletNumberPictureIndent: number): void;

Parámetros

level: number

Obligatorio. Nivel de la lista.

textIndent: number

Obligatorio. Sangría de texto en puntos. Es igual que la sangría izquierda del párrafo.

bulletNumberPictureIndent: number

Obligatorio. Sangría relativa, en puntos, de la viñeta, número o imagen. Es igual que la sangría de primera línea del párrafo.

Devoluciones

void

Comentarios

[ Conjunto de API: WordApi 1.3 ]

setLevelNumbering(level, listNumbering, formatString)

Establece el formato de numeración en el nivel especificado de la lista.

setLevelNumbering(level: number, listNumbering: Word.ListNumbering, formatString?: Array<string | number>): void;

Parámetros

level: number

Obligatorio. Nivel de la lista.

listNumbering: Word.ListNumbering

Obligatorio. Formato ordinal.

formatString: Array<string | number>

Opcional. Formato de cadena de numeración definido como una matriz de cadenas o enteros. Cada entero es un nivel de tipo de número mayor o igual que este nivel. Por ejemplo, una matriz de ["(", level - 1, ".", level, ")"] puede definir el formato "(2.c)", donde 2 es el número de elemento primario y c es el número de elemento de este nivel.

Devoluciones

void

Comentarios

[ Conjunto de API: WordApi 1.3 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/20-lists/organize-list.yaml

// Inserts a list starting with the first paragraph then set numbering and bullet types of the list items.
await Word.run(async (context) => {
  const paragraphs = context.document.body.paragraphs;
  paragraphs.load("$none");

  await context.sync();

  // Use the first paragraph to start a new list.
  const list = paragraphs.items[0].startNewList();
  list.load("$none");

  await context.sync();

  // To add new items to the list, use Start or End on the insertLocation parameter.
  list.insertParagraph("New list item at the start of the list", "Start");
  const paragraph = list.insertParagraph("New list item at the end of the list (set to list level 5)", "End");

  // Set numbering for list level 1.
  list.setLevelNumbering(0, Word.ListNumbering.arabic);

  // Set bullet type for list level 5.
  list.setLevelBullet(4, Word.ListBullet.arrow);

  // Set list level for the last item in this list.
  paragraph.listItem.level = 4;

  list.load("levelTypes");

  await context.sync();
});

setLevelNumbering(level, listNumberingString, formatString)

Establece el formato de numeración en el nivel especificado de la lista.

setLevelNumbering(level: number, listNumberingString: "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter", formatString?: Array<string | number>): void;

Parámetros

level: number

Obligatorio. Nivel de la lista.

listNumberingString: "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter"

Obligatorio. Formato ordinal.

formatString: Array<string | number>

Devoluciones

void

Comentarios

[ Conjunto de API: WordApi 1.3 ]

setLevelPicture(level, base64EncodedImage)

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.

Establece la imagen en el nivel especificado de la lista.

setLevelPicture(level: number, base64EncodedImage?: string): void;

Parámetros

level: number

Obligatorio. Nivel de la lista.

base64EncodedImage: string

Opcional. Imagen codificada en Base64 que se va a establecer. Si no se especifica, se establece la imagen predeterminada.

Devoluciones

void

Comentarios

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

setLevelStartingNumber(level, startingNumber)

Establece el número de inicio en el nivel especificado de la lista. El valor predeterminado es 1.

setLevelStartingNumber(level: number, startingNumber: number): void;

Parámetros

level: number

Obligatorio. Nivel de la lista.

startingNumber: number

Obligatorio. Número con el que empezar.

Devoluciones

void

Comentarios

[ Conjunto de API: WordApi 1.3 ]

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

toJSON(): Word.Interfaces.ListData;

Devoluciones

Word.Interfaces.ListData

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

Devoluciones

Word.List

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

Devoluciones

Word.List