Excel.TextFrame class
Representa el marco de texto de un objeto de forma.
- Extends
Comentarios
[Conjunto de API: ExcelApi 1.9]
Propiedades
| auto |
La configuración 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. |
| bottom |
Indica el margen inferior, en puntos, del marco de texto. |
| 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. |
| has |
Especifica si el marco de texto contiene texto. |
| horizontal |
Indica la alineación horizontal del marco de texto. Vea |
| horizontal |
Indica el comportamiento de desbordamiento horizontal del marco de texto. Vea |
| left |
Indica el margen izquierdo, en puntos, del marco de texto. |
| orientation | Representa el ángulo en el que se orienta el texto para el marco de texto. Vea |
| reading |
Representa el orden de lectura del marco de texto, ya sea de izquierda a derecha o de derecha a izquierda. Vea |
| right |
Indica el margen derecho, en puntos, del marco de texto. |
| text |
Representa el texto que hay unido a una forma en el marco de texto y las propiedades y los métodos de manipulación del texto. Vea |
| top |
Indica el margen superior, en puntos, del marco de texto. |
| vertical |
Indica la alineación vertical del marco de texto. Vea |
| vertical |
Representa el comportamiento de desbordamiento vertical del marco de texto. Vea |
Métodos
| delete |
Elimina todo el texto en el marco de texto. |
| 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 |
| 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 |
Detalles de las propiedades
autoSizeSetting
La configuración 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: Excel.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed";
Valor de propiedad
Excel.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed"
Comentarios
[Conjunto de API: ExcelApi 1.9]
bottomMargin
Indica el margen inferior, en puntos, del marco de texto.
bottomMargin: number;
Valor de propiedad
number
Comentarios
[Conjunto de API: ExcelApi 1.9]
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
hasText
Especifica si el marco de texto contiene texto.
readonly hasText: boolean;
Valor de propiedad
boolean
Comentarios
[Conjunto de API: ExcelApi 1.9]
horizontalAlignment
Indica la alineación horizontal del marco de texto. Vea Excel.ShapeTextHorizontalAlignment para más información.
horizontalAlignment: Excel.ShapeTextHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";
Valor de propiedad
Excel.ShapeTextHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed"
Comentarios
[Conjunto de API: ExcelApi 1.9]
horizontalOverflow
Indica el comportamiento de desbordamiento horizontal del marco de texto. Vea Excel.ShapeTextHorizontalOverflow para más información.
horizontalOverflow: Excel.ShapeTextHorizontalOverflow | "Overflow" | "Clip";
Valor de propiedad
Excel.ShapeTextHorizontalOverflow | "Overflow" | "Clip"
Comentarios
[Conjunto de API: ExcelApi 1.9]
leftMargin
Indica el margen izquierdo, en puntos, del marco de texto.
leftMargin: number;
Valor de propiedad
number
Comentarios
[Conjunto de API: ExcelApi 1.9]
orientation
Representa el ángulo en el que se orienta el texto para el marco de texto. Vea Excel.ShapeTextOrientation para más información.
orientation: Excel.ShapeTextOrientation | "Horizontal" | "Vertical" | "Vertical270" | "WordArtVertical" | "EastAsianVertical" | "MongolianVertical" | "WordArtVerticalRTL";
Valor de propiedad
Excel.ShapeTextOrientation | "Horizontal" | "Vertical" | "Vertical270" | "WordArtVertical" | "EastAsianVertical" | "MongolianVertical" | "WordArtVerticalRTL"
Comentarios
[Conjunto de API: ExcelApi 1.9]
readingOrder
Representa el orden de lectura del marco de texto, ya sea de izquierda a derecha o de derecha a izquierda. Vea Excel.ShapeTextReadingOrder para más información.
readingOrder: Excel.ShapeTextReadingOrder | "LeftToRight" | "RightToLeft";
Valor de propiedad
Excel.ShapeTextReadingOrder | "LeftToRight" | "RightToLeft"
Comentarios
[Conjunto de API: ExcelApi 1.9]
rightMargin
Indica el margen derecho, en puntos, del marco de texto.
rightMargin: number;
Valor de propiedad
number
Comentarios
[Conjunto de API: ExcelApi 1.9]
textRange
Representa el texto que hay unido a una forma en el marco de texto y las propiedades y los métodos de manipulación del texto. Vea Excel.TextRange para más información.
readonly textRange: Excel.TextRange;
Valor de propiedad
Comentarios
[Conjunto de API: ExcelApi 1.9]
topMargin
Indica el margen superior, en puntos, del marco de texto.
topMargin: number;
Valor de propiedad
number
Comentarios
[Conjunto de API: ExcelApi 1.9]
verticalAlignment
Indica la alineación vertical del marco de texto. Vea Excel.ShapeTextVerticalAlignment para más información.
verticalAlignment: Excel.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom" | "Justified" | "Distributed";
Valor de propiedad
Excel.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom" | "Justified" | "Distributed"
Comentarios
[Conjunto de API: ExcelApi 1.9]
verticalOverflow
Representa el comportamiento de desbordamiento vertical del marco de texto. Vea Excel.ShapeTextVerticalOverflow para más información.
verticalOverflow: Excel.ShapeTextVerticalOverflow | "Overflow" | "Ellipsis" | "Clip";
Valor de propiedad
Excel.ShapeTextVerticalOverflow | "Overflow" | "Ellipsis" | "Clip"
Comentarios
[Conjunto de API: ExcelApi 1.9]
Detalles del método
deleteText()
Elimina todo el texto en el marco de texto.
deleteText(): void;
Devoluciones
void
Comentarios
[Conjunto de API: ExcelApi 1.9]
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?: Excel.Interfaces.TextFrameLoadOptions): Excel.TextFrame;
Parámetros
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[]): Excel.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;
}): Excel.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 API del mismo tipo.
set(properties: Interfaces.TextFrameUpdateData, options?: OfficeExtension.UpdateOptions): void;
Parámetros
- properties
- Excel.Interfaces.TextFrameUpdateData
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: Excel.TextFrame): void;
Parámetros
- properties
- Excel.TextFrame
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 Excel.TextFrame es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.TextFrameData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.
toJSON(): Excel.Interfaces.TextFrameData;