Excel.TextRange class

  • Referência
Pacote:
excel

Contém o texto que é anexado a uma forma, bem como propriedades e métodos para manipular o texto.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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.
font

Devolve um ShapeFont objeto que representa os atributos do tipo de letra para o intervalo de texto.
text

Representa o conteúdo de texto sem formatação do intervalo de texto.

Métodos

getSubstring(start, length)

Retorna um objeto TextRange para a subcadeia de caracteres no intervalo especificado.
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.
set(properties, options)

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)

Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.
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 Excel.TextRange original é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.TextRangeData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

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

Excel.RequestContext

font

Devolve um ShapeFont objeto que representa os atributos do tipo de letra para o intervalo de texto.

readonly font: Excel.ShapeFont;

Valor da propriedade

Excel.ShapeFont

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

text

Representa o conteúdo de texto sem formatação do intervalo de texto.

text: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

Detalhes do método

getSubstring(start, length)

Retorna um objeto TextRange para a subcadeia de caracteres no intervalo especificado.

getSubstring(start: number, length?: number): Excel.TextRange;

Parâmetros

start

number

O índice baseado em zero do primeiro caráter a obter a partir do intervalo de texto.

length

number

Opcional. O número de carateres a devolver no novo intervalo de texto. Se o comprimento for omitido, todos os carateres do início ao fim do último parágrafo do intervalo de texto serão devolvidos.

Retornos

Excel.TextRange

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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?: Excel.Interfaces.TextRangeLoadOptions): Excel.TextRange;

Parâmetros

options
Excel.Interfaces.TextRangeLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

Excel.TextRange

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[]): Excel.TextRange;

Parâmetros

propertyNames

string | string[]

Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

Retornos

Excel.TextRange

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;
        }): Excel.TextRange;

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

Excel.TextRange

set(properties, options)

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.TextRangeUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties
Excel.Interfaces.TextRangeUpdateData

Um objeto JavaScript com propriedades que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.

options
OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.

Retornos

void

set(properties)

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

set(properties: Excel.TextRange): void;

Parâmetros

properties
Excel.TextRange

Retornos

void

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

toJSON(): Excel.Interfaces.TextRangeData;

Retornos

Excel.Interfaces.TextRangeData