Compartir a través de


Word.ShapeCollection class

Contiene una colección de Word. Objetos Shape. Actualmente, solo se admiten las formas siguientes: cuadros de texto, formas geométricas, grupos, imágenes y lienzos.

Extends

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Propiedades

context

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

items

Obtiene los elementos secundarios cargados en esta colección.

Métodos

getByGeometricTypes(types)

Obtiene las formas que tienen los tipos geométricos especificados. Solo se aplica a formas geométricas.

getById(id)

Obtiene una forma por su identificador. Produce un ItemNotFound error si no hay una forma con el identificador de esta colección.

getByIdOrNullObject(id)

Obtiene una forma por su identificador. Si no hay una forma con el identificador en esta colección, 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).

getByIds(ids)

Obtiene las formas por los identificadores.

getByNames(names)

Obtiene las formas que tienen los nombres especificados.

getByTypes(types)

Obtiene las formas que tienen los tipos especificados.

getFirst()

Obtiene la primera forma de esta colección. Produce un ItemNotFound error si esta colección está vacía.

getFirstOrNullObject()

Obtiene la primera forma de esta colección. Si esta colección está vacía, 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).

group()

Se omitirán las formas flotantes de grupos de esta colección. Devuelve un objeto Shape que representa el nuevo grupo de formas.

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.

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 objeto original Word.ShapeCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Word.Interfaces.ShapeCollectionData) que contiene una matriz de "elementos" con copias superficiales de las propiedades cargadas de los elementos de la colección.

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

items

Obtiene los elementos secundarios cargados en esta colección.

readonly items: Word.Shape[];

Valor de propiedad

Detalles del método

getByGeometricTypes(types)

Obtiene las formas que tienen los tipos geométricos especificados. Solo se aplica a formas geométricas.

getByGeometricTypes(types: Word.GeometricShapeType[]): Word.ShapeCollection;

Parámetros

types

Word.GeometricShapeType[]

Obligatorio. Matriz de subtipos de formas geométricas.

Devoluciones

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

getById(id)

Obtiene una forma por su identificador. Produce un ItemNotFound error si no hay una forma con el identificador de esta colección.

getById(id: number): Word.Shape;

Parámetros

id

number

Obligatorio. Identificador de forma.

Devoluciones

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

getByIdOrNullObject(id)

Obtiene una forma por su identificador. Si no hay una forma con el identificador en esta colección, 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).

getByIdOrNullObject(id: number): Word.Shape;

Parámetros

id

number

Obligatorio. Identificador de forma.

Devoluciones

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

getByIds(ids)

Obtiene las formas por los identificadores.

getByIds(ids: number[]): Word.ShapeCollection;

Parámetros

ids

number[]

Obligatorio. Matriz de identificadores de formas.

Devoluciones

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

getByNames(names)

Obtiene las formas que tienen los nombres especificados.

getByNames(names: string[]): Word.ShapeCollection;

Parámetros

names

string[]

Obligatorio. Matriz de nombres de formas.

Devoluciones

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

getByTypes(types)

Obtiene las formas que tienen los tipos especificados.

getByTypes(types: Word.ShapeType[]): Word.ShapeCollection;

Parámetros

types

Word.ShapeType[]

Obligatorio. Matriz de tipos de formas.

Devoluciones

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

getFirst()

Obtiene la primera forma de esta colección. Produce un ItemNotFound error si esta colección está vacía.

getFirst(): Word.Shape;

Devoluciones

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

getFirstOrNullObject()

Obtiene la primera forma de esta colección. Si esta colección está vacía, 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).

getFirstOrNullObject(): Word.Shape;

Devoluciones

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

group()

Se omitirán las formas flotantes de grupos de esta colección. Devuelve un objeto Shape que representa el nuevo grupo de formas.

group(): Word.Shape;

Devoluciones

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

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.ShapeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ShapeCollection;

Parámetros

options

Word.Interfaces.ShapeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions

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

Devoluciones

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

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

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?: OfficeExtension.LoadOption): Word.ShapeCollection;

Parámetros

propertyNamesAndPaths
OfficeExtension.LoadOption

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

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 objeto original Word.ShapeCollection es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Word.Interfaces.ShapeCollectionData) que contiene una matriz de "elementos" con copias superficiales de las propiedades cargadas de los elementos de la colección.

toJSON(): Word.Interfaces.ShapeCollectionData;

Devoluciones

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

Devoluciones

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

Devoluciones