Word.Paragraph class
Representa um único parágrafo em uma seleção, intervalo, controle de conteúdo ou corpo do documento.
- Extends
Comentários
[ Conjunto de API: WordApi 1.1 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/get-paragraph-on-insertion-point.yaml
await Word.run(async (context) => {
// The collection of paragraphs of the current selection returns the full paragraphs contained in it.
const paragraph: Word.Paragraph = context.document.getSelection().paragraphs.getFirst();
paragraph.load("text");
await context.sync();
console.log(paragraph.text);
});
Propriedades
alignment | Especifica o alinhamento de um parágrafo. O valor pode ser 'left', 'centered', 'right' ou 'justified'. |
content |
Obtém a coleção de objetos de controlo de conteúdo no parágrafo. |
context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
endnotes | Obtém a coleção de notas de fim no parágrafo. |
fields | Obtém a coleção de campos no parágrafo. |
first |
Especifica o valor, em pontos, para uma primeira linha ou avanço pendente. Use um valor positivo para definir um recuo da primeira linha e use um valor negativo para definir um recuo deslocado. |
font | Obtém o formato de texto do parágrafo. Use isto para obter e definir o nome, o tamanho e a cor da fonte, além de outras propriedades. |
footnotes | Obtém a coleção de notas de rodapé no parágrafo. |
inline |
Obtém a coleção de objetos InlinePicture no parágrafo. A coleção não inclui imagens flutuantes. |
is |
Indica que o parágrafo é o último dentro do corpo do pai. |
is |
Verifica se o parágrafo é um item da lista. |
left |
Especifica o valor de avanço esquerdo, em pontos, para o parágrafo. |
line |
Especifica o espaçamento entre linhas, em pontos, para o parágrafo especificado. Na interface do usuário do Word, esse valor é dividido por 12. |
line |
Especifica a quantidade de espaçamento, nas linhas de grelha, após o parágrafo. |
line |
Especifica a quantidade de espaçamento, nas linhas de grelha, antes do parágrafo. |
list | Obtém a lista à qual pertence esse parágrafo. Gera um |
list |
Obtém o ListItem para o parágrafo. Gera um |
list |
Obtém o ListItem para o parágrafo. Se o parágrafo não fizer parte de uma lista, este método devolverá um objeto com a respetiva |
list |
Obtém a lista à qual pertence esse parágrafo. Se o parágrafo não estiver numa lista, este método devolverá um objeto com a respetiva |
outline |
Especifica o nível hierárquico do parágrafo. |
parent |
Obtém o corpo pai do parágrafo. |
parent |
Obtém o controle de conteúdo que inclui o parágrafo. Gera um |
parent |
Obtém o controle de conteúdo que inclui o parágrafo. Se não existir um controlo de conteúdo principal, este método devolverá um objeto com a respetiva |
parent |
Obtém a tabela que contém o parágrafo. Gera um |
parent |
Obtém a célula de tabela que contém o parágrafo. Gera um |
parent |
Obtém a célula de tabela que contém o parágrafo. Se não estiver contido numa célula de tabela, este método devolverá um objeto com a respetiva |
parent |
Obtém a tabela que contém o parágrafo. Se não estiver contido numa tabela, este método devolverá um objeto com a respetiva |
right |
Especifica o valor de avanço correto, em pontos, para o parágrafo. |
space |
Especifica o espaçamento, em pontos, após o parágrafo. |
space |
Especifica o espaçamento, em pontos, antes do parágrafo. |
style | Especifica o nome do estilo do parágrafo. Use esta propriedade de estilos personalizados e nomes de estilo localizados. Para usar os estilos internos que são portáteis entre localidades, confira a propriedade "styleBuiltIn". |
style |
Especifica o nome de estilo incorporado para o parágrafo. Use esta propriedade para estilos internos que são portáteis entre localidades. Para usar estilos personalizados ou nomes de estilo localizados, confira a propriedade "estilo". |
table |
Obtém o nível da tabela do parágrafo. Devolve 0 se o parágrafo não estiver numa tabela. |
text | Obtém o texto do parágrafo. |
unique |
Obtém uma cadeia que representa o identificador de parágrafo na sessão atual. O ID está no formato GUID padrão 8-4-4-4-12 sem chavetas e difere entre sessões e cocriadores. |
Métodos
attach |
Permite que o parágrafo ingresse em uma lista existente no nível especificado. Falhará se o parágrafo não puder ingressar na lista ou se o parágrafo já for um item da lista. |
clear() | Limpa o conteúdo do objeto Paragraph. O usuário pode executar a operação de desfazer no conteúdo limpo. |
delete() | Exclui o parágrafo e o respectivo conteúdo do documento. |
detach |
Move este parágrafo para fora de sua lista, caso o parágrafo seja um item da lista. |
get |
Obtém comentários associados ao parágrafo. |
get |
Obtém os controlos de conteúdo atualmente suportados no parágrafo. |
get |
Obtém uma representação HTML do objeto de parágrafo. Quando composta numa página Web ou visualizador de HTML, a formatação será uma correspondência próxima, mas não exata, da formatação do documento. Este método não devolve exatamente o mesmo HTML para o mesmo documento em diferentes plataformas (Windows, Mac, Word na Web, etc.). Se precisar de fidelidade exata ou consistência entre plataformas, utilize |
get |
Obtém o próximo parágrafo. Gera um |
get |
Obtém o próximo parágrafo. Se o parágrafo for o último, este método devolverá um objeto com a respetiva |
get |
Obtém a representação OOXML (Office Open XML) do objeto Paragraph. |
get |
Obtém o parágrafo anterior. Gera um |
get |
Obtém o parágrafo anterior. Se o parágrafo for o primeiro, este método devolverá um objeto com a respetiva |
get |
Obtém o parágrafo inteiro, ou então, os pontos inicial ou final do parágrafo, como um intervalo. |
get |
Obtém o texto revisto com base na seleção ChangeTrackingVersion. |
get |
Obtém o texto revisto com base na seleção ChangeTrackingVersion. |
get |
Obtém os intervalos de texto no parágrafo utilizando marcas de pontuação e/ou outras marcas finais. |
get |
Obtém a coleção dos objetos TrackedChange no parágrafo. |
insert |
Insere uma quebra no local especificado no documento principal. |
insert |
Molda o objeto Parágrafo com um controlo de conteúdo. |
insert |
Insere um documento no parágrafo na localização especificada. |
insert |
Insere HTML no local especificado dentro do parágrafo. |
insert |
Insere uma imagem no local especificado dentro do parágrafo. |
insert |
Insere OOXML no parágrafo na localização especificada. |
insert |
Insere um parágrafo no local especificado. |
insert |
Insere uma tabela com a quantidade especificada de linhas e colunas. |
insert |
Insere texto no local especificado dentro do parágrafo. |
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 |
search(search |
Efetua uma pesquisa com as SearchOptions especificadas no âmbito do objeto de parágrafo. Os resultados da pesquisa são uma coleção de objetos Range. |
select(selection |
Seleciona e navega na interface do usuário do Word até o parágrafo. |
select(selection |
Seleciona e navega na interface do usuário do Word até o parágrafo. |
set(properties, options) | Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo. |
set(properties) | Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente. |
split(delimiters, trim |
Divide o parágrafo em intervalos filho usando delimitadores. |
start |
Inicia uma nova lista com este parágrafo. Falhará se o parágrafo já for um item da lista. |
toJSON() | Substitui o método JavaScript |
track() | Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este objeto entre |
untrack() | Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta chamada é abreviada para context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Terá de chamar |
Detalhes da propriedade
alignment
Especifica o alinhamento de um parágrafo. O valor pode ser 'left', 'centered', 'right' ou 'justified'.
alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";
Valor da propriedade
Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"
Comentários
[ Conjunto de API: WordApi 1.1 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/paragraph-properties.yaml
await Word.run(async (context) => {
// Center last paragraph alignment.
context.document.body.paragraphs.getLast().alignment = "Centered";
await context.sync();
});
contentControls
Obtém a coleção de objetos de controlo de conteúdo no parágrafo.
readonly contentControls: Word.ContentControlCollection;
Valor da propriedade
Comentários
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
endnotes
Obtém a coleção de notas de fim no parágrafo.
readonly endnotes: Word.NoteItemCollection;
Valor da propriedade
Comentários
fields
Obtém a coleção de campos no parágrafo.
readonly fields: Word.FieldCollection;
Valor da propriedade
Comentários
firstLineIndent
Especifica o valor, em pontos, para uma primeira linha ou avanço pendente. Use um valor positivo para definir um recuo da primeira linha e use um valor negativo para definir um recuo deslocado.
firstLineIndent: number;
Valor da propriedade
number
Comentários
font
Obtém o formato de texto do parágrafo. Use isto para obter e definir o nome, o tamanho e a cor da fonte, além de outras propriedades.
readonly font: Word.Font;
Valor da propriedade
Comentários
footnotes
Obtém a coleção de notas de rodapé no parágrafo.
readonly footnotes: Word.NoteItemCollection;
Valor da propriedade
Comentários
inlinePictures
Obtém a coleção de objetos InlinePicture no parágrafo. A coleção não inclui imagens flutuantes.
readonly inlinePictures: Word.InlinePictureCollection;
Valor da propriedade
Comentários
isLastParagraph
Indica que o parágrafo é o último dentro do corpo do pai.
readonly isLastParagraph: boolean;
Valor da propriedade
boolean
Comentários
isListItem
Verifica se o parágrafo é um item da lista.
readonly isListItem: boolean;
Valor da propriedade
boolean
Comentários
leftIndent
Especifica o valor de avanço esquerdo, em pontos, para o parágrafo.
leftIndent: number;
Valor da propriedade
number
Comentários
[ Conjunto de API: WordApi 1.1 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/paragraph-properties.yaml
await Word.run(async (context) => {
// Indent the first paragraph.
context.document.body.paragraphs.getFirst().leftIndent = 75; //units = points
return context.sync();
});
lineSpacing
Especifica o espaçamento entre linhas, em pontos, para o parágrafo especificado. Na interface do usuário do Word, esse valor é dividido por 12.
lineSpacing: number;
Valor da propriedade
number
Comentários
[ Conjunto de API: WordApi 1.1 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/paragraph-properties.yaml
await Word.run(async (context) => {
// Adjust line spacing.
context.document.body.paragraphs.getFirst().lineSpacing = 20;
await context.sync();
});
lineUnitAfter
Especifica a quantidade de espaçamento, nas linhas de grelha, após o parágrafo.
lineUnitAfter: number;
Valor da propriedade
number
Comentários
[ Conjunto de API: WordApi 1.1 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/paragraph-properties.yaml
await Word.run(async (context) => {
// Set the space (in line units) after the first paragraph.
context.document.body.paragraphs.getFirst().lineUnitAfter = 1;
await context.sync();
});
lineUnitBefore
Especifica a quantidade de espaçamento, nas linhas de grelha, antes do parágrafo.
lineUnitBefore: number;
Valor da propriedade
number
Comentários
[ Conjunto de API: WordApi 1.1 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/paragraph-properties.yaml
await Word.run(async (context) => {
// Set the space (in line units) before the first paragraph.
context.document.body.paragraphs.getFirst().lineUnitBefore = 1;
await context.sync();
});
list
Obtém a lista à qual pertence esse parágrafo. Gera um ItemNotFound
erro se o parágrafo não estiver numa lista.
readonly list: Word.List;
Valor da propriedade
Comentários
listItem
Obtém o ListItem para o parágrafo. Gera um ItemNotFound
erro se o parágrafo não fizer parte de uma lista.
readonly listItem: Word.ListItem;
Valor da propriedade
Comentários
listItemOrNullObject
Obtém o ListItem para o parágrafo. Se o parágrafo não fizer parte de uma lista, este método devolverá um objeto com a respetiva isNullObject
propriedade definida como true
. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).
readonly listItemOrNullObject: Word.ListItem;
Valor da propriedade
Comentários
listOrNullObject
Obtém a lista à qual pertence esse parágrafo. Se o parágrafo não estiver numa lista, este método devolverá um objeto com a respetiva isNullObject
propriedade definida como true
. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).
readonly listOrNullObject: Word.List;
Valor da propriedade
Comentários
outlineLevel
Especifica o nível hierárquico do parágrafo.
outlineLevel: number;
Valor da propriedade
number
Comentários
parentBody
Obtém o corpo pai do parágrafo.
readonly parentBody: Word.Body;
Valor da propriedade
Comentários
parentContentControl
Obtém o controle de conteúdo que inclui o parágrafo. Gera um ItemNotFound
erro se não existir um controlo de conteúdo principal.
readonly parentContentControl: Word.ContentControl;
Valor da propriedade
Comentários
parentContentControlOrNullObject
Obtém o controle de conteúdo que inclui o parágrafo. Se não existir um controlo de conteúdo principal, este método devolverá um objeto com a respetiva isNullObject
propriedade definida como true
. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).
readonly parentContentControlOrNullObject: Word.ContentControl;
Valor da propriedade
Comentários
parentTable
Obtém a tabela que contém o parágrafo. Gera um ItemNotFound
erro se não estiver contido numa tabela.
readonly parentTable: Word.Table;
Valor da propriedade
Comentários
parentTableCell
Obtém a célula de tabela que contém o parágrafo. Gera um ItemNotFound
erro se não estiver contido numa célula de tabela.
readonly parentTableCell: Word.TableCell;
Valor da propriedade
Comentários
parentTableCellOrNullObject
Obtém a célula de tabela que contém o parágrafo. Se não estiver contido numa célula de tabela, este método devolverá um objeto com a respetiva isNullObject
propriedade definida como true
. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).
readonly parentTableCellOrNullObject: Word.TableCell;
Valor da propriedade
Comentários
parentTableOrNullObject
Obtém a tabela que contém o parágrafo. Se não estiver contido numa tabela, este método devolverá um objeto com a respetiva isNullObject
propriedade definida como true
. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).
readonly parentTableOrNullObject: Word.Table;
Valor da propriedade
Comentários
rightIndent
Especifica o valor de avanço correto, em pontos, para o parágrafo.
rightIndent: number;
Valor da propriedade
number
Comentários
spaceAfter
Especifica o espaçamento, em pontos, após o parágrafo.
spaceAfter: number;
Valor da propriedade
number
Comentários
[ Conjunto de API: WordApi 1.1 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/paragraph-properties.yaml
await Word.run(async (context) => {
// Set the space (in points) after the first paragraph.
context.document.body.paragraphs.getFirst().spaceAfter = 20;
await context.sync();
});
spaceBefore
Especifica o espaçamento, em pontos, antes do parágrafo.
spaceBefore: number;
Valor da propriedade
number
Comentários
style
Especifica o nome do estilo do parágrafo. Use esta propriedade de estilos personalizados e nomes de estilo localizados. Para usar os estilos internos que são portáteis entre localidades, confira a propriedade "styleBuiltIn".
style: string;
Valor da propriedade
string
Comentários
[ Conjunto de API: WordApi 1.1 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-styles.yaml
// Applies the specified style to a paragraph.
await Word.run(async (context) => {
const styleName = $("#style-name-to-use").val() as string;
if (styleName == "") {
console.warn("Enter a style name to apply.");
return;
}
const style: Word.Style = context.document.getStyles().getByNameOrNullObject(styleName);
style.load();
await context.sync();
if (style.isNullObject) {
console.warn(`There's no existing style with the name '${styleName}'.`);
} else if (style.type != Word.StyleType.paragraph) {
console.log(`The '${styleName}' style isn't a paragraph style.`);
} else {
const body: Word.Body = context.document.body;
body.clear();
body.insertParagraph(
"Do you want to create a solution that extends the functionality of Word? You can use the Office Add-ins platform to extend Word clients running on the web, on a Windows desktop, or on a Mac.",
"Start"
);
const paragraph: Word.Paragraph = body.paragraphs.getFirst();
paragraph.style = style.nameLocal;
console.log(`'${styleName}' style applied to first paragraph.`);
}
});
styleBuiltIn
Especifica o nome de estilo incorporado para o parágrafo. Use esta propriedade para estilos internos que são portáteis entre localidades. Para usar estilos personalizados ou nomes de estilo localizados, confira a propriedade "estilo".
styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6";
Valor da propriedade
Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"
Comentários
[ Conjunto de API: WordApi 1.3 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/90-scenarios/doc-assembly.yaml
await Word.run(async (context) => {
const paragraph: Word.Paragraph = context.document.body.insertParagraph("Timeline", "End");
paragraph.styleBuiltIn = "Heading2";
const paragraph2: Word.Paragraph = context.document.body.insertParagraph("The Services shall commence on July 31, 2015, and shall continue through July 29, 2015.", "End");
paragraph2.styleBuiltIn = "Normal";
const paragraph3: Word.Paragraph = context.document.body.insertParagraph("Project Costs by Phase", "End");
paragraph3.styleBuiltIn = "Heading2";
// Note a content control with the title of "ProjectCosts" is added. Content will be replaced later.
const paragraph4: Word.Paragraph = context.document.body.insertParagraph("<Add Project Costs Here>", "End");
paragraph4.styleBuiltIn = "Normal";
paragraph4.font.highlightColor = "#FFFF00";
const contentControl: Word.ContentControl = paragraph4.insertContentControl();
contentControl.title = "ProjectCosts";
const paragraph5: Word.Paragraph = context.document.body.insertParagraph("Project Team", "End");
paragraph5.styleBuiltIn = "Heading2";
paragraph5.font.highlightColor = "#FFFFFF";
const paragraph6: Word.Paragraph = context.document.body.insertParagraph("Terms of Work", "End");
paragraph6.styleBuiltIn = "Heading1";
const paragraph7: Word.Paragraph = context.document.body.insertParagraph("Contractor shall provide the Services and Deliverable(s) as follows:", "End");
paragraph7.styleBuiltIn = "Normal";
const paragraph8: Word.Paragraph = context.document.body.insertParagraph("Out-of-Pocket Expenses / Invoice Procedures", "End");
paragraph8.styleBuiltIn = "Heading2";
const paragraph9 : Word.Paragraph= context.document.body.insertParagraph("Client will be invoiced monthly for the consulting services and T&L expenses. Standard Contractor invoicing is assumed to be acceptable. Invoices are due upon receipt. client will be invoiced all costs associated with out-of-pocket expenses (including, without limitation, costs and expenses associated with meals, lodging, local transportation and any other applicable business expenses) listed on the invoice as a separate line item. Reimbursement for out-of-pocket expenses in connection with performance of this SOW, when authorized and up to the limits set forth in this SOW, shall be in accordance with Client's then-current published policies governing travel and associated business expenses, which information shall be provided by the Client Project Manager.", "End");
paragraph9.styleBuiltIn = "Normal";
// Insert a page break at the end of the document.
context.document.body.insertBreak("Page", "End");
await context.sync();
});
tableNestingLevel
Obtém o nível da tabela do parágrafo. Devolve 0 se o parágrafo não estiver numa tabela.
readonly tableNestingLevel: number;
Valor da propriedade
number
Comentários
text
Obtém o texto do parágrafo.
readonly text: string;
Valor da propriedade
string
Comentários
[ Conjunto de API: WordApi 1.1 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/get-paragraph-on-insertion-point.yaml
await Word.run(async (context) => {
// The collection of paragraphs of the current selection returns the full paragraphs contained in it.
const paragraph: Word.Paragraph = context.document.getSelection().paragraphs.getFirst();
paragraph.load("text");
await context.sync();
console.log(paragraph.text);
});
uniqueLocalId
Obtém uma cadeia que representa o identificador de parágrafo na sessão atual. O ID está no formato GUID padrão 8-4-4-4-12 sem chavetas e difere entre sessões e cocriadores.
readonly uniqueLocalId: string;
Valor da propriedade
string
Comentários
[ Conjunto de API: WordApi 1.6 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-annotations.yaml
// Registers event handlers.
await Word.run(async (context) => {
eventContexts[0] = context.document.onParagraphAdded.add(paragraphChanged);
eventContexts[1] = context.document.onParagraphChanged.add(paragraphChanged);
eventContexts[2] = context.document.onAnnotationClicked.add(onClickedHandler);
eventContexts[3] = context.document.onAnnotationHovered.add(onHoveredHandler);
eventContexts[4] = context.document.onAnnotationInserted.add(onInsertedHandler);
eventContexts[5] = context.document.onAnnotationRemoved.add(onRemovedHandler);
eventContexts[6] = context.document.onAnnotationPopupAction.add(onPopupActionHandler);
await context.sync();
console.log("Event handlers registered.");
});
...
async function paragraphChanged(args: Word.ParagraphChangedEventArgs) {
await Word.run(async (context) => {
const results = [];
for (let id of args.uniqueLocalIds) {
let para = context.document.getParagraphByUniqueLocalId(id);
para.load("uniqueLocalId");
results.push({ para: para, text: para.getText() });
}
await context.sync();
for (let result of results) {
console.log(`${args.type}: ID ${result.para.uniqueLocalId}:-`, result.text.value);
}
});
}
Detalhes do método
attachToList(listId, level)
Permite que o parágrafo ingresse em uma lista existente no nível especificado. Falhará se o parágrafo não puder ingressar na lista ou se o parágrafo já for um item da lista.
attachToList(listId: number, level: number): Word.List;
Parâmetros
- listId
-
number
Obrigatório. O ID de uma lista existente.
- level
-
number
Obrigatório. O nível na lista.
Retornos
Comentários
clear()
Limpa o conteúdo do objeto Paragraph. O usuário pode executar a operação de desfazer no conteúdo limpo.
clear(): void;
Retornos
void
Comentários
[ Conjunto de API: WordApi 1.1 ]
Exemplos
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Create a proxy object for the paragraphs collection.
const paragraphs = context.document.body.paragraphs;
// Queue a command to load the style property for all of the paragraphs.
paragraphs.load('style');
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
// Queue a command to clear the contents of the first paragraph.
paragraphs.items[0].clear();
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
console.log('Cleared the contents of the first paragraph.');
});
delete()
Exclui o parágrafo e o respectivo conteúdo do documento.
delete(): void;
Retornos
void
Comentários
[ Conjunto de API: WordApi 1.1 ]
Exemplos
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Create a proxy object for the paragraphs collection.
const paragraphs = context.document.body.paragraphs;
// Queue a command to load the text property for all of the paragraphs.
paragraphs.load('text');
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
// Queue a command to delete the first paragraph.
paragraphs.items[0].delete();
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
console.log('Deleted the first paragraph.');
});
detachFromList()
Move este parágrafo para fora de sua lista, caso o parágrafo seja um item da lista.
detachFromList(): void;
Retornos
void
Comentários
getComments()
Obtém comentários associados ao parágrafo.
getComments(): Word.CommentCollection;
Retornos
Comentários
getContentControls(options)
Obtém os controlos de conteúdo atualmente suportados no parágrafo.
getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;
Parâmetros
- options
- Word.ContentControlOptions
Opcional. Opções que definem os controlos de conteúdo que são devolvidos.
Retornos
Comentários
[ Conjunto de API: WordApi 1.5 ]
Importante: se forem fornecidos tipos específicos no parâmetro de opções, apenas são devolvidos controlos de conteúdo de tipos suportados. Tenha em atenção que será gerada uma exceção através de métodos de um Word genérico. ContentControl que não são relevantes para o tipo específico. Com o tempo, podem ser suportados tipos adicionais de controlos de conteúdo. Por conseguinte, o suplemento deve pedir e processar tipos específicos de controlos de conteúdo.
getHtml()
Obtém uma representação HTML do objeto de parágrafo. Quando composta numa página Web ou visualizador de HTML, a formatação será uma correspondência próxima, mas não exata, da formatação do documento. Este método não devolve exatamente o mesmo HTML para o mesmo documento em diferentes plataformas (Windows, Mac, Word na Web, etc.). Se precisar de fidelidade exata ou consistência entre plataformas, utilize Paragraph.getOoxml()
e converta o XML devolvido em HTML.
getHtml(): OfficeExtension.ClientResult<string>;
Retornos
OfficeExtension.ClientResult<string>
Comentários
[ Conjunto de API: WordApi 1.1 ]
Exemplos
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Create a proxy object for the paragraphs collection.
const paragraphs = context.document.body.paragraphs;
// Queue a command to load the style property for all of the paragraphs.
paragraphs.load('style');
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
// Queue a set of commands to get the HTML of the first paragraph.
const html = paragraphs.items[0].getHtml();
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
console.log('Paragraph HTML: ' + html.value);
});
getNext()
Obtém o próximo parágrafo. Gera um ItemNotFound
erro se o parágrafo for o último.
getNext(): Word.Paragraph;
Retornos
Comentários
getNextOrNullObject()
Obtém o próximo parágrafo. Se o parágrafo for o último, este método devolverá um objeto com a respetiva isNullObject
propriedade definida como true
. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).
getNextOrNullObject(): Word.Paragraph;
Retornos
Comentários
getOoxml()
Obtém a representação OOXML (Office Open XML) do objeto Paragraph.
getOoxml(): OfficeExtension.ClientResult<string>;
Retornos
OfficeExtension.ClientResult<string>
Comentários
[ Conjunto de API: WordApi 1.1 ]
Exemplos
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Create a proxy object for the paragraphs collection.
const paragraphs = context.document.body.paragraphs;
// Queue a command to load the style property for the top 2 paragraphs.
paragraphs.load({select: 'style', top: 2} );
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
// Queue a set of commands to get the OOXML of the first paragraph.
const ooxml = paragraphs.items[0].getOoxml();
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
console.log('Paragraph OOXML: ' + ooxml.value);
});
getPrevious()
Obtém o parágrafo anterior. Gera um ItemNotFound
erro se o parágrafo for o primeiro.
getPrevious(): Word.Paragraph;
Retornos
Comentários
getPreviousOrNullObject()
Obtém o parágrafo anterior. Se o parágrafo for o primeiro, este método devolverá um objeto com a respetiva isNullObject
propriedade definida como true
. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).
getPreviousOrNullObject(): Word.Paragraph;
Retornos
Comentários
[ Conjunto de API: WordApi 1.3 ]
Exemplos
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Create a proxy object for the paragraphs collection.
const paragraphs = context.document.body.paragraphs;
// Queue a command to load the text property for all of the paragraphs.
paragraphs.load('text');
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
// Queue commands to create a proxy object for the next-to-last paragraph.
const indexOfLastParagraph = paragraphs.items.length - 1;
const precedingParagraph = paragraphs.items[indexOfLastParagraph].getPreviousOrNullObject();
// Queue a command to load the text of the preceding paragraph.
precedingParagraph.load('text');
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
if (precedingParagraph.isNullObject) {
console.log('There are no paragraphs before the current one.');
} else {
console.log('The preceding paragraph is: ' + precedingParagraph.text);
}
});
getRange(rangeLocation)
Obtém o parágrafo inteiro, ou então, os pontos inicial ou final do parágrafo, como um intervalo.
getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | Word.RangeLocation.content | "Whole" | "Start" | "End" | "After" | "Content"): Word.Range;
Parâmetros
- rangeLocation
-
whole | start | end | after | content | "Whole" | "Start" | "End" | "After" | "Content"
Opcional. A localização do intervalo tem de ser "Inteiro", "Iniciar", "Terminar", "Depois" ou "Conteúdo".
Retornos
Comentários
[ Conjunto de API: WordApi 1.3 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/get-paragraph-on-insertion-point.yaml
await Word.run(async (context) => {
// Get the complete sentence (as range) associated with the insertion point.
const sentences: Word.RangeCollection = context.document
.getSelection()
.getTextRanges(["."] /* Using the "." as delimiter */, false /*means without trimming spaces*/);
sentences.load("$none");
await context.sync();
// Expand the range to the end of the paragraph to get all the complete sentences.
const sentencesToTheEndOfParagraph: Word.RangeCollection = sentences.items[0]
.getRange()
.expandTo(
context.document
.getSelection()
.paragraphs.getFirst()
.getRange(Word.RangeLocation.end)
)
.getTextRanges(["."], false /* Don't trim spaces*/);
sentencesToTheEndOfParagraph.load("text");
await context.sync();
for (let i = 0; i < sentencesToTheEndOfParagraph.items.length; i++) {
console.log(sentencesToTheEndOfParagraph.items[i].text);
}
});
getReviewedText(changeTrackingVersion)
Obtém o texto revisto com base na seleção ChangeTrackingVersion.
getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion): OfficeExtension.ClientResult<string>;
Parâmetros
- changeTrackingVersion
- Word.ChangeTrackingVersion
Opcional. O valor tem de ser "Original" ou "Atual". A predefinição é "Atual".
Retornos
OfficeExtension.ClientResult<string>
Comentários
getReviewedText(changeTrackingVersionString)
Obtém o texto revisto com base na seleção ChangeTrackingVersion.
getReviewedText(changeTrackingVersionString?: "Original" | "Current"): OfficeExtension.ClientResult<string>;
Parâmetros
- changeTrackingVersionString
-
"Original" | "Current"
Opcional. O valor tem de ser "Original" ou "Atual". A predefinição é "Atual".
Retornos
OfficeExtension.ClientResult<string>
Comentários
getTextRanges(endingMarks, trimSpacing)
Obtém os intervalos de texto no parágrafo utilizando marcas de pontuação e/ou outras marcas finais.
getTextRanges(endingMarks: string[], trimSpacing?: boolean): Word.RangeCollection;
Parâmetros
- endingMarks
-
string[]
Obrigatório. As marcas de pontuação e/ou outras marcas finais como uma matriz de cadeias.
- trimSpacing
-
boolean
Opcional. Indica se deve cortar carateres de espaçamento (espaços, separadores, quebras de coluna e marcas de fim de parágrafo) a partir do início e fim dos intervalos devolvidos na coleção de intervalos. A predefinição é false, o que indica que os carateres de espaçamento no início e no fim dos intervalos estão incluídos na coleção de intervalos.
Retornos
Comentários
getTrackedChanges()
Obtém a coleção dos objetos TrackedChange no parágrafo.
getTrackedChanges(): Word.TrackedChangeCollection;
Retornos
Comentários
insertBreak(breakType, insertLocation)
Insere uma quebra no local especificado no documento principal.
insertBreak(breakType: Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line", insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): void;
Parâmetros
- breakType
-
Word.BreakType | "Page" | "Next" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Line"
Obrigatório. O tipo de quebra a adicionar ao documento.
Obrigatório. O valor tem de ser "Antes" ou "Depois".
Retornos
void
Comentários
[ Conjunto de API: WordApi 1.1 ]
Exemplos
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Create a proxy object for the paragraphs collection.
const paragraphs = context.document.body.paragraphs;
// Queue a command to load the style property for the top 2 paragraphs.
// We never perform an empty load. We always must request a property.
paragraphs.load({select: 'style', top: 2} );
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
// Queue a command to get the first paragraph.
const paragraph = paragraphs.items[0];
// Queue a command to insert a page break after the first paragraph.
paragraph.insertBreak(Word.BreakType.page, Word.InsertLocation.after);
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
console.log('Inserted a page break after the paragraph.');
});
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/insert-line-and-page-breaks.yaml
Word.run(async (context) => {
context.document.body.paragraphs.getFirst().insertBreak(Word.BreakType.line, "After");
await context.sync();
console.log("success");
});
insertContentControl(contentControlType)
Molda o objeto Parágrafo com um controlo de conteúdo.
insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | Word.ContentControlType.comboBox | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox"): Word.ContentControl;
Parâmetros
- contentControlType
-
richText | plainText | checkBox | dropDownList | comboBox | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox"
Opcional. Tipo de controlo de conteúdo a inserir. Tem de ser "RichText", "PlainText", "CheckBox", "DropDownList" ou "ComboBox". A predefinição é "RichText".
Retornos
Comentários
[ Conjunto de API: WordApi 1.1 ]
Nota: o contentControlType
parâmetro foi introduzido no WordApi 1.5.
PlainText
o suporte foi adicionado no WordApi 1.5.
CheckBox
foi adicionado suporte no WordApi 1.7.
DropDownList
e ComboBox
o suporte foi adicionado no WordApi 1.9.
Exemplos
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Create a proxy object for the paragraphs collection.
const paragraphs = context.document.body.paragraphs;
// Queue a command to load the style property for the top 2 paragraphs.
// We never perform an empty load. We always must request a property.
paragraphs.load({select: 'style', top: 2} );
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
// Queue a command to get the first paragraph.
const paragraph = paragraphs.items[0];
// Queue a command to wrap the first paragraph in a rich text content control.
paragraph.insertContentControl();
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
console.log('Wrapped the first paragraph in a content control.');
});
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-content-controls.yaml
// Traverses each paragraph of the document and wraps a content control on each with either a even or odd tags.
await Word.run(async (context) => {
let paragraphs = context.document.body.paragraphs;
paragraphs.load("$none"); // Don't need any properties; just wrap each paragraph with a content control.
await context.sync();
for (let i = 0; i < paragraphs.items.length; i++) {
let contentControl = paragraphs.items[i].insertContentControl();
// For even, tag "even".
if (i % 2 === 0) {
contentControl.tag = "even";
} else {
contentControl.tag = "odd";
}
}
console.log("Content controls inserted: " + paragraphs.items.length);
await context.sync();
});
insertFileFromBase64(base64File, insertLocation)
Insere um documento no parágrafo na localização especificada.
insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
Parâmetros
- base64File
-
string
Obrigatório. O conteúdo codificado em Base64 de um ficheiro .docx.
Obrigatório. O valor tem de ser "Substituir", "Iniciar" ou "Terminar".
Retornos
Comentários
[ Conjunto de API: WordApi 1.1 ]
Nota: a inserção não é suportada se o documento que está a ser inserido contiver um controlo ActiveX (provavelmente num campo de formulário). Considere substituir tal campo de formulário por um controlo de conteúdo ou outra opção adequada para o seu cenário.
insertHtml(html, insertLocation)
Insere HTML no local especificado dentro do parágrafo.
insertHtml(html: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
Parâmetros
- html
-
string
Obrigatório. O HTML a inserir no parágrafo.
Obrigatório. O valor tem de ser "Substituir", "Iniciar" ou "Terminar".
Retornos
Comentários
[ Conjunto de API: WordApi 1.1 ]
Exemplos
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Create a proxy object for the paragraphs collection.
const paragraphs = context.document.body.paragraphs;
// Queue a command to load the style property for the top 2 paragraphs.
// We never perform an empty load. We always must request a property.
paragraphs.load({select: 'style', top: 2} );
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
// Queue a command to get the first paragraph.
const paragraph = paragraphs.items[0];
// Queue a command to insert HTML content at the end of the first paragraph.
paragraph.insertHtml('<strong>Inserted HTML.</strong>', Word.InsertLocation.end);
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
console.log('Inserted HTML content at the end of the first paragraph.');
});
insertInlinePictureFromBase64(base64EncodedImage, insertLocation)
Insere uma imagem no local especificado dentro do parágrafo.
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.InlinePicture;
Parâmetros
- base64EncodedImage
-
string
Obrigatório. A imagem codificada com Base64 a inserir.
Obrigatório. O valor tem de ser "Substituir", "Iniciar" ou "Terminar".
Retornos
Comentários
[ Conjunto de API: WordApi 1.1 ]
Exemplos
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Create a proxy object for the paragraphs collection.
const paragraphs = context.document.body.paragraphs;
// Queue a command to load the style property for all of the paragraphs.
paragraphs.load('style');
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
// Queue a command to get the first paragraph.
const paragraph = paragraphs.items[0];
const b64encodedImg = "iVBORw0KGgoAAAANSUhEUgAAAB4AAAANCAIAAAAxEEnAAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAACFSURBVDhPtY1BEoQwDMP6/0+XgIMTBAeYoTqso9Rkx1zG+tNj1H94jgGzeNSjteO5vtQQuG2seO0av8LzGbe3anzRoJ4ybm/VeKEerAEbAUpW4aWQCmrGFWykRzGBCnYy2ha3oAIq2MloW9yCCqhgJ6NtcQsqoIKdjLbFLaiACnYyf2fODbrjZcXfr2F4AAAAAElFTkSuQmCC";
// Queue a command to insert a base64 encoded image at the beginning of the first paragraph.
paragraph.insertInlinePictureFromBase64(b64encodedImg, Word.InsertLocation.start);
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
console.log('Added an image to the first paragraph.');
});
insertOoxml(ooxml, insertLocation)
Insere OOXML no parágrafo na localização especificada.
insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
Parâmetros
- ooxml
-
string
Obrigatório. O OOXML a inserir no parágrafo.
Obrigatório. O valor tem de ser "Substituir", "Iniciar" ou "Terminar".
Retornos
Comentários
insertParagraph(paragraphText, insertLocation)
Insere um parágrafo no local especificado.
insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph;
Parâmetros
- paragraphText
-
string
Obrigatório. O texto do parágrafo a ser inserido.
Obrigatório. O valor tem de ser "Antes" ou "Depois".
Retornos
Comentários
insertTable(rowCount, columnCount, insertLocation, values)
Insere uma tabela com a quantidade especificada de linhas e colunas.
insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table;
Parâmetros
- rowCount
-
number
Obrigatório. A quantidade de linhas na tabela.
- columnCount
-
number
Obrigatório. A quantidade de colunas na tabela.
Obrigatório. O valor tem de ser "Antes" ou "Depois".
- values
-
string[][]
Matriz 2D opcional. As células serão preenchidas se as cadeias de caracteres correspondentes estiverem especificadas na matriz.
Retornos
Comentários
insertText(text, insertLocation)
Insere texto no local especificado dentro do parágrafo.
insertText(text: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End"): Word.Range;
Parâmetros
- text
-
string
Obrigatório. Texto a inserir.
Obrigatório. O valor tem de ser "Substituir", "Iniciar" ou "Terminar".
Retornos
Comentários
[ Conjunto de API: WordApi 1.1 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/insert-in-different-locations.yaml
await Word.run(async (context) => {
// Replace the last paragraph.
const range: Word.Range = context.document.body.paragraphs.getLast().insertText("Just replaced the last paragraph!", "Replace");
range.font.highlightColor = "black";
range.font.color = "white";
await context.sync();
});
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?: Word.Interfaces.ParagraphLoadOptions): Word.Paragraph;
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[]): Word.Paragraph;
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;
}): Word.Paragraph;
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
search(searchText, searchOptions)
Efetua uma pesquisa com as SearchOptions especificadas no âmbito do objeto de parágrafo. Os resultados da pesquisa são uma coleção de objetos Range.
search(searchText: string, searchOptions?: Word.SearchOptions | {
ignorePunct?: boolean;
ignoreSpace?: boolean;
matchCase?: boolean;
matchPrefix?: boolean;
matchSuffix?: boolean;
matchWholeWord?: boolean;
matchWildcards?: boolean;
}): Word.RangeCollection;
Parâmetros
- searchText
-
string
Obrigatório. O texto da pesquisa.
- searchOptions
-
Word.SearchOptions | { ignorePunct?: boolean; ignoreSpace?: boolean; matchCase?: boolean; matchPrefix?: boolean; matchSuffix?: boolean; matchWholeWord?: boolean; matchWildcards?: boolean; }
Opcional. Opções da pesquisa.
Retornos
Comentários
select(selectionMode)
Seleciona e navega na interface do usuário do Word até o parágrafo.
select(selectionMode?: Word.SelectionMode): void;
Parâmetros
- selectionMode
- Word.SelectionMode
Opcional. O modo de seleção tem de ser "Selecionar", "Iniciar" ou "Terminar". 'Select' é o padrão.
Retornos
void
Comentários
[ Conjunto de API: WordApi 1.1 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/scroll-to-range.yaml
await Word.run(async (context) => {
// If select is called with no parameters, it selects the object.
context.document.body.paragraphs.getLast().select();
await context.sync();
});
...
await Word.run(async (context) => {
// Select can be at the start or end of a range; this by definition moves the insertion point without selecting the range.
context.document.body.paragraphs.getLast().select(Word.SelectionMode.end);
await context.sync();
});
select(selectionModeString)
Seleciona e navega na interface do usuário do Word até o parágrafo.
select(selectionModeString?: "Select" | "Start" | "End"): void;
Parâmetros
- selectionModeString
-
"Select" | "Start" | "End"
Opcional. O modo de seleção tem de ser "Selecionar", "Iniciar" ou "Terminar". 'Select' é o padrão.
Retornos
void
Comentários
set(properties, options)
Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.
set(properties: Interfaces.ParagraphUpdateData, options?: OfficeExtension.UpdateOptions): void;
Parâmetros
- properties
- Word.Interfaces.ParagraphUpdateData
Um objeto JavaScript com propriedades que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.
- options
- OfficeExtension.UpdateOptions
Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.
Retornos
void
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/90-scenarios/multiple-property-set.yaml
await Word.run(async (context) => {
const paragraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
paragraph.set({
leftIndent: 30,
font: {
bold: true,
color: "red"
}
});
await context.sync();
});
...
await Word.run(async (context) => {
const firstParagraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
const secondParagraph: Word.Paragraph = firstParagraph.getNext();
firstParagraph.load("text, font/color, font/bold, leftIndent");
await context.sync();
secondParagraph.set(firstParagraph);
await context.sync();
});
set(properties)
Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.
set(properties: Word.Paragraph): void;
Parâmetros
- properties
- Word.Paragraph
Retornos
void
split(delimiters, trimDelimiters, trimSpacing)
Divide o parágrafo em intervalos filho usando delimitadores.
split(delimiters: string[], trimDelimiters?: boolean, trimSpacing?: boolean): Word.RangeCollection;
Parâmetros
- delimiters
-
string[]
Obrigatório. Os delimitadores como uma matriz de cadeias.
- trimDelimiters
-
boolean
Opcional. Indica se pretende cortar delimitadores dos intervalos na coleção de intervalos. A predefinição é falsa, o que indica que os delimitadores estão incluídos nos intervalos devolvidos na coleção de intervalos.
- trimSpacing
-
boolean
Opcional. Indica se deve cortar carateres de espaçamento (espaços, separadores, quebras de coluna e marcas de fim de parágrafo) a partir do início e fim dos intervalos devolvidos na coleção de intervalos. A predefinição é false, o que indica que os carateres de espaçamento no início e no fim dos intervalos estão incluídos na coleção de intervalos.
Retornos
Comentários
[ Conjunto de API: WordApi 1.3 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/split-words-of-first-paragraph.yaml
await Word.run(async (context) => {
const paragraph: Word.Paragraph = context.document.body.paragraphs.getFirst();
const words = paragraph.split([" "], true /* trimDelimiters*/, true /* trimSpaces */);
words.load("text");
await context.sync();
for (let i = 0; i < words.items.length; i++) {
if (i >= 1) {
words.items[i - 1].font.highlightColor = "#FFFFFF";
}
words.items[i].font.highlightColor = "#FFFF00";
await context.sync();
await pause(200);
}
});
startNewList()
Inicia uma nova lista com este parágrafo. Falhará se o parágrafo já for um item da lista.
startNewList(): Word.List;
Retornos
Comentários
[ Conjunto de API: WordApi 1.3 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/20-lists/insert-list.yaml
// This example starts a new list with the second paragraph.
await Word.run(async (context) => {
const paragraphs: Word.ParagraphCollection = context.document.body.paragraphs;
paragraphs.load("$none");
await context.sync();
// Start new list using the second paragraph.
const list: Word.List = paragraphs.items[1].startNewList();
list.load("$none");
await context.sync();
// To add new items to the list, use Start or End on the insertLocation parameter.
list.insertParagraph("New list item at the start of the list", "Start");
const paragraph: Word.Paragraph = list.insertParagraph("New list item at the end of the list (set to list level 5)", "End");
// Set up list level for the list item.
paragraph.listItem.level = 4;
// To add paragraphs outside the list, use Before or After.
list.insertParagraph("New paragraph goes after (not part of the list)", "After");
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.stringify
por sua vez, chama o toJSON
método do objeto que lhe é transmitido.) Enquanto o objeto original Word.Paragraph
é um objeto de API, o toJSON
método devolve um objeto JavaScript simples (escrito como Word.Interfaces.ParagraphData
) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Word.Interfaces.ParagraphData;
Retornos
track()
Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este objeto entre .sync
chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, terá de adicionar o objeto à coleção de objetos controlados quando o objeto foi criado pela primeira vez. Se este objeto fizer parte de uma coleção, também deve controlar a coleção principal.
track(): Word.Paragraph;
Retornos
untrack()
Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta chamada é abreviada para context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Terá de chamar context.sync()
antes de a libertação da memória ser aplicada.
untrack(): Word.Paragraph;