Word.ListItem class

Paquete:

word

Representa el formato de elemento de lista de párrafos.

Extends

OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: WordApi 1.3 ]

Propiedades

context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
level	Especifica el nivel del elemento de la lista.
listString	Obtiene la viñeta, el número o la imagen del elemento de lista como una cadena.
siblingIndex	Obtiene el número de ordenación del elemento de lista en relación a los de su mismo nivel.

Métodos

getAncestor(parentOnly)	Obtiene el elemento primario del elemento de lista o el antecesor más cercano si el elemento primario no existe. Produce un ItemNotFound error si el elemento de lista no tiene antecesor.
getAncestorOrNullObject(parentOnly)	Obtiene el elemento primario del elemento de lista o el antecesor más cercano si el elemento primario no existe. Si el elemento de lista no tiene antecesor, este método devolverá un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).
getDescendants(directChildrenOnly)	Obtiene todos los elementos de lista descendientes del elemento de lista.
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 ListItem es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Word.Interfaces.ListItemData) 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

level

Especifica el nivel del elemento de la lista.

level: number;

Valor de propiedad

number

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();
});

listString

Obtiene la viñeta, el número o la imagen del elemento de lista como una cadena.

readonly listString: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApi 1.3 ]

siblingIndex

Obtiene el número de ordenación del elemento de lista en relación a los de su mismo nivel.

readonly siblingIndex: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApi 1.3 ]

Detalles del método

getAncestor(parentOnly)

Obtiene el elemento primario del elemento de lista o el antecesor más cercano si el elemento primario no existe. Produce un ItemNotFound error si el elemento de lista no tiene antecesor.

getAncestor(parentOnly?: boolean): Word.Paragraph;

Parámetros

parentOnly

boolean

Opcional. Especifica que solo se devolverá el elemento primario del elemento de lista. El valor predeterminado es false que especifica para obtener el antecesor más bajo.

Devoluciones

Word.Paragraph

Comentarios

[ Conjunto de API: WordApi 1.3 ]

getAncestorOrNullObject(parentOnly)

Obtiene el elemento primario del elemento de lista o el antecesor más cercano si el elemento primario no existe. Si el elemento de lista no tiene antecesor, este método devolverá un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

getAncestorOrNullObject(parentOnly?: boolean): Word.Paragraph;

Parámetros

parentOnly

boolean

Opcional. Especifica que solo se devolverá el elemento primario del elemento de lista. El valor predeterminado es false que especifica para obtener el antecesor más bajo.

Devoluciones

Word.Paragraph

Comentarios

[ Conjunto de API: WordApi 1.3 ]

getDescendants(directChildrenOnly)

Obtiene todos los elementos de lista descendientes del elemento de lista.

getDescendants(directChildrenOnly?: boolean): Word.ParagraphCollection;

Parámetros

directChildrenOnly

boolean

Opcional. Especifica que solo se devolverán los elementos secundarios directos del elemento de lista. El valor predeterminado es false que indica que se obtienen todos los elementos descendientes.

Devoluciones

Word.ParagraphCollection

Comentarios

[ Conjunto de API: WordApi 1.3 ]

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.ListItemLoadOptions): Word.ListItem;

Parámetros

options

Word.Interfaces.ListItemLoadOptions

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

Devoluciones

Word.ListItem

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

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

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

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

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

Parámetros

properties

Word.Interfaces.ListItemUpdateData

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

Parámetros

properties

Word.ListItem

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

toJSON(): Word.Interfaces.ListItemData;

Devoluciones

Word.Interfaces.ListItemData

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

Devoluciones

Word.ListItem

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

Devoluciones

Word.ListItem