Word.Source class

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Obtém se o Source objeto foi citado no documento.

readonly isCited: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Obtém a marca da fonte.

readonly tag: string;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Obtém a representação XML da origem.

readonly xml: string;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Exclui o Source objeto.

delete(): void;

Retornos

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Retorna o valor de um campo no objeto bibliografia Source .

getFieldByName(name: string): OfficeExtension.ClientResult<string>;

Parâmetros

Retornos

Comentários

Conjunto de APIs: WordApiDesktop 1.3

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.SourceLoadOptions): Word.Source;

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

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

Parâmetros

Retornos

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Word.Source é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Word.Interfaces.SourceData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

toJSON(): Word.Interfaces.SourceData;

Retornos

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação de context.trackedObjects.add(thisObject). Se você estiver usando esse 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, precisará adicionar o objeto à coleção de objetos rastreados quando o objeto foi criado pela primeira vez. Se esse objeto fizer parte de uma coleção, você também deverá acompanhar a coleção pai.

track(): Word.Source;

Retornos

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa chamada é a forma abreviada de 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. Você precisará ligar context.sync() antes que a liberação de memória entre em vigor.

untrack(): Word.Source;

Retornos