Compartilhar via


Word.HtmlDivision class

Extends

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Propriedades

context

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

htmlDivisions
leftIndent

Especifica o valor de avanço esquerdo (em pontos) para esta divisão HTML.

range

Obtém um Range objeto que representa a parte de um documento que está contida nesta divisão HTML.

rightIndent

Especifica o avanço direito (em pontos) para esta divisão HTML.

spaceAfter

Especifica a quantidade de espaçamento (em pontos) após esta divisão HTML.

spaceBefore

Especifica o espaçamento (em pontos) antes desta divisão HTML.

Métodos

delete()

Elimina esta divisão HTML.

htmlDivisionParent(levelsUp)

Devolve um HtmlDivision objeto que representa uma divisão principal da divisão HTML atual.

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.HtmlDivision é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.HtmlDivisionData) 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

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

htmlDivisions

readonly htmlDivisions: Word.HtmlDivisionCollection;

Valor da propriedade

leftIndent

Especifica o valor de avanço esquerdo (em pontos) para esta divisão HTML.

leftIndent: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

range

Obtém um Range objeto que representa a parte de um documento que está contida nesta divisão HTML.

readonly range: Word.Range;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

rightIndent

Especifica o avanço direito (em pontos) para esta divisão HTML.

rightIndent: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

spaceAfter

Especifica a quantidade de espaçamento (em pontos) após esta divisão HTML.

spaceAfter: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

spaceBefore

Especifica o espaçamento (em pontos) antes desta divisão HTML.

spaceBefore: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Detalhes do método

delete()

Elimina esta divisão HTML.

delete(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

htmlDivisionParent(levelsUp)

Devolve um HtmlDivision objeto que representa uma divisão principal da divisão HTML atual.

htmlDivisionParent(levelsUp?: number): Word.HtmlDivision;

Parâmetros

levelsUp

number

Opcional. O número de níveis a subir para obter a divisão principal.

Retornos

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.HtmlDivisionLoadOptions): Word.HtmlDivision;

Parâmetros

options
Word.Interfaces.HtmlDivisionLoadOptions

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

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

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

toJSON(): Word.Interfaces.HtmlDivisionData;

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

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

Retornos