Excel.TextRange class

Пакет:

excel

Содержит текст, присоединенный к фигуре, в дополнение к свойствам и методам для управления текстом.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.9 ]

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
font	ShapeFont Возвращает объект , представляющий атрибуты шрифта для текстового диапазона.
text	Представляет содержимое с обычным текстом в диапазоне текста.

Методы

getSubstring(start, length)	Возвращает объект TextRange для подстроки в указанном диапазоне.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
set(properties, options)	Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)	Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект Excel.TextRange является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.TextRangeData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

Сведения о свойстве

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

Значение свойства

Excel.RequestContext

font

ShapeFont Возвращает объект , представляющий атрибуты шрифта для текстового диапазона.

readonly font: Excel.ShapeFont;

Значение свойства

Excel.ShapeFont

Комментарии

[ Набор API: ExcelApi 1.9 ]

text

Представляет содержимое с обычным текстом в диапазоне текста.

text: string;

Значение свойства

string

Комментарии

[ Набор API: ExcelApi 1.9 ]

Сведения о методе

getSubstring(start, length)

Возвращает объект TextRange для подстроки в указанном диапазоне.

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

Параметры

start

number

Отсчитываемый от нуля индекс первого символа, который будет получен из текстового диапазона.

length

number

Необязательный параметр. Количество символов, возвращаемых в новом текстовом диапазоне. Если длина опущена, будут возвращены все символы от начала до конца последнего абзаца текстового диапазона.

Возвращаемое значение

Excel.TextRange

Комментарии

[ Набор API: ExcelApi 1.9 ]

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Excel.Interfaces.TextRangeLoadOptions): Excel.TextRange;

Параметры

options

Excel.Interfaces.TextRangeLoadOptions

Предоставляет параметры свойств загружаемого объекта.

Возвращаемое значение

Excel.TextRange

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNames?: string | string[]): Excel.TextRange;

Параметры

propertyNames

string | string[]

Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.

Возвращаемое значение

Excel.TextRange

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.TextRange;

Параметры

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

Возвращаемое значение

Excel.TextRange

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

set(properties: Interfaces.TextRangeUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties

Excel.Interfaces.TextRangeUpdateData

Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .

options

OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.

Возвращаемое значение

void

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

set(properties: Excel.TextRange): void;

Параметры

properties

Excel.TextRange

Возвращаемое значение

void

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный объект Excel.TextRange является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Excel.Interfaces.TextRangeData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

toJSON(): Excel.Interfaces.TextRangeData;

Возвращаемое значение

Excel.Interfaces.TextRangeData