Word.Frame class

Devolve um BorderUniversalCollection objeto que representa todos os limites da moldura.

readonly borders: Word.BorderUniversalCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

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 a altura (em pontos) da moldura.

height: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica um FrameSizeRule valor que representa a regra para determinar a altura da moldura.

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

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica a distância horizontal entre a moldura e o texto adjacente, em pontos.

horizontalDistanceFromText: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica a distância horizontal entre o limite da moldura e o item especificado pela relativeHorizontalPosition propriedade .

horizontalPosition: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica se a moldura está bloqueada.

lockAnchor: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Devolve um Range objeto que representa a parte do documento que está contida na moldura.

readonly range: Word.Range;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica a posição horizontal relativa da moldura.

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

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica a posição vertical relativa da moldura.

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

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Devolve um ShadingUniversal objeto que se refere à formatação de sombreado da moldura.

readonly shading: Word.ShadingUniversal;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica se o texto do documento molda à volta da moldura.

textWrap: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica a distância vertical (em pontos) entre a moldura e o texto adjacente.

verticalDistanceFromText: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica a distância vertical entre o limite da moldura e o item especificado pela relativeVerticalPosition propriedade .

verticalPosition: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica a largura (em pontos) da moldura.

width: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica a regra utilizada para determinar a largura da moldura.

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

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Copia a moldura para a Área de Transferência.

copy(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Remove a moldura do documento e coloca-a na Área de Transferência.

cut(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Elimina a moldura.

delete(): void;

Retornos

Comentários

[ Conjunto de API: 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 a moldura.

select(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

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

toJSON(): Word.Interfaces.FrameData;

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

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

Retornos