Excel.Interfaces.RangeData interface

Интерфейс, описывающий данные, возвращаемые путем вызова range.toJSON().

Свойства

address

Указывает ссылку на диапазон в стиле A1. Значение address содержит ссылку на лист (например, "Лист1! A1:B4").

addressLocal

Представляет ссылку на диапазон для указанного диапазона на языке пользователя.

cellCount

Указывает количество ячеек в диапазоне. Этот API возвращает значение -1, если количество ячеек превышает 2^31-1 (2,147,483,647).

columnCount

Задает общее количество столбцов в диапазоне.

columnHidden

Представляет, если все столбцы в текущем диапазоне скрыты. Значение — это true , когда все столбцы в диапазоне скрыты. Значение имеет значение, false если столбцы в диапазоне не скрыты. Значением считается, null когда некоторые столбцы в диапазоне скрыты, а другие столбцы в том же диапазоне не скрыты.

columnIndex

Задает номер столбца первой ячейки в диапазоне. Используется нулевой индекс.

conditionalFormats

Коллекция, ConditionalFormats пересекающая диапазон.

dataValidation

Возвращает объект проверки данных.

format

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

formulas

Представляет формулу в формате A1. Если в ячейке нет формулы, возвращается ее значение.

formulasLocal

Представляет формулу в нотации стиля A1 на языке пользователя и в соответствии с его языковым стандартом. Например, английская формула =SUM(A1, 1.5) превратится в "=СУММ(A1; 1,5)" на русском языке. Если в ячейке нет формулы, возвращается ее значение.

formulasR1C1

Представляет формулу в формате R1C1. Если в ячейке нет формулы, возвращается ее значение.

hidden

Представляет, скрыты ли все ячейки в текущем диапазоне. Значение — это true , когда все ячейки в диапазоне скрыты. Значение — это значение false , когда ячейки в диапазоне не скрыты. Значение — это null , когда некоторые ячейки в диапазоне скрыты, а другие ячейки в том же диапазоне не скрыты.

hyperlink

Представляет гиперссылку для текущего диапазона.

isEntireColumn

Указывает, является ли текущий диапазон целым столбцом.

isEntireRow

Указывает, является ли текущий диапазон целой строкой.

numberFormat

Представляет код числового формата Excel для заданного диапазона. Дополнительные сведения о форматировании чисел в Excel см. в разделе Коды числового формата.

numberFormatLocal

Представляет код числового формата Excel для заданного диапазона на основе языковых параметров пользователя. Excel не выполняет приведение языка или формата при получении или задании numberFormatLocal свойства. Любой возвращаемый текст использует строки в локальном формате на основе языка, указанного в параметрах системы.

rowCount

Возвращает общее количество строк в диапазоне.

rowHidden

Представляет, скрыты ли все строки в текущем диапазоне. Значение — это true , когда все строки в диапазоне скрыты. Значение — это значение false , когда строки в диапазоне не скрыты. Значением является, null когда некоторые строки в диапазоне скрыты, а другие строки в том же диапазоне не скрыты.

rowIndex

Возвращает номер строки первой ячейки диапазона. Используется нулевой индекс.

style

Представляет стиль текущего диапазона. Если стили ячеек несогласованны, null возвращается. Для пользовательских стилей будет возвращено имя стиля. Для встроенных стилей возвращается строка, представляющая значение в перечислении BuiltInStyle .

text

Текстовые значения указанного диапазона. Текстовое значение не зависит от ширины ячейки. Подстановка числового знака (#), выполняемая в пользовательском интерфейсе Excel, не повлияет на текстовое значение, возвращаемое API.

values

Представляет необработанные значения указанного диапазона. Возвращаемые данные могут быть строковыми, числовыми или логическими. Ячейки, содержащие ошибку, вернут строку ошибки. Если возвращаемое значение начинается с плюса ("+"), минуса ("-") или знака равенства ("="), Excel интерпретирует это значение как формулу.

valueTypes

Указывает тип данных в каждой ячейке.

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

address

Указывает ссылку на диапазон в стиле A1. Значение address содержит ссылку на лист (например, "Лист1! A1:B4").

address?: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.1 ]

addressLocal

Представляет ссылку на диапазон для указанного диапазона на языке пользователя.

addressLocal?: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.1 ]

cellCount

Указывает количество ячеек в диапазоне. Этот API возвращает значение -1, если количество ячеек превышает 2^31-1 (2,147,483,647).

cellCount?: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.1 ]

columnCount

Задает общее количество столбцов в диапазоне.

columnCount?: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.1 ]

columnHidden

Представляет, если все столбцы в текущем диапазоне скрыты. Значение — это true , когда все столбцы в диапазоне скрыты. Значение имеет значение, false если столбцы в диапазоне не скрыты. Значением считается, null когда некоторые столбцы в диапазоне скрыты, а другие столбцы в том же диапазоне не скрыты.

columnHidden?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.2 ]

columnIndex

Задает номер столбца первой ячейки в диапазоне. Используется нулевой индекс.

columnIndex?: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.1 ]

conditionalFormats

Коллекция, ConditionalFormats пересекающая диапазон.

conditionalFormats?: Excel.Interfaces.ConditionalFormatData[];

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

Комментарии

[ Набор API: ExcelApi 1.6 ]

dataValidation

Возвращает объект проверки данных.

dataValidation?: Excel.Interfaces.DataValidationData;

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

Комментарии

[ Набор API: ExcelApi 1.8 ]

format

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

format?: Excel.Interfaces.RangeFormatData;

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

Комментарии

[ Набор API: ExcelApi 1.1 ]

formulas

Представляет формулу в формате A1. Если в ячейке нет формулы, возвращается ее значение.

formulas?: any[][];

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

any[][]

Комментарии

[ Набор API: ExcelApi 1.1 ]

formulasLocal

Представляет формулу в нотации стиля A1 на языке пользователя и в соответствии с его языковым стандартом. Например, английская формула =SUM(A1, 1.5) превратится в "=СУММ(A1; 1,5)" на русском языке. Если в ячейке нет формулы, возвращается ее значение.

formulasLocal?: any[][];

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

any[][]

Комментарии

[ Набор API: ExcelApi 1.1 ]

formulasR1C1

Представляет формулу в формате R1C1. Если в ячейке нет формулы, возвращается ее значение.

formulasR1C1?: any[][];

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

any[][]

Комментарии

[ Набор API: ExcelApi 1.2 ]

hidden

Представляет, скрыты ли все ячейки в текущем диапазоне. Значение — это true , когда все ячейки в диапазоне скрыты. Значение — это значение false , когда ячейки в диапазоне не скрыты. Значение — это null , когда некоторые ячейки в диапазоне скрыты, а другие ячейки в том же диапазоне не скрыты.

hidden?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.2 ]

Представляет гиперссылку для текущего диапазона.

hyperlink?: Excel.RangeHyperlink;

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

Комментарии

[ Набор API: ExcelApi 1.7 ]

isEntireColumn

Указывает, является ли текущий диапазон целым столбцом.

isEntireColumn?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.7 ]

isEntireRow

Указывает, является ли текущий диапазон целой строкой.

isEntireRow?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.7 ]

numberFormat

Представляет код числового формата Excel для заданного диапазона. Дополнительные сведения о форматировании чисел в Excel см. в разделе Коды числового формата.

numberFormat?: any[][];

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

any[][]

Комментарии

[ Набор API: ExcelApi 1.1 ]

numberFormatLocal

Представляет код числового формата Excel для заданного диапазона на основе языковых параметров пользователя. Excel не выполняет приведение языка или формата при получении или задании numberFormatLocal свойства. Любой возвращаемый текст использует строки в локальном формате на основе языка, указанного в параметрах системы.

numberFormatLocal?: any[][];

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

any[][]

Комментарии

[ Набор API: ExcelApi 1.7 ]

rowCount

Возвращает общее количество строк в диапазоне.

rowCount?: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.1 ]

rowHidden

Представляет, скрыты ли все строки в текущем диапазоне. Значение — это true , когда все строки в диапазоне скрыты. Значение — это значение false , когда строки в диапазоне не скрыты. Значением является, null когда некоторые строки в диапазоне скрыты, а другие строки в том же диапазоне не скрыты.

rowHidden?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.2 ]

rowIndex

Возвращает номер строки первой ячейки диапазона. Используется нулевой индекс.

rowIndex?: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.1 ]

style

Представляет стиль текущего диапазона. Если стили ячеек несогласованны, null возвращается. Для пользовательских стилей будет возвращено имя стиля. Для встроенных стилей возвращается строка, представляющая значение в перечислении BuiltInStyle .

style?: string;

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

string

Комментарии

[ Набор API: ExcelApi 1.7 ]

text

Текстовые значения указанного диапазона. Текстовое значение не зависит от ширины ячейки. Подстановка числового знака (#), выполняемая в пользовательском интерфейсе Excel, не повлияет на текстовое значение, возвращаемое API.

text?: string[][];

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

string[][]

Комментарии

[ Набор API: ExcelApi 1.1 ]

values

Представляет необработанные значения указанного диапазона. Возвращаемые данные могут быть строковыми, числовыми или логическими. Ячейки, содержащие ошибку, вернут строку ошибки. Если возвращаемое значение начинается с плюса ("+"), минуса ("-") или знака равенства ("="), Excel интерпретирует это значение как формулу.

values?: any[][];

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

any[][]

Комментарии

[ Набор API: ExcelApi 1.1 ]

valueTypes

Указывает тип данных в каждой ячейке.

valueTypes?: Excel.RangeValueType[][];

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

Комментарии

[ Набор API: ExcelApi 1.1 ]