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 ]
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: PowerPoint.TextRange = context.presentation.getSelectedTextRange();
textRange.font.color = "green";
await context.sync();
});
Propriedades
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| font | Devolve um |
| hyperlinks | Devolve uma coleção de hiperligações existentes neste |
| length | Obtém ou define o comprimento do intervalo que isto |
| paragraph |
Representa o formato de parágrafo do intervalo de texto. Veja PowerPoint.ParagraphFormat para obter detalhes. |
| start | Obtém ou define o índice baseado em zero, em relação à moldura de texto principal, para a posição inicial do intervalo que isto |
| text | Representa o conteúdo de texto sem formatação do intervalo de texto. |
Métodos
| get |
Devolve o objeto principal PowerPoint.TextFrame que contém este |
| get |
Devolve 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 |
Define uma hiperligação com |
| set |
Seleciona esta |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
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
font
Devolve um ShapeFont objeto que representa os atributos do tipo de letra 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: PowerPoint.TextRange = context.presentation.getSelectedTextRange();
textRange.font.color = "green";
await context.sync();
});
hyperlinks
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Devolve uma coleção de hiperligações existentes neste TextRange.
readonly hyperlinks: PowerPoint.HyperlinkScopedCollection;Valor da propriedade
Comentários
[ Conjunto de API: PowerPointApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]
length
Obtém ou define o comprimento do intervalo que isto TextRange representa. Gera uma exceção InvalidArgument quando definida com um valor negativo ou se o valor for maior do que o comprimento do texto disponível a partir do ponto de partida.
length: number;Valor da propriedade
number
Comentários
paragraphFormat
Representa o formato de parágrafo do intervalo de texto. Veja PowerPoint.ParagraphFormat para obter detalhes.
readonly paragraphFormat: PowerPoint.ParagraphFormat;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
// Gets navigational (complex) properties of the selected text range.
await PowerPoint.run(async (context) => {
const textRange: PowerPoint.TextRange = context.presentation.getSelectedTextRange();
textRange.load("font,paragraphFormat/bulletFormat,paragraphFormat/horizontalAlignment");
await context.sync();
console.log("Font properties of selected text range:");
console.log(`\tallCaps: ${textRange.font.allCaps}`);
console.log(`\tbold: ${textRange.font.bold}`);
console.log(`\tcolor: ${textRange.font.color}`);
console.log(`\tdoubleStrikethrough: ${textRange.font.doubleStrikethrough}`);
console.log(`\titalic: ${textRange.font.italic}`);
console.log(`\tname: ${textRange.font.name}`);
console.log(`\tsize: ${textRange.font.size}`);
console.log(`\tsmallCaps: ${textRange.font.smallCaps}`);
console.log(`\tstrikethrough: ${textRange.font.strikethrough}`);
console.log(`\tsubscript: ${textRange.font.subscript}`);
console.log(`\tsuperscript: ${textRange.font.superscript}`);
console.log(`\tunderline: ${textRange.font.underline}`);
console.log("Paragraph format properties of selected text range:");
console.log(`\tbulletFormat.visible: ${textRange.paragraphFormat.bulletFormat.visible}`);
console.log(`\thorizontalAlignment: ${textRange.paragraphFormat.horizontalAlignment}`);
});
start
Obtém ou define o índice baseado em zero, em relação à moldura de texto principal, para a posição inicial do intervalo que isto TextRange representa. Gera uma exceção InvalidArgument quando definida com um valor negativo ou se o valor for maior do 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()
Devolve o objeto principal PowerPoint.TextFrame que contém este TextRange.
getParentTextFrame(): PowerPoint.TextFrame;Retornos
Comentários
getSubstring(start, length)
Devolve um TextRange objeto para a subcadeia no intervalo especificado.
getSubstring(start: number, length?: number): PowerPoint.TextRange;Parâmetros
- start
-
number
O índice baseado em zero do primeiro caráter a obter a partir do intervalo de texto.
- length
-
number
Opcional. O número de carateres a devolver no novo intervalo de texto. Se o comprimento for omitido, todos os carateres do início ao fim do último parágrafo do intervalo de texto serão devolvidos.
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 as propriedades do objeto a 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 delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
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 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
setHyperlink(options)
Observação
Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.
Define uma hiperligação com TextRange as opções especificadas. Esta ação irá eliminar todas as hiperligações existentes neste TextRange.
setHyperlink(options?: PowerPoint.HyperlinkAddOptions): PowerPoint.Hyperlink;Parâmetros
- options
- PowerPoint.HyperlinkAddOptions
Opcional. As opções para a hiperligação.
Retornos
O objeto PowerPoint.Hyperlink recentemente criado.
Comentários
[ Conjunto de API: PowerPointApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]
setSelected()
Seleciona esta TextRange opção na vista 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: 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();
});
...
// Sets the range selection to the range that was saved previously.
await PowerPoint.run(async (context) => {
const slide1: PowerPoint.Slide = context.presentation.slides.getItem(savedTextSlideSelection[0]);
const shape1: PowerPoint.Shape = slide1.shapes.getItem(savedTextShapeSelection[0]);
const textRange: PowerPoint.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 é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original PowerPoint.TextRange é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como PowerPoint.Interfaces.TextRangeData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): PowerPoint.Interfaces.TextRangeData;