Excel.TextRange class

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 de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
font	Retorna um ShapeFont objeto que representa os atributos de fonte 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. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.
set(properties)	Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.
toJSON()	Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.TextRange original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.TextRangeData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

Detalhes da propriedade

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

Excel.RequestContext

font

Retorna um ShapeFont objeto que representa os atributos de fonte 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 caractere a ser obtido do intervalo de texto.

length

number

Opcional. O número de caracteres a serem retornados no novo intervalo de texto. Se o comprimento for omitido, todos os caracteres do início ao final do último parágrafo do intervalo de texto serão retornados.

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 quais propriedades do objeto 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 de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

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

Retornos

Excel.TextRange

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas 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 estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.

options

OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto properties tentar definir quaisquer propriedades somente leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base em um 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 é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.TextRange original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.TextRangeData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.TextRangeData;

Retornos

Excel.Interfaces.TextRangeData