Word.Frame class

Retorna um BorderUniversalCollection objeto que representa todas as bordas do quadro.

readonly borders: Word.BorderUniversalCollection;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

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

Especifica a altura (em pontos) do quadro.

height: number;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica um FrameSizeRule valor que representa a regra para determinar a altura do quadro.

heightRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact";

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica a distância horizontal entre o quadro e o texto ao redor, em pontos.

horizontalDistanceFromText: number;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica a distância horizontal entre a borda do quadro e o item especificado pela relativeHorizontalPosition propriedade.

horizontalPosition: number;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica se o quadro está bloqueado.

lockAnchor: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Retorna um Range objeto que representa a parte do documento contida no quadro.

readonly range: Word.Range;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica a posição horizontal relativa do quadro.

relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin";

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica a posição vertical relativa do quadro.

relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin";

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Retorna um ShadingUniversal objeto que faz referência à formatação de sombreamento do quadro.

readonly shading: Word.ShadingUniversal;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica se o texto do documento é quebrado ao redor do quadro.

textWrap: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica a distância vertical (em pontos) entre o quadro e o texto ao redor.

verticalDistanceFromText: number;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica a distância vertical entre a borda do quadro e o item especificado pela relativeVerticalPosition propriedade.

verticalPosition: number;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica a largura (em pontos) do quadro.

width: number;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica a regra usada para determinar a largura do quadro.

widthRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact";

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Copia o quadro para a área de transferência.

copy(): void;

Retornos

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Remove o quadro do documento e o coloca na área de transferência.

cut(): void;

Retornos

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Exclui o quadro.

delete(): void;

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.FrameLoadOptions): Word.Frame;

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

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

Parâmetros

Retornos

Seleciona o quadro.

select(): void;

Retornos

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.

set(properties: Interfaces.FrameUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

Retornos

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

set(properties: Word.Frame): void;

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.Frame é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Word.Interfaces.FrameData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

toJSON(): Word.Interfaces.FrameData;

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

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

Retornos