Word.Frame class
Representa un marco. El Frame objeto es un miembro de Word. objeto FrameCollection.
- Extends
Propiedades
| borders | Devuelve un |
| context | El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office. |
| height | Especifica la altura (en puntos) del marco. |
| height |
Especifica un |
| horizontal |
Especifica la distancia horizontal entre el marco y el texto adyacente, en puntos. |
| horizontal |
Especifica la distancia horizontal entre el borde del marco y el elemento especificado por la |
| lock |
Especifica si el marco está bloqueado. |
| range | Devuelve un |
| relative |
Especifica la posición horizontal relativa del marco. |
| relative |
Especifica la posición vertical relativa del marco. |
| shading | Devuelve un |
| text |
Especifica si el texto del documento se ajusta alrededor del marco. |
| vertical |
Especifica la distancia vertical (en puntos) entre el marco y el texto adyacente. |
| vertical |
Especifica la distancia vertical entre el borde del marco y el elemento especificado por la |
| width | Especifica la anchura (en puntos) del marco. |
| width |
Especifica la regla utilizada para determinar la anchura del marco. |
Métodos
| copy() | Copia el fotograma en el Portapapeles. |
| cut() | Quita el marco del documento y lo coloca en el Portapapeles. |
| delete() | Elimina el marco. |
| load(options) | Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| select() | Selecciona el marco. |
| 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 API del mismo tipo. |
| set(properties) | Establece varias propiedades en el objeto al mismo tiempo, basadas en un objeto cargado existente. |
| toJSON() | Reemplaza el método JavaScript |
| track() | Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura de context.trackedObjects.add(thisObject). Si usa este objeto entre |
| untrack() | Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es la abreviatura de 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. Deberá llamar |
Detalles de las propiedades
borders
Devuelve un BorderUniversalCollection objeto que representa todos los bordes del marco.
readonly borders: Word.BorderUniversalCollection;Valor de propiedad
Comentarios
context
El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.
context: RequestContext;Valor de propiedad
height
Especifica la altura (en puntos) del marco.
height: number;Valor de propiedad
number
Comentarios
heightRule
Especifica un FrameSizeRule valor que representa la regla para determinar la altura del marco.
heightRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact";Valor de propiedad
Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"
Comentarios
horizontalDistanceFromText
Especifica la distancia horizontal entre el marco y el texto adyacente, en puntos.
horizontalDistanceFromText: number;Valor de propiedad
number
Comentarios
horizontalPosition
Especifica la distancia horizontal entre el borde del marco y el elemento especificado por la relativeHorizontalPosition propiedad.
horizontalPosition: number;Valor de propiedad
number
Comentarios
lockAnchor
Especifica si el marco está bloqueado.
lockAnchor: boolean;Valor de propiedad
boolean
Comentarios
range
Devuelve un Range objeto que representa la parte del documento contenida en el marco.
readonly range: Word.Range;Valor de propiedad
Comentarios
relativeHorizontalPosition
Especifica la posición horizontal relativa del marco.
relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";Valor de propiedad
Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"
Comentarios
relativeVerticalPosition
Especifica la posición vertical relativa del marco.
relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";Valor de propiedad
Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"
Comentarios
shading
Devuelve un ShadingUniversal objeto que hace referencia al formato de sombreado del marco.
readonly shading: Word.ShadingUniversal;Valor de propiedad
Comentarios
textWrap
Especifica si el texto del documento se ajusta alrededor del marco.
textWrap: boolean;Valor de propiedad
boolean
Comentarios
verticalDistanceFromText
Especifica la distancia vertical (en puntos) entre el marco y el texto adyacente.
verticalDistanceFromText: number;Valor de propiedad
number
Comentarios
verticalPosition
Especifica la distancia vertical entre el borde del marco y el elemento especificado por la relativeVerticalPosition propiedad.
verticalPosition: number;Valor de propiedad
number
Comentarios
width
Especifica la anchura (en puntos) del marco.
width: number;Valor de propiedad
number
Comentarios
widthRule
Especifica la regla utilizada para determinar la anchura del marco.
widthRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact";Valor de propiedad
Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"
Comentarios
Detalles del método
copy()
Copia el fotograma en el Portapapeles.
copy(): void;Devoluciones
void
Comentarios
cut()
Quita el marco del documento y lo coloca en el Portapapeles.
cut(): void;Devoluciones
void
Comentarios
delete()
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.FrameLoadOptions): Word.Frame;Parámetros
- options
- Word.Interfaces.FrameLoadOptions
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.Frame;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.Frame;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
select()
Selecciona el marco.
select(): void;Devoluciones
void
Comentarios
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 API del mismo tipo.
set(properties: Interfaces.FrameUpdateData, options?: OfficeExtension.UpdateOptions): void;Parámetros
- properties
- Word.Interfaces.FrameUpdateData
Un objeto JavaScript con propiedades que están estructuradas isomorfamente a las propiedades del objeto en el 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, basadas en un objeto cargado existente.
set(properties: Word.Frame): void;Parámetros
- properties
- Word.Frame
Devoluciones
void
toJSON()
Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Word.Frame es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Word.Interfaces.FrameData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.
toJSON(): Word.Interfaces.FrameData;Devoluciones
track()
Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura de context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y recibe 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 objeto 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.Frame;Devoluciones
untrack()
Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es la abreviatura de 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. Deberá llamar context.sync() antes de que la liberación de memoria surta efecto.
untrack(): Word.Frame;