Excel.TextFrame class

  • Referencia
Paquete:
excel

Representa el marco de texto de un objeto de forma.

Extends
OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

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

Indica la alineación horizontal del marco de texto. Vea Excel.ShapeTextHorizontalAlignment para más información.
horizontalOverflow

Indica el comportamiento de desbordamiento horizontal del marco de texto. Vea Excel.ShapeTextHorizontalOverflow para más información.
leftMargin

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

Representa el ángulo al que está orientado el texto para el marco de texto. Vea Excel.ShapeTextOrientation para más información.
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.
rightMargin

Indica el margen derecho, en puntos, del marco de texto.
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.
topMargin

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

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

Representa el comportamiento de desbordamiento vertical del marco de texto. Vea Excel.ShapeTextVerticalOverflow para más información.

Métodos

deleteText()

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

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

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

Excel.RequestContext

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 al que está orientado 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

Excel.TextRange

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 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-textboxes.yaml

await Excel.run(async (context) => {
    const shapes = context.workbook.worksheets.getItem("Shapes").shapes;
    const textbox = shapes.getItem("Textbox");
    textbox.textFrame.deleteText();
    await context.sync();
});

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

options
Excel.Interfaces.TextFrameLoadOptions

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

Devoluciones

Excel.TextFrame

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

Excel.TextFrame

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

Excel.TextFrame

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

Parámetros

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

toJSON(): Excel.Interfaces.TextFrameData;

Devoluciones

Excel.Interfaces.TextFrameData