Compartilhar via


Word.TabStop class

Representa uma tabulação num documento Word.

Extends

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Propriedades

alignment

Obtém um TabAlignment valor que representa o alinhamento da tabulação.

context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

customTab

Obtém se esta tabulação é uma tabulação personalizada.

leader

Obtém um TabLeader valor que representa o caráter de preenchimento para este TabStop objeto.

next

Obtém a próxima tabulação na coleção.

position

Obtém a posição da tabulação relativa à margem esquerda.

previous

Obtém a tabulação anterior na coleção.

Métodos

clear()

Remove esta tabulação personalizada.

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(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

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.

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.

Detalhes da propriedade

alignment

Obtém um TabAlignment valor que representa o alinhamento da tabulação.

readonly alignment: Word.TabAlignment | "Left" | "Center" | "Right" | "Decimal" | "Bar" | "List";

Valor da propriedade

Word.TabAlignment | "Left" | "Center" | "Right" | "Decimal" | "Bar" | "List"

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

customTab

Obtém se esta tabulação é uma tabulação personalizada.

readonly customTab: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

leader

Obtém um TabLeader valor que representa o caráter de preenchimento para este TabStop objeto.

readonly leader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot";

Valor da propriedade

Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

next

Obtém a próxima tabulação na coleção.

readonly next: Word.TabStop;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

position

Obtém a posição da tabulação relativa à margem esquerda.

readonly position: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

previous

Obtém a tabulação anterior na coleção.

readonly previous: Word.TabStop;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Detalhes do método

clear()

Remove esta tabulação personalizada.

clear(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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.TabStopLoadOptions): Word.TabStop;

Parâmetros

options
Word.Interfaces.TabStopLoadOptions

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

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

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

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

toJSON(): Word.Interfaces.TabStopData;

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

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

Retornos