Compartilhar via

PowerPoint.TextFrame class

  • Referência
Pacote:
powerpoint

Representa a moldura de texto de um objeto de forma.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: PowerPointApi 1.4 ]

Exemplos

// 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();
});

Propriedades

autoSizeSetting

As definições de dimensionamento automático para a moldura de texto. Um quadro de texto pode ser configurado para ajustar automaticamente o texto ao quadro de texto, para ajustar automaticamente o quadro do texto ao texto ou não executar qualquer dimensionamento automático.
bottomMargin

Representa margem inferior, em pontos, do quadro de texto.
context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
hasText

Especifica se a moldura de texto contém texto.
leftMargin

Representa margem esquerda, em pontos, do quadro de texto.
rightMargin

Representa margem direita, em pontos, do quadro de texto.
textRange

Representa o texto que está anexado a uma forma, bem como propriedades e métodos para manipular o texto. Consulte PowerPoint.TextRange para obter detalhes.
topMargin

Representa margem superior, em pontos, do quadro de texto.
verticalAlignment

Representa o alinhamento vertical do quadro de texto. Consulte PowerPoint.TextVerticalAlignment para obter detalhes.
wordWrap

Determina se as linhas quebram automaticamente para se ajustarem ao texto dentro da forma.

Métodos

deleteText()

Exclui todo o texto no quadro de texto.
getParentShape()

Devolve o objeto principal PowerPoint.Shape que contém este TextFrame.
load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original PowerPoint.TextFrame é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como PowerPoint.Interfaces.TextFrameData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

Detalhes da propriedade

autoSizeSetting

As definições de dimensionamento automático para a moldura de texto. Um quadro de texto pode ser configurado para ajustar automaticamente o texto ao quadro de texto, para ajustar automaticamente o quadro do texto ao texto ou não executar qualquer dimensionamento automático.

autoSizeSetting: PowerPoint.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed";

Valor da propriedade

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

Comentários

[ Conjunto de API: PowerPointApi 1.4 ]

bottomMargin

Representa margem inferior, em pontos, do quadro de texto.

bottomMargin: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: PowerPointApi 1.4 ]

context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

PowerPoint.RequestContext

hasText

Especifica se a moldura de texto contém texto.

readonly hasText: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: PowerPointApi 1.4 ]

leftMargin

Representa margem esquerda, em pontos, do quadro de texto.

leftMargin: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: PowerPointApi 1.4 ]

rightMargin

Representa margem direita, em pontos, do quadro de texto.

rightMargin: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: PowerPointApi 1.4 ]

textRange

Representa o texto que está anexado a uma forma, bem como propriedades e métodos para manipular o texto. Consulte PowerPoint.TextRange para obter detalhes.

readonly textRange: PowerPoint.TextRange;

Valor da propriedade

PowerPoint.TextRange

Comentários

[ Conjunto de API: PowerPointApi 1.4 ]

topMargin

Representa margem superior, em pontos, do quadro de texto.

topMargin: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: PowerPointApi 1.4 ]

verticalAlignment

Representa o alinhamento vertical do quadro de texto. Consulte PowerPoint.TextVerticalAlignment para obter detalhes.

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

Valor da propriedade

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

Comentários

[ Conjunto de API: PowerPointApi 1.4 ]

wordWrap

Determina se as linhas quebram automaticamente para se ajustarem ao texto dentro da forma.

wordWrap: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: PowerPointApi 1.4 ]

Detalhes do método

deleteText()

Exclui todo o texto no quadro de texto.

deleteText(): void;

Retornos

void

Comentários

[ Conjunto de API: PowerPointApi 1.4 ]

getParentShape()

Devolve o objeto principal PowerPoint.Shape que contém este TextFrame.

getParentShape(): PowerPoint.Shape;

Retornos

PowerPoint.Shape

Comentários

[ Conjunto de API: PowerPointApi 1.5 ]

load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(options?: PowerPoint.Interfaces.TextFrameLoadOptions): PowerPoint.TextFrame;

Parâmetros

options
PowerPoint.Interfaces.TextFrameLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

PowerPoint.TextFrame

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNames?: string | string[]): PowerPoint.TextFrame;

Parâmetros

propertyNames

string | string[]

Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

Retornos

PowerPoint.TextFrame

load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): PowerPoint.TextFrame;

Parâmetros

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.

Retornos

PowerPoint.TextFrame

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original PowerPoint.TextFrame é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como PowerPoint.Interfaces.TextFrameData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): PowerPoint.Interfaces.TextFrameData;

Retornos

PowerPoint.Interfaces.TextFrameData