Compartir a través de


Word.TextFrame class

Representa el marco de texto de un objeto de forma.

Extends

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

Propiedades

autoSizeSetting

La configuración de ajuste de tamaño automático para el marco de texto. Un marco de texto puede establecerse para ajustar automáticamente el texto al marco de texto, ajustar automáticamente el marco de texto al texto o no realizar ningún cambio de tamaño automático.

bottomMargin

Indica el margen inferior, en puntos, del marco de texto.

context

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

hasText

Especifica si el marco de texto contiene texto.

leftMargin

Indica el margen izquierdo, en puntos, del marco de texto.

noTextRotation

Devuelve True si el texto del marco de texto no debe girar cuando se gira la forma.

orientation

Representa el ángulo al que está orientado el texto para el marco de texto. Vea Word.ShapeTextOrientation para más información.

rightMargin

Indica el margen derecho, en puntos, del marco de texto.

topMargin

Indica el margen superior, en puntos, del marco de texto.

verticalAlignment

Indica la alineación vertical del marco de texto. Vea Word.ShapeTextVerticalAlignment para más información.

wordWrap

Determina si las líneas se interrumpen automáticamente para ajustar el texto dentro de la forma.

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

autoSizeSetting

La configuración de ajuste de tamaño automático para el marco de texto. Un marco de texto puede establecerse para ajustar automáticamente el texto al marco de texto, ajustar automáticamente el marco de texto al texto o no realizar ningún cambio de tamaño automático.

autoSizeSetting: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed";

Valor de propiedad

Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

bottomMargin

Indica el margen inferior, en puntos, del marco de texto.

bottomMargin: 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

hasText

Especifica si el marco de texto contiene texto.

readonly hasText: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

leftMargin

Indica el margen izquierdo, en puntos, del marco de texto.

leftMargin: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

noTextRotation

Devuelve True si el texto del marco de texto no debe girar cuando se gira la forma.

noTextRotation: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

orientation

Representa el ángulo al que está orientado el texto para el marco de texto. Vea Word.ShapeTextOrientation para más información.

orientation: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed";

Valor de propiedad

Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

rightMargin

Indica el margen derecho, en puntos, del marco de texto.

rightMargin: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

topMargin

Indica el margen superior, en puntos, del marco de texto.

topMargin: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

verticalAlignment

Indica la alineación vertical del marco de texto. Vea Word.ShapeTextVerticalAlignment para más información.

verticalAlignment: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom";

Valor de propiedad

Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"

Comentarios

[ Conjunto de API: WordApiDesktop 1.2 ]

wordWrap

Determina si las líneas se interrumpen automáticamente para ajustar el texto dentro de la forma.

wordWrap: boolean;

Valor de propiedad

boolean

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.TextFrameLoadOptions): Word.TextFrame;

Parámetros

options
Word.Interfaces.TextFrameLoadOptions

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

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?: {
            select?: string;
            expand?: string;
        }): Word.TextFrame;

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

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

Parámetros

properties
Word.Interfaces.TextFrameUpdateData

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

Parámetros

properties
Word.TextFrame

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

toJSON(): Word.Interfaces.TextFrameData;

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

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

Devoluciones