Word.ShapeTextWrap class

Paquete:

word

Representa todas las propiedades para ajustar el texto alrededor de una forma.

Extends

OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Propiedades

bottomDistance	Especifica la distancia (en puntos) entre el texto del documento y el borde inferior del área sin texto que rodea la forma especificada.
context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
leftDistance	Especifica la distancia (en puntos) entre el texto del documento y el borde izquierdo del área sin texto que rodea la forma especificada.
rightDistance	Especifica la distancia (en puntos) entre el texto del documento y el borde derecho del área sin texto que rodea la forma especificada.
side	Especifica si el texto del documento debe ajustarse a ambos lados de la forma especificada, solo en el lado izquierdo o derecho, o en el lado de la forma más alejada del margen de la página.
topDistance	Especifica la distancia (en puntos) entre el texto del documento y el borde superior del área sin texto que rodea la forma especificada.
type	Especifica el tipo de ajuste de texto alrededor de la forma. Vea Word.ShapeTextWrapType para más información.

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 objeto original Word.ShapeTextWrap es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Word.Interfaces.ShapeTextWrapData) 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

bottomDistance

Especifica la distancia (en puntos) entre el texto del documento y el borde inferior del área sin texto que rodea la forma especificada.

bottomDistance: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

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

leftDistance

Especifica la distancia (en puntos) entre el texto del documento y el borde izquierdo del área sin texto que rodea la forma especificada.

leftDistance: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

rightDistance

Especifica la distancia (en puntos) entre el texto del documento y el borde derecho del área sin texto que rodea la forma especificada.

rightDistance: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

side

Especifica si el texto del documento debe ajustarse a ambos lados de la forma especificada, solo en el lado izquierdo o derecho, o en el lado de la forma más alejada del margen de la página.

side: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest";

Valor de propiedad

Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest"

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

topDistance

Especifica la distancia (en puntos) entre el texto del documento y el borde superior del área sin texto que rodea la forma especificada.

topDistance: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

type

Especifica el tipo de ajuste de texto alrededor de la forma. Vea Word.ShapeTextWrapType para más información.

type: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front";

Valor de propiedad

Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front"

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

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.ShapeTextWrapLoadOptions): Word.ShapeTextWrap;

Parámetros

options

Word.Interfaces.ShapeTextWrapLoadOptions

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

Devoluciones

Word.ShapeTextWrap

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

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

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

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

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

Parámetros

properties

Word.Interfaces.ShapeTextWrapUpdateData

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

Parámetros

properties

Word.ShapeTextWrap

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

toJSON(): Word.Interfaces.ShapeTextWrapData;

Devoluciones

Word.Interfaces.ShapeTextWrapData

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

Devoluciones

Word.ShapeTextWrap

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

Devoluciones

Word.ShapeTextWrap