Excel.Interfaces.RangeLoadOptions interface

Пакет:
excel

Диапазон представляет собой набор из одной или нескольких смежных ячеек, таких как ячейка, строка, столбец или блок ячеек. Чтобы узнать больше о том, как диапазоны используются в API, начните с Диапазонов в API JavaScript Excel.

Комментарии

Набор API: ExcelApi 1.1

Используется

Свойства

$all

Указание $all параметров загрузки загружает все скалярные свойства (такие как ), но не навигационные свойства (такие какRange.addressRange.format.fill.color ).
address

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

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

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

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

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

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

Доступ к элементу управления ячейкой, применяемому к данному диапазону. Если диапазон содержит несколько элементов управления ячейками, возвращается EmptyCellControl.
dataValidation

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

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

Определяет формулу массива диапазона. Если указанный диапазон не содержит формулу массива, это свойство возвращает null.
formulas

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

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

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

Указывает, есть ли во всех ячейках граница переноса. Возвращает true , если все ячейки имеют границу переноса или false не имеют границы переноса. Возвращает null наличие, если в диапазоне есть ячейки с границами переноса и без них.
height

Возвращает расстояние в точках для масштаба 100 % от верхнего края диапазона до нижнего края диапазона.
hidden

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

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

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

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

Возвращает расстояние в точках при масштабе 100 % от левого края листа до левого края диапазона.
linkedDataTypeState

Представляет состояние типа данных каждой ячейки.
numberFormat

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

Представляет числовой формат каждой ячейки.
numberFormatLocal

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

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

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

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

Представляет, все ли ячейки будут сохранены в формулу массива. Возвращает true результат, если все ячейки будут сохранены как формула массива или false не все ячейки будут сохранены как формула массива. Возвращает null , если некоторые ячейки будут сохранены как формула массива, а другие — нет.
style

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

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

Возвращает расстояние в точках от верхнего края листа до верхнего края диапазона при масштабе 100 %.
values

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

JSON-представление значений в ячейках в этом диапазоне. В отличие от , Range.valuesRange.valuesAsJson поддерживает все типы данных, которые могут быть в ячейке. Примеры включают форматированные числовые значения и веб-изображения в дополнение к стандартным булевым, числовым и строковым значениям. Данные, возвращаемые этим API, всегда соответствуют языковому стандарту en-US. Чтобы получить данные в языковом стандарте отображения, заданном пользователем, используйте Range.valuesAsJsonLocal.
valuesAsJsonLocal

JSON-представление значений в ячейках в этом диапазоне. В отличие от , Range.valuesRange.valuesAsJsonLocal поддерживает все типы данных, которые могут быть в ячейке. Примеры включают форматированные числовые значения и веб-изображения в дополнение к стандартным булевым, числовым и строковым значениям. Данные, возвращаемые этим API, всегда соответствуют языковому стандарту отображения, выбранному пользователем. Для получения данных, не зависящих от языкового стандарта, используйте Range.valuesAsJson.
valueTypes

Определяет тип данных в каждой ячейке.
width

Возвращает расстояние в точках для масштаба 100 % от левого края диапазона до правого края диапазона.
worksheet

Лист, содержащий текущий диапазон.

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

$all

Указание $all параметров загрузки загружает все скалярные свойства (такие как ), но не навигационные свойства (такие какRange.addressRange.format.fill.color ).

$all?: boolean;

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

boolean

address

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

address?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.1

addressLocal

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

addressLocal?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.1

cellCount

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

cellCount?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.1

columnCount

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

columnCount?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.1

columnHidden

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

columnHidden?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.2

columnIndex

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

columnIndex?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.1

control

Доступ к элементу управления ячейкой, применяемому к данному диапазону. Если диапазон содержит несколько элементов управления ячейками, возвращается EmptyCellControl.

control?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.18

dataValidation

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

dataValidation?: Excel.Interfaces.DataValidationLoadOptions;

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

Excel.Interfaces.DataValidationLoadOptions

Комментарии

Набор API: ExcelApi 1.8

format

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

format?: Excel.Interfaces.RangeFormatLoadOptions;

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

Excel.Interfaces.RangeFormatLoadOptions

Комментарии

Набор API: ExcelApi 1.1

formulaArray

Определяет формулу массива диапазона. Если указанный диапазон не содержит формулу массива, это свойство возвращает null.

formulaArray?: boolean;

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

boolean

Комментарии

Набор API: ExcelApiDesktop 1.1

formulas

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

formulas?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.1

formulasLocal

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

formulasLocal?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.1

formulasR1C1

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

formulasR1C1?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.2

hasSpill

Указывает, есть ли во всех ячейках граница переноса. Возвращает true , если все ячейки имеют границу переноса или false не имеют границы переноса. Возвращает null наличие, если в диапазоне есть ячейки с границами переноса и без них.

hasSpill?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.12

height

Возвращает расстояние в точках для масштаба 100 % от верхнего края диапазона до нижнего края диапазона.

height?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.10

hidden

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

hidden?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.2

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

hyperlink?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.7

isEntireColumn

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

isEntireColumn?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.7

isEntireRow

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

isEntireRow?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.7

left

Возвращает расстояние в точках при масштабе 100 % от левого края листа до левого края диапазона.

left?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.10

linkedDataTypeState

Представляет состояние типа данных каждой ячейки.

linkedDataTypeState?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.9

numberFormat

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

numberFormat?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.1

numberFormatCategories

Представляет числовой формат каждой ячейки.

numberFormatCategories?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.12

numberFormatLocal

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

numberFormatLocal?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.7

rowCount

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

rowCount?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.1

rowHidden

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

rowHidden?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.2

rowIndex

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

rowIndex?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.1

savedAsArray

Представляет, все ли ячейки будут сохранены в формулу массива. Возвращает true результат, если все ячейки будут сохранены как формула массива или false не все ячейки будут сохранены как формула массива. Возвращает null , если некоторые ячейки будут сохранены как формула массива, а другие — нет.

savedAsArray?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.12

style

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

style?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.7

text

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

text?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.1

top

Возвращает расстояние в точках от верхнего края листа до верхнего края диапазона при масштабе 100 %.

top?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.10

values

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

values?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.1

valuesAsJson

JSON-представление значений в ячейках в этом диапазоне. В отличие от , Range.valuesRange.valuesAsJson поддерживает все типы данных, которые могут быть в ячейке. Примеры включают форматированные числовые значения и веб-изображения в дополнение к стандартным булевым, числовым и строковым значениям. Данные, возвращаемые этим API, всегда соответствуют языковому стандарту en-US. Чтобы получить данные в языковом стандарте отображения, заданном пользователем, используйте Range.valuesAsJsonLocal.

valuesAsJson?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.16

valuesAsJsonLocal

JSON-представление значений в ячейках в этом диапазоне. В отличие от , Range.valuesRange.valuesAsJsonLocal поддерживает все типы данных, которые могут быть в ячейке. Примеры включают форматированные числовые значения и веб-изображения в дополнение к стандартным булевым, числовым и строковым значениям. Данные, возвращаемые этим API, всегда соответствуют языковому стандарту отображения, выбранному пользователем. Для получения данных, не зависящих от языкового стандарта, используйте Range.valuesAsJson.

valuesAsJsonLocal?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.16

valueTypes

Определяет тип данных в каждой ячейке.

valueTypes?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.1

width

Возвращает расстояние в точках для масштаба 100 % от левого края диапазона до правого края диапазона.

width?: boolean;

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

boolean

Комментарии

Набор API: ExcelApi 1.10

worksheet

Лист, содержащий текущий диапазон.

worksheet?: Excel.Interfaces.WorksheetLoadOptions;

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

Excel.Interfaces.WorksheetLoadOptions

Комментарии

Набор API: ExcelApi 1.1