Compartir a través de

PowerPoint.TextFrame class

  • Referencia
Paquete:
powerpoint

Representa el marco de texto de un objeto de forma.

Extends
OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: PowerPointApi 1.4 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/text/get-set-textrange.yaml

// Selects the first 10 characters of the selected shape.
await PowerPoint.run(async (context) => {
  const shapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();
  const shapeCount = shapes.getCount();
  await context.sync();
  if (shapeCount.value !== 1) {
    console.warn("You must select only one shape with text in it.");
    return;
  }
  const shape: PowerPoint.Shape = shapes.getItemAt(0);
  const textFrame: PowerPoint.TextFrame = shape.textFrame.load("textRange,hasText");
  await context.sync();
  if (textFrame.hasText != true) {
    console.warn("You must select only one shape with text in it.");
    return;
  }
  const textRange: PowerPoint.TextRange = textFrame.textRange;
  textRange.load("text");
  await context.sync();
  if (textRange.text.length < 10) {
    console.warn("You must select only one shape with at least 10 characters in it.");
    return;
  }
  const textRange10 = textRange.getSubstring(0, 10);
  textRange10.setSelected();
  await context.sync();
});

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.
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. Consulte PowerPoint.TextRange para obtener 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 PowerPoint.TextVerticalAlignment para obtener más información.
wordWrap

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

Métodos

deleteText()

Elimina todo el texto en el marco de texto.
getParentShape()

Devuelve el objeto PowerPoint.Shape primario que contiene este TextFrameobjeto .
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.
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 PowerPoint.TextFrame es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como PowerPoint.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: PowerPoint.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed";

Valor de propiedad

PowerPoint.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed"

Comentarios

[ Conjunto de API: PowerPointApi 1.4 ]

bottomMargin

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

bottomMargin: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: PowerPointApi 1.4 ]

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

PowerPoint.RequestContext

hasText

Especifica si el marco de texto contiene texto.

readonly hasText: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: PowerPointApi 1.4 ]

leftMargin

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

leftMargin: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: PowerPointApi 1.4 ]

rightMargin

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

rightMargin: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: PowerPointApi 1.4 ]

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. Consulte PowerPoint.TextRange para obtener más información.

readonly textRange: PowerPoint.TextRange;

Valor de propiedad

PowerPoint.TextRange

Comentarios

[ Conjunto de API: PowerPointApi 1.4 ]

topMargin

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

topMargin: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: PowerPointApi 1.4 ]

verticalAlignment

Indica la alineación vertical del marco de texto. Vea PowerPoint.TextVerticalAlignment para obtener más información.

verticalAlignment: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered";

Valor de propiedad

PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered"

Comentarios

[ Conjunto de API: PowerPointApi 1.4 ]

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: PowerPointApi 1.4 ]

Detalles del método

deleteText()

Elimina todo el texto en el marco de texto.

deleteText(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: PowerPointApi 1.4 ]

getParentShape()

Devuelve el objeto PowerPoint.Shape primario que contiene este TextFrameobjeto .

getParentShape(): PowerPoint.Shape;

Devoluciones

PowerPoint.Shape

Comentarios

[ Conjunto de API: PowerPointApi 1.5 ]

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?: PowerPoint.Interfaces.TextFrameLoadOptions): PowerPoint.TextFrame;

Parámetros

options
PowerPoint.Interfaces.TextFrameLoadOptions

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

Devoluciones

PowerPoint.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[]): PowerPoint.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

PowerPoint.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;
        }): PowerPoint.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

PowerPoint.TextFrame

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

toJSON(): PowerPoint.Interfaces.TextFrameData;

Devoluciones

PowerPoint.Interfaces.TextFrameData