Поделиться через

Excel.Interfaces.RangeLoadOptions interface

  • Ссылка
Пакет:
excel

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

Комментарии

[ Набор API: ExcelApi 1.1 ]

Свойства

$all

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

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

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

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

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

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

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

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

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

Возвращает объект формата, в который включены шрифт, заливка, границы, выравнивание и другие свойства диапазона.
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.valuesподдерживает Range.valuesAsJson все типы данных, которые могут находиться в ячейке. Примеры включают форматированные числовые значения и веб-изображения, а также стандартные логические, числовые и строковые значения. Данные, возвращаемые из этого API, всегда соответствуют языковому стандарту en-US. Чтобы получить данные в языковом стандарте отображения пользователя, используйте .Range.valuesAsJsonLocal
valuesAsJsonLocal

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

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

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

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

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

$all

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

$all?: boolean;

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

boolean

address

Указывает ссылку на диапазон в стиле A1. Значение address содержит ссылку на лист (например, "Лист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

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

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

control?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]

dataValidation

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

dataValidation?: Excel.Interfaces.DataValidationLoadOptions;

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

Excel.Interfaces.DataValidationLoadOptions

Комментарии

[ Набор API: ExcelApi 1.8 ]

format

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

format?: Excel.Interfaces.RangeFormatLoadOptions;

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

Excel.Interfaces.RangeFormatLoadOptions

Комментарии

[ Набор API: ExcelApi 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.valuesподдерживает Range.valuesAsJson все типы данных, которые могут находиться в ячейке. Примеры включают форматированные числовые значения и веб-изображения, а также стандартные логические, числовые и строковые значения. Данные, возвращаемые из этого API, всегда соответствуют языковому стандарту en-US. Чтобы получить данные в языковом стандарте отображения пользователя, используйте .Range.valuesAsJsonLocal

valuesAsJson?: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.16 ]

valuesAsJsonLocal

Представление значений в ячейках в этом диапазоне в формате JSON. В отличие от Range.valuesподдерживает Range.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 ]