Word.TabStop class

Representa uma parada de tabulação em um documento do Word.

Extends

Propriedades

alignment

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

context

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

customTab

Determina se essa parada de tabulação é uma parada de tabulação personalizada.

leader

Obtém um TabLeader valor que representa o líder para este TabStop objeto.

next

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

position

Obtém a posição da parada de tabulação em relação à margem esquerda.

previous

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

Métodos

clear()

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

track()

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.

untrack()

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.

Detalhes da propriedade

alignment

Obtém um TabAlignment valor que representa o alinhamento da parada de 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 APIs: WordApiDesktop 1.4

context

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

customTab

Determina se essa parada de tabulação é uma parada de tabulação personalizada.

readonly customTab: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

leader

Obtém um TabLeader valor que representa o líder 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 APIs: WordApiDesktop 1.4

next

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

readonly next: Word.TabStop;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.4

position

Obtém a posição da parada de tabulação em relação à margem esquerda.

readonly position: number;

Valor da propriedade

number

Comentários

Conjunto de APIs: WordApiDesktop 1.4

previous

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

readonly previous: Word.TabStop;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.4

Detalhes do método

clear()

Remove essa parada de tabulação personalizada.

clear(): void;

Retornos

void

Comentários

Conjunto de APIs: 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 quais propriedades do objeto devem ser carregadas.

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 de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especifica as propriedades a serem carregadas.

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 de caracteres delimitada por vírgula que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades de navegação a serem carregadas.

Retornos

toJSON()

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

Retornos

untrack()

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

Retornos