Word.OleFormat class

Especifica o tipo de classe para o objeto, imagem ou campo OLE especificado.

classType: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

Especifica o ícone que é utilizado quando a displayAsIcon propriedade é true.

iconIndex: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica o texto apresentado abaixo do ícone do objeto OLE.

iconLabel: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica o ficheiro de programa no qual o ícone do objeto OLE é armazenado.

iconName: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém o caminho do ficheiro no qual o ícone do objeto OLE está armazenado.

readonly iconPath: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém se o objeto especificado é apresentado como um ícone.

readonly isDisplayedAsIcon: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se a formatação efetuada no Microsoft Word para o objeto OLE ligado é preservada.

isFormattingPreservedOnUpdate: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém uma cadeia que é utilizada para identificar a parte do ficheiro de origem que está a ser ligada.

readonly label: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém o identificador programático (ProgId) para o objeto OLE especificado.

readonly progId: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Ativa o OleFormat objeto.

activate(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Define o valor do registro do Windows que determina o aplicativo padrão usado para ativar o objeto OLE especificado.

activateAs(classType: string): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Pede que o objeto OLE execute um dos respetivos verbos disponíveis.

doVerb(verbIndex: Word.OleVerb): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Pede que o objeto OLE execute um dos respetivos verbos disponíveis.

doVerb(verbIndex: "Primary" | "Show" | "Open" | "Hide" | "UiActivate" | "InPlaceActivate" | "DiscardUndoState"): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Abre o objeto OLE para edição na aplicação em que foi criado.

edit(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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.OleFormatLoadOptions): Word.OleFormat;

Parâmetros

Retornos

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.OleFormat;

Parâmetros

Retornos

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.OleFormat;

Parâmetros

Retornos

Abre o OleFormat objeto.

open(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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.OleFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

Retornos

Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.

set(properties: Word.OleFormat): void;

Parâmetros

Retornos

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.OleFormat é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.OleFormatData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Word.Interfaces.OleFormatData;

Retornos

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.OleFormat;

Retornos

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.OleFormat;

Retornos