PowerPoint.TextRange class
Contém o texto que é anexado a uma forma, bem como propriedades e métodos para manipular o texto.
- Extends
Comentários
[ Conjunto de API: PowerPointApi 1.4 ]
Propriedades
| context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
| font | Retorna um |
| length | Obtém ou define o comprimento do intervalo que isso |
| paragraph |
Representa o formato de parágrafo do intervalo de texto. Consulte PowerPoint.ParagraphFormat para obter detalhes. |
| start | Obtém ou define índice baseado em zero, em relação ao quadro de texto pai, para a posição inicial do intervalo que isso |
| text | Representa o conteúdo de texto sem formatação do intervalo de texto. |
Métodos
| get |
Retorna o objeto pai PowerPoint.TextFrame que contém este |
| get |
Retorna um |
| load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| set |
Seleciona isso |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
context
O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
context: RequestContext;Valor da propriedade
font
Retorna um ShapeFont objeto que representa os atributos de fonte para o intervalo de texto.
readonly font: PowerPoint.ShapeFont;Valor da propriedade
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
// Sets the color of the selected text range to green.
await PowerPoint.run(async (context) => {
const textRange = context.presentation.getSelectedTextRange();
textRange.font.color = "green";
await context.sync();
});
length
Obtém ou define o comprimento do intervalo que isso TextRange representa. Gera uma exceção InvalidArgument quando definido com um valor negativo ou se o valor for maior que o comprimento do texto disponível do ponto de partida.
length: number;Valor da propriedade
number
Comentários
paragraphFormat
Representa o formato de parágrafo do intervalo de texto. Consulte PowerPoint.ParagraphFormat para obter detalhes.
readonly paragraphFormat: PowerPoint.ParagraphFormat;Valor da propriedade
Comentários
start
Obtém ou define índice baseado em zero, em relação ao quadro de texto pai, para a posição inicial do intervalo que isso TextRange representa. Gera uma exceção InvalidArgument quando definida com um valor negativo ou se o valor for maior que o comprimento do texto.
start: number;Valor da propriedade
number
Comentários
text
Representa o conteúdo de texto sem formatação do intervalo de texto.
text: string;Valor da propriedade
string
Comentários
Detalhes do método
getParentTextFrame()
Retorna o objeto pai PowerPoint.TextFrame que contém este TextRange.
getParentTextFrame(): PowerPoint.TextFrame;Retornos
Comentários
getSubstring(start, length)
Retorna um TextRange objeto para a substring no intervalo determinado.
getSubstring(start: number, length?: number): PowerPoint.TextRange;Parâmetros
- start
-
number
O índice baseado em zero do primeiro caractere a ser obtido do intervalo de texto.
- length
-
number
Opcional. O número de caracteres a serem retornados no novo intervalo de texto. Se o comprimento for omitido, todos os caracteres do início ao final do último parágrafo do intervalo de texto serão retornados.
Retornos
Comentários
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.TextRangeLoadOptions): PowerPoint.TextRange;Parâmetros
Fornece opções para quais propriedades do objeto carregar.
Retornos
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.TextRange;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.
Retornos
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.TextRange;Parâmetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.
Retornos
setSelected()
Seleciona isso TextRange no modo de exibição atual.
setSelected(): void;Retornos
void
Comentários
[ Conjunto de API: PowerPointApi 1.5 ]
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 = 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 = shapes.getItemAt(0);
const 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 = 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();
});
...
// Sets the range selection to the range that was saved previously.
await PowerPoint.run(async (context) => {
const slide1 = context.presentation.slides.getItem(savedTextSlideSelection[0]);
const shape1 = slide1.shapes.getItem(savedTextShapeSelection[0]);
const textRange = shape1.textFrame.textRange.getSubstring(savedTextTextRangeStart, savedTextTextRangeLength);
textRange.setSelected();
await context.sync();
});
toJSON()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto PowerPoint.TextRange original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como PowerPoint.Interfaces.TextRangeData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.
toJSON(): PowerPoint.Interfaces.TextRangeData;Retornos
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de