Word.InlinePicture class
Representa uma imagem embutida.
- 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/15-images/insert-and-get-pictures.yaml
// Inserts an image anchored to the last paragraph.
await Word.run(async (context) => {
context.document.body.paragraphs
.getLast()
.insertParagraph("", "After")
.insertInlinePictureFromBase64(base64Image, "End");
await context.sync();
});
Propriedades
| alt |
Especifica uma cadeia que representa o texto alternativo associado à imagem inline. |
| alt |
Especifica uma cadeia que contém o título da imagem inline. |
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| height | Especifica um número que descreve a altura da imagem inline. |
| hyperlink | Especifica uma hiperligação na imagem. Utilize um "#" para separar a parte do endereço da parte de localização opcional. |
| lock |
Especifica um valor que indica se a imagem inline mantém as proporções originais quando a redimensiona. |
| paragraph | Obtém o parágrafo pai que inclui a imagem embutida. |
| parent |
Obtém o controle de conteúdo que inclui a imagem embutida. Gera um |
| parent |
Obtém o controle de conteúdo que inclui a imagem embutida. 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 a imagem embutida. Gera um |
| parent |
Obtém a célula de tabela que contém a imagem embutida. Gera um |
| parent |
Obtém a célula de tabela que contém a imagem embutida. 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 a imagem embutida. Se não estiver contido numa tabela, este método devolverá um objeto com a respetiva |
| width | Especifica um número que descreve a largura da imagem inline. |
Métodos
| delete() | Exclui a imagem embutida do documento. |
| get |
Obtém a representação de cadeia codificada com Base64 da imagem inline. |
| get |
Obtém a próxima imagem embutida. Gera um |
| get |
Obtém a próxima imagem embutida. Se esta imagem inline for a última, este método devolverá um objeto com a respetiva |
| get |
Obtém a imagem, ou então, os pontos inicial ou final da imagem, como um intervalo. |
| insert |
Insere uma quebra no local especificado no documento principal. |
| insert |
Quebra a imagem embutida com um controle de conteúdo de rich text. |
| insert |
Insere um documento no local especificado. |
| insert |
Insere HTML no local especificado. |
| insert |
Insere uma imagem embutida no local especificado. |
| insert |
Insere um formato OOXML no local especificado. |
| insert |
Insere um parágrafo no local especificado. |
| insert |
Insere um texto no local especificado. |
| 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 |
| select(selection |
Seleciona a imagem embutida. Isso faz com que o Word role até a seleção. |
| select(selection |
Seleciona a imagem embutida. Isso faz com que o Word role até a seleção. |
| 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. |
| 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
altTextDescription
Especifica uma cadeia que representa o texto alternativo associado à imagem inline.
altTextDescription: string;Valor da propriedade
string
Comentários
altTextTitle
Especifica uma cadeia que contém o título da imagem inline.
altTextTitle: string;Valor da propriedade
string
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
height
Especifica um número que descreve a altura da imagem inline.
height: number;Valor da propriedade
number
Comentários
hyperlink
Especifica uma hiperligação na imagem. Utilize um "#" para separar a parte do endereço da parte de localização opcional.
hyperlink: string;Valor da propriedade
string
Comentários
lockAspectRatio
Especifica um valor que indica se a imagem inline mantém as proporções originais quando a redimensiona.
lockAspectRatio: boolean;Valor da propriedade
boolean
Comentários
paragraph
Obtém o parágrafo pai que inclui a imagem embutida.
readonly paragraph: Word.Paragraph;Valor da propriedade
Comentários
parentContentControl
Obtém o controle de conteúdo que inclui a imagem embutida. 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 a imagem embutida. 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 a imagem embutida. 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 a imagem embutida. 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 a imagem embutida. 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 a imagem embutida. 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
width
Especifica um número que descreve a largura da imagem inline.
width: number;Valor da propriedade
number
Comentários
Detalhes do método
delete()
Exclui a imagem embutida do documento.
delete(): void;Retornos
void
Comentários
getBase64ImageSrc()
Obtém a representação de cadeia codificada com Base64 da imagem inline.
getBase64ImageSrc(): OfficeExtension.ClientResult<string>;Retornos
OfficeExtension.ClientResult<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/15-images/insert-and-get-pictures.yaml
// Gets the first image in the document.
await Word.run(async (context) => {
const firstPicture: Word.InlinePicture = context.document.body.inlinePictures.getFirst();
firstPicture.load("width, height, imageFormat");
await context.sync();
console.log(`Image dimensions: ${firstPicture.width} x ${firstPicture.height}`, `Image format: ${firstPicture.imageFormat}`);
// Get the image encoded as Base64.
const base64 = firstPicture.getBase64ImageSrc();
await context.sync();
console.log(base64.value);
});
getNext()
Obtém a próxima imagem embutida. Gera um ItemNotFound erro se esta imagem inline for a última.
getNext(): Word.InlinePicture;Retornos
Comentários
[ Conjunto de API: WordApi 1.3 ]
Exemplos
// To use this snippet, add an inline picture to the document and assign it an alt text title.
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Create a proxy object for the first inline picture.
const firstPicture = context.document.body.inlinePictures.getFirstOrNullObject();
// Queue a command to load the alternative text title of the picture.
firstPicture.load('altTextTitle');
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
if (firstPicture.isNullObject) {
console.log('There are no inline pictures in this document.')
} else {
console.log(firstPicture.altTextTitle);
}
});
getNextOrNullObject()
Obtém a próxima imagem embutida. Se esta imagem inline for a última, 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.InlinePicture;Retornos
Comentários
[ Conjunto de API: WordApi 1.3 ]
Exemplos
// To use this snippet, add an inline picture to the document and assign it an alt text title.
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Create a proxy object for the first inline picture.
const firstPicture = context.document.body.inlinePictures.getFirstOrNullObject();
// Queue a command to load the alternative text title of the picture.
firstPicture.load('altTextTitle');
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
if (firstPicture.isNullObject) {
console.log('There are no inline pictures in this document.')
} else {
console.log(firstPicture.altTextTitle);
}
});
getRange(rangeLocation)
Obtém a imagem, ou então, os pontos inicial ou final da imagem, como um intervalo.
getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range;Parâmetros
Opcional. A localização do intervalo tem de ser "Inteiro", "Iniciar" ou "Terminar".
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.
Obrigatório. O valor tem de ser "Antes" ou "Depois".
Retornos
void
Comentários
insertContentControl()
Quebra a imagem embutida com um controle de conteúdo de rich text.
insertContentControl(): Word.ContentControl;Retornos
Comentários
insertFileFromBase64(base64File, insertLocation)
Insere um documento no local especificado.
insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): 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 "Antes" ou "Depois".
Retornos
Comentários
[ Conjunto de API: WordApi 1.2 ]
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.
insertHtml(html: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;Parâmetros
- html
-
string
Obrigatório. O HTML a inserir.
Obrigatório. O valor tem de ser "Antes" ou "Depois".
Retornos
Comentários
insertInlinePictureFromBase64(base64EncodedImage, insertLocation)
Insere uma imagem embutida no local especificado.
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.before | Word.InsertLocation.after | "Replace" | "Before" | "After"): Word.InlinePicture;Parâmetros
- base64EncodedImage
-
string
Obrigatório. A imagem codificada com Base64 a inserir.
Obrigatório. O valor tem de ser "Substituir", "Antes" ou "Depois".
Retornos
Comentários
insertOoxml(ooxml, insertLocation)
Insere um formato OOXML no local especificado.
insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;Parâmetros
- ooxml
-
string
Obrigatório. O formato OOXML a inserir.
Obrigatório. O valor tem de ser "Antes" ou "Depois".
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
insertText(text, insertLocation)
Insere um texto no local especificado.
insertText(text: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Range;Parâmetros
- text
-
string
Obrigatório. Texto a inserir.
Obrigatório. O valor tem de ser "Antes" ou "Depois".
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?: Word.Interfaces.InlinePictureLoadOptions): Word.InlinePicture;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.InlinePicture;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.InlinePicture;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
select(selectionMode)
Seleciona a imagem embutida. Isso faz com que o Word role até a seleção.
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
select(selectionModeString)
Seleciona a imagem embutida. Isso faz com que o Word role até a seleção.
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.InlinePictureUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
- properties
- Word.Interfaces.InlinePictureUpdateData
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
set(properties)
Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.
set(properties: Word.InlinePicture): void;Parâmetros
- properties
- Word.InlinePicture
Retornos
void
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 Word.InlinePicture é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.InlinePictureData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Word.Interfaces.InlinePictureData;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.InlinePicture;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.InlinePicture;